Powiadom jednego lub więcej użytkowników.

Definicja Funkcji

Bool notifyUser(Array $data)

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON. Dostępne klucze:

Nazwa parametru	Typ parametru	Opis
usr_id	int[] (wymagane)	Identyfikator(y) użytkownika (users.usr_id)
msgtxt	string (wymagane)	Treść powiadomienia
type__	string, string[]	Wybór kanału komunikacji. Wybrane opcje można przesłać jako string (zarówno pojedynczą wartość, jak kilka wybranych opcji, oddzielonych od siebie przecinkiem) lub jako tablicę stringów. Communicator - wysyła powiadomienie w strumieniu powiadomień Mail - wysyła email z wiadomością Document - tworzy notatke służbową dla użytkownika Jeśli nie ustawimy tego parametru, wybrany zostanie domyślny kanał czyli Communicator.
metaData	array	Tablica z kluczami do metadanych obiektów biznesowych do których prowadzą przyciski na powiadomieniu.
nscls_	string	Nazwa klasy obiektu biznesowego pierwszego przycisku
nskey_	int	Id obiektu biznesowego pierwszego przycisku
ntcls_	string	Nazwa klasy obiektu biznesowego drugiego przycisku
ntkey_	int	Id obiektu biznesowego drugiego przycisku
nttxt_	string	Tytuł powiadomienia

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $data = [
        "msgtxt" => "Treść powiadomienia",
        "usr_id" => [2, 3],
        "metaData" => [
            "nscls_" => "DOCUMENT",
            "nskey_" => 2,
            "ntcls_" => "PROCESS",
            "ntkey_" => 2,
            "nttxt_" => "Tytuł powiadomienia"
        ]
    ];   

    $success = $api->notifyUser($data);
 } 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