Ustaw status na komunikatorze

Definicja Funkcji

Bool setCommunicatorStatus(String $params)

Definicja parametrów

Metoda przyjmuje 1 argument

Nazwa parametru	Typ parametru	Opis
params	String (wymagany)	Możliwe opcje to 'on' - dostępny, 'away' - zaraz wracam, 'xa' - będe później, 'dnd' - nie przeszkadzać, 'off' - wyłączony

Przykład użycia

 try {
     require_once('./classes/eDokumentyApi/EDokApi.inc');
     $api = new \EDokApi();
     $params = 'dnd'; //nie przeszkadzać
     $result = $api->setCommunicatorStatus($params);
 } catch(\Exception $e) {
     throw new \Exception($e->getMessage());
 }

Zwracane dane lub wyjątki

Metoda zwraca boolean(true) 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