Versions Compared

Old Version 5

changes.mady.by.user Wojciech Przybylski

Saved on

compared with

New Version 6

changes.mady.by.user Wojciech Przybylski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

    • Parametry funkcji

      NazwaTyp

      Wartość domyślna

      		OpisPrzykład
      hookObjectnullZdefiniowane 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.
      Code Block
      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

      NazwaTyp

      Wartość domyślna

      		Opis
      idNumber 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

      NazwaTyp

      Wartość domyślna

      		Opis
      idNumber Id dokumentu do wyświetlenia.
  • getAttachedDocuments (od wersji 4.0.16) - pobiera listę dokumentów podłączonych do procesu.

    • Parametry funkcji

      NazwaTyp

      Wartość domyślna

      		Opis
      processIdString Id procesu, z którego pobrane mają zostać podłączone dokumenty.

    • Rezultat funkcji:

      NazwaTypOpisPrzykład
      documentsAttachedToProcessPromiseObiekt 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
      - documentDate - data dokumentu
      - fileIds - lista wszystkich wersji dokumentu
      - owner - właściciel dokumentu

      Wywołanie metody serwisu z oczekiwaniem na wynik:

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

      Asynchroniczne wywołanie metody serwisu bez oczekiwania na wynik:

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