Page History

Serwis CommentsServiceCommentService pozwala zarządzać komentarzami zadania, które aktualnie jest wykonywane. Posiada następujące funkcje:

• showArea - otwiera pole komentarza wraz z przyciskami dodawania komentarza i ukrywania pola. Działa, gdy komentarze są włączone dla zadania.
  

  • Parametry funkcji: 
    
    

    Nazwa	Typ	Wartość domyślna	Opis
    doNotFocus	Boolean	false	Informuje, czy nie rozpoczynać edycji wartości w polu (brak focus'a)

    
    

  • Rezultat funkcji: brak

• hideArea - ukrywa pole komentarza wraz z przyciskami dodawania komentarza i ukrywania pola. Działa, gdy komentarze są włączone dla zadania.
  
  • Parametry funkcji: brak
  • Rezultat funkcji: brak

• showCommentsForm (od 3.1.24) - pokazuje tabelkę komentarzy wraz z przyciskiem dodania komentarza. Działa, gdy komentarze są włączone dla zadania. 
  
  • Parametry funkcji: brak
  • Rezultat funkcji: brak

• hideCommentsForm  (od 3.1.24) - ukrywa tabelkę komentarzy wraz z polem i przyciskiem dodania komentarza. Działa, gdy komentarze są włączone dla zadania.
  
  • Parametry funkcji: brak
  • Rezultat funkcji: brak

• add - dodaje komentarz do procesu. Odświeża także tabelę komentarzy, jeżeli są one włączone dla zadania. Komentarz jest widziany jako dodany przez osobę aktualnie wykonującą zadanie.

• • Parametry funkcji: 

Rezultat funkcji: brak

• get - pobiera wszystkie komentarze dla zadania.

  • Parametry funkcji: 
    
    

    Nazwa	Typ	Wartość domyślna	Opis
    config	Object	{ }	Konfiguracja pobierania komentarzy. Obiekt posiada następujące właściwości:     - handler (Typ Function)         Funkcja, która zostanie wywołana po pobraniu komentarzy dla zadania (domyślnie: null)     - scope (Typ Object)         Scope dla opcjonalnych funkcji wykonywanych po zapisie określonych we właściwościach success i failure (domyślnie: window)     - success (Typ Function)         Opcjonalna funkcja wykonywana po zapisie zakończonym sukcesem (domyślnie: null)     - params (Typ Object[])         Tablica określająca parametry przekazywane do funkcji określonej we właściwości handler, dodatkowo jest uzupełniana o pobrane komentarze dla zadania (domyślnie: [comments] - pobrane komentarze dla zadania)

    
    

  • Rezultat funkcji: brak
  
  
  
• remove - usuwa komentarz dla zadania sprawdzając, czy podany komentarz został dodany przez osobę aktualnie wykonującą zadanie.

  • Parametry funkcji: 
    
    

    Nazwa	Typ	Wartość domyślna	Opis
    commentId	Number	null	Identyfikator komentarza

    
    

  • Rezultat funkcji: brak
  
  
  
• isEdited (od 3.1.8) - informuje, czy pole komentarza jest otwarte, a jego wartość niepusta.
  

  • Parametry funkcji: brak
    

  • Rezultat funkcji:
    
    

    Typ	Opis
    Boolean	Zwraca wartość true, jeżeli pole komentarza jest otwarte, a jego wartość niepusta

• registerHook (od 3.2.94) - pozwala wpiąć się w moment dodawania komentarza przez użytkownika 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ć: - beforeAdd (Typ Function) Funkcja, która zostanie wywołana zanim komentarz zostanie dodany przez użytkownika. Jeżeli funkcja zwróci wartość false, to komentarz nie zostanie dodany. Funkcja przyjmuje jako parametr oboiekt komentarza. - afterAdd (Typ Function) Funkcja, która zostanie dodana po pomyślnym dodaniu komentarza przez użytkownika. - scope (Typ Object) Scope dla wywołania funkcji	Code Block //przykład dodanie tylko hooka po dodaniu komentarza CommentService.registerHook({ afterAdd: function( comment ) { PW.ui.Message.success( 'Komentarz został dodany' ); } });

CommentsServiceCommentServiceallows to manage the comments of the task that is currently being performed. It has the following functions:

• showArea- opens the comment field with the buttons for adding a comment and hiding the field. Works when comments are enabled for a task.
  • Function parameters: 

• Function result: null

• hideArea - hides the comment field together with the buttons for adding a comment and hiding the field. Works when comments are enabled for task.
  • Function parameters:null
  • Function result: null

• showCommentsForm (from 3.1.24) - shows the table of comments together with the button for adding a comment. Works when comments are enabled for task.
  • Function parameters:null
  • Function result: null

• hideCommentsForm (from 3.1.24) - hides a table of comments with a field and a comment button. Works when comments are enabled for task.
  • Function parameters:null
  • Function result: null

• add - adds a comment to the process. It also refreshes the comments table if they are included for the task. The comment is seen as added by the person currently performing the task.
  • Function parameters:

• • Function result: null

• get - gets all comments for the task.
  • Function parameters:

• • Function result: null

• remove - removes a comment for the task by checking if the comment provided was added by the person currently performing the task.
  • Function parameters:

• • Function result: null

• isEdited(from 3.1.8)- informs whether the comment field is open and its value is not empty.
  • Function parameters: null
  • Function result:

• registerHook (od 3.2.94) - allow to execute some actions while user is adding comment

  • Function parameters

    Name	Type	Default value	Description	Example
    hook	Object	null	Hooks to be executed: - beforeAdd (Type Function) Function which will be executed before adding a comment. If function returns false the comment won't be aded. Function has one parameter - object of a comment. - afterAdd (Type Function) Function which will be executed after adding a comment. - scope (Type Object) Scope for functions	Code Block //example of hook after adding comment CommentService.registerHook({ afterAdd: function( comment ) { PW.ui.Message.success( 'Comment was added.' ); } });