Documentation
Table of Contents
> Objecte usuari
Els següents objectes són relacionats amb l'API user.
Usuari
L'objecte usuari té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| userid | string | (només lectura) ID d'usuari. |
| username (obligatori) |
string | Nom d'usuari. |
| roleid (obligatori) |
string | ID de rol d'usuari. |
| attempt | timestamp | (només lectura) Hora del darrer intent fallit d'inici de sessió. |
| attempt_failed | integer | (només lectura) El nombre recent d'intents erronis d'inici de sessió. |
| attempt_ip | string | (només lectura) L'adreça IP des de la qual es va originar el darrer intent d'inici de sessió fallit. |
| autologin | integer | Activar o desactivar l'inici de sessió automàtic. Valors possibles: 0 - (per defecte) inici de sessió automàtic desactivat; 1 - inici de sessió automàtic activat. |
| autologout | string | Caducitat de la sessió d'usuari. Accepta segons i unitats de temps amb sufix. Si s'estableix a 0, la sessió no caducarà mai. Per defecte: 15 m. |
| lang | string | Codi d'idioma de l'idioma de l'usuari, per exemple, en_US.Per defecte: default - predeterminat del sistema. |
| name | string | Nom d'usuari. |
| refresh | string | Període de refresc automàtica. Accepta segons i unitats de temps amb sufix. Per defecte: 30s. |
| files_per_page | integer | Nombre de línies de l'assumpte per ensenyar per pàgina. Per defecte: 50. |
| surname | string | Cognom de l'usuari. |
| theme | string | Tema de l'usuari. Valors possibles: default - (default) per defecte;blue-theme - Blau;<br >dark-theme - Fosc.| |url|string|URL de la pàgina per redirigir l'usuari després d'iniciar sessió.| |timezone|string|Zona horària de l'usuari, per exemple,Europe/Andorra,UTC.default' - per defecte del sistema.Per mostrar la llista completa de zones horàries admeses, consulteu la documentació PHP. |
| roleid (obligatori) |
string | ID de rol d'usuari. |
| alias (obsolet) |
string | Aquesta propietat és obsoleta; si us plau, empreu nom d'usuari.Àlies d'usuari. |
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
Suport
L'objecte suport té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| mediatypeid (obligatori) |
string | ID del tipus de suport emprat per el suport. |
| sendto (obligatori) |
string/array | L'adreça, el nom d'usuari o un altre identificador del destinatari. Si el tipus de suport és un correu electrònic, els valors es representen com una matriu. Per a altres tipus de suport, el valor es representa amb una cadena. |
| active | integer | Indica si el suport és habilitat. Valors possibles: 0 - (per defecte) activat; 1 - desactivat. |
| severity | integer | Activa les gravetats per enviar notificacions. Possibles valors de bitmap: 1 - No classificat; 2 - Informació; 4 - Avís; 8 - Mitjana; 16 - Alta; 32 - Desastre. És un camp de màscara de bit; s'admet qualsevol suma de possibles valors de mapa de bits (per exemple, 48 per Mitjana, Alta i Desastre). Per defecte: 63 |
| period | string | Hora en què les notificacions es poden enviar com a període o macros d'usuari separades per punt i coma. Per defecte: 1-7.00: 00-24:00 |