Serwis CommentsService 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:
Nazwa | Typ | Wartość domyślna | Opis |
---|---|---|---|
comment | String | null | Treść komentarza (maksymalnie 4000 znaków, dłuższe komentarze są ignorowane) |
config | Object | null | Konfiguracja dodawania komentarza. Obiekt posiada następujące właściwości:
|
- 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