Przejdź do głównej treści

Oznacz wiadomości jako przeczytane

Ready_™ Developer TeamMniej niż 1 minuta

Oznacz wiadomości jako przeczytane

Definicja Funkcji

Bool markAsRead($msgIds)

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON. Jako wartości podajemy identyfikatory wiadomości, które będą oznaczone jako przeczytane.

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $msgIds = [1,2,3,4,5]; // id wiadomości, które będą oznaczone jako przeczytane
    $file = $api->markAsRead($msgIds);
} 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