Documentation
Table of Contents
> User object
Następujące obiekty są bezpośrednio związane z API user.
User
Obiekt user posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| userid | string | (tylko do odczytu) ID użytkownika. |
| username (wymagane) |
string | Nazwa użytkownika. |
| roleid (wymagane) |
string | ID roli użytkownika. |
| attempt_clock | timestamp | (tylko do odczytu) Czas ostatniej nieudanej próby logowania. |
| attempt_failed | integer | (tylko do odczytu) Liczba niedawnych nieudanych prób logowania. |
| attempt_ip | string | (tylko do odczytu) Adres IP, z którego pochodziła ostatnia nieudana próba logowania. |
| autologin | integer | Czy włączyć automatyczne logowanie. Możliwe wartości: 0 - (domyślne) automatyczne logowanie wyłączone; 1 - automatyczne logowanie włączone. |
| autologout | string | Czas życia sesji użytkownika. Akceptuje sekundy i jednostkę czasu z przyrostkiem. Jeśli ustawione na 0s, sesja nigdy nie wygaśnie. Domyślnie: 15m. |
| lang | string | Kod języka użytkownika, na przykład en_GB.Domyślnie: default - domyślny systemowy. |
| name | string | Imię użytkownika. |
| refresh | string | Okres automatycznego odświeżania. Akceptuje sekundy lub jednostkę czasu z przyrostkiem (np. 30s, 90s, 1m, 1h). Domyślnie: 30s. |
| rows_per_page | integer | Ilość wierszy obiektów do wyświetlenia na stronie. Domyślnie: 50. |
| surname | string | Nazwisko użytkownika. |
| theme | string | Motyw użytkownika. Możliwe wartości: default - (domyślnie) domyślny systemowy;blue-theme - Niebieski;dark-theme - Ciemny. |
| url | string | URL strony, do której użytkownik zostanie przekierowany po zalogowaniu. |
| timezone | string | Strefa czasowa użytkownika, na przykład Europe/London, UTC.Domyślnie: default - domyślny systemowy.Dla pełnej listy obsługiwanych stref czasowych należy odwołać się do dokumentacji PHP. |
| alias (przestarzałe) |
string | Ta właściwość jest przestarzała, zamiast tego użyj username.Alias użytkownika. |
Należy zauważyć, że dla niektórych metod (aktualizacja, usuwanie) kombinacja wymaganych/opcjonalnych parametrów może być inna.
Media
Obiekt media posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| mediatypeid (wymagane) |
string | ID typu mediów używanego przez media. |
| sendto (wymagane) |
string/array | Adres, nazwa użytkownika lub inny identyfikator odbiorcy. Jeśli Typ mediów to adres e-mail, wartości są reprezentowane jako tablica. Dla innych Typów mediów, wartość jest reprezentowana jako łańcuch znaków. |
| active | integer | Czy medium jest włączone. Możliwe wartości: 0 - (domyślne) włączone; 1 - wyłączone. |
| severity | integer | Poziom wyzwalaczy do wysyłania powiadomień. Poziomy są przechowywane w formie binarnej, gdzie każdy bit reprezentuje odpowiadający poziom. Na przykład, 12 to 1100 w systemie binarnym, co oznacza, że powiadomienia zostaną wysłane z wyzwalaczy o poziomie ostrzeżenie i średni. Sprawdź stronę obiektu wyzwalacza aby zobaczyć listę obsługiwanych poziomów wyzwalaczy. Domyślnie: 63 |
| period | string | Czas, kiedy powiadomienia mogą być wysyłane jako okres czasu lub makra użytkownika oddzielone średnikiem. Domyślnie: 1-7,00:00-24:00 |