DocumentService

refreshDocuments (od wersji 3.2.59) - odświeża dokumenty na formularzu bez przeładowania strony. Odświeżana jest tabela z dokumentami w zakładce Dokumenty, liczba dokumentów w tytule zakładki Dokumenty oraz widok dokumentów.
- Parametry funkcji: brak
- Rezultat funkcji: brak

registerHook (od wersji 3.2.104) - pozwala wpiąć się w moment zarządzania dokumentami i wykonać jakąś akcję.

Parametry funkcji

Nazwa	Typ	Wartość domyślna	Opis	Przykład
hook	Object	null	Zdefiniowane hooki, które mają się wywołać: - refresh (Typ Function) Funkcja, która zostanie wywołana po odświeżeniu wszystkich elementów związanych z wyświetlaniem dokumentów. Odświeżanie następuje zawsze po operacjach na dokumentach takich jak: dodawanie, usuwanie, modyfikacja.	var hookId = DocumentService.registerHook({ refresh: function() { PW.ui.Message.success( 'Dokumenty odświeżone' ); } });

Rezultat funkcji: automatycznie wygenerowany id hooka. Niezbędny do wyrejestrowania hooka.

unregisterHook (od wersji 3.2.104) - pozwala wyrejestrować hook na podstawie jego id otrzymanego podczas rejestracji.
- Parametry funkcji
  Nazwa Typ
  Wartość domyślna
  Opis
  id Number Id otrzymany z funkcji rejestrującej hook.
changeShownDocument (od wersji 3.2.107) - pozwala zmienić wyświetlany dokument na formularzu. Dokument ten musi być dostępny do wyświetlenia przez kliknięcie myszką. Jeżeli nie jest (np. dlatego, że użytkownik ma określoną zbyt małą liczbę wyświetlanych dokumentów na formularzu w ustawieniach konta), zostanie wyświetlony błąd w logach przeglądarki.
- Parametry funkcji
  Nazwa Typ
  Wartość domyślna
  Opis
  id Number Id dokumentu do wyświetlenia.

getAttachedDocuments (od wersji 4.0.16) - pobiera listę dokumentów podłączonych do procesu.

Parametry funkcji
Nazwa Typ
Wartość domyślna
Opis
processId String Id procesu, z którego pobrane mają zostać podłączone dokumenty.

Rezultat funkcji:

Nazwa

Typ

Opis

Przykład

documentsAttachedToProcess

Promise

Obiekt Promise reprezentuje ewentualne zakończenie (lub porażkę) asynchronicznej operacji wywołania zapytania pobierającego listę dokumentów podłączonych do procesu. W przypadku sukcesu zwrócona zostanie lista obiektów o następujących polach:

- processId - id procesu
- documentId - id dokumentu
- documentName - nazwa dokumentu
- documentDescription - opis dokumentu
- documentClassId - id klasy dokumentu
- indices - lista indeksów dokumentu (w przypadku braku uprawnień do podglądu zwracany null)
- documentDate - data dokumentu
- fileIds - lista wszystkich wersji dokumentu
- owner - właściciel dokumentu

Wywołanie metody serwisu z oczekiwaniem na wynik:

foo: async function() {
	let documentsAttachedToProcess = await DocumentService.getAttachedDocuments('id_procesu')
		.catch(error => failureFn(error));
	console.log(documentsAttachedToProcess[0].documentId);
}

Asynchroniczne wywołanie metody serwisu bez oczekiwania na wynik:

foo: function() {
	let documentsAttachedToProcess = DocumentService.getAttachedDocuments('id_procesu')
		.then(result => successFn(result))
		.catch(error => failureFn(error));
	console.log('bar'); // kod wywoła się nie czekając na obsłużenie wyniku z wywołanej metody serwisu
}