Przejdź do głównej treści

Ustaw meta text załącznika

Ready_™ Developer TeamMniej niż 1 minuta

Ustaw meta text załącznika

Definicja Funkcji

Bool setFileMetaText(Int $fileid, String $text, String $encoding = NULL)

Ustawia meta text załącznika (używany przy wyszukiwaniu).

Definicja parametrów

Nazwa parametruTyp parametruOpis
fileidint (Wymagany)Identyfikator załącznika (files.fileid)
textstringTekst meta używany przy wyszukiwaniu
encodingstringParamter obecnie nieużywany

Przykład użycia

 require_once('./classes/eDokumentyApi/EDokApi.inc');
 $api = new \EDokApi();
 $fileid = 1;
 $meta = 'Meta Info';
 try {
     $result = $api->setFileMetaText($fileid, $meta);
 } 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