Pobierz wiadomości z podanej rozmowy
Mniej niż 1 minuta
Pobierz wiadomości z podanej rozmowy
Definicja Funkcji
Array getConversation(Array $params)
Definicja parametrów
Metoda przyjmuje 1 argument, jako tablica lub string JSON. Dostępne klucze:
Nazwa parametru | Typ parametru | Opis |
---|---|---|
from | string (Wymagane) | Format: Nazwa_użytkownika@nazwa_serwera od którego będą pobierane wiadomości z kanału. Nazwa_użytkownika (jabber_users.jab_lo), nazwa_serwera (jabber_users.jab_se) |
from_msg_id | Int | Identyfikator wiadomości od której mają być zwracane wiadomości |
to_msg_to | Int | Identyfikator wiadomości do której mają być zwracane wiadomości |
offset | Int | określa ile początkowych wiadmości ma zostać pominiętych |
limit | Int | określa ile wiadmości ma zostać zwróconych (najpierw działa offset potem limit) |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
$data = [
'from' => 'bcacko@serwer',
'limit' => 10
];
$messages = $api->getConversation($data);
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca tablice asocjacyjną z danymi wiadmośći z rozmowy w przypadku sukcesu. Jeśli wystąpi błąd wtedy, zostanie zwrócony wyjątek.
Zwracane wyjątki w zależności od wywołania
- SOAP - SoapFault
- Lokalnie - Exception