Documentation
Table of Contents
> עצם משתמש
העצמים הבאים קשורים ישירות ל־API user.
משתמש
לאובייקט המשתמש יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| userid | string | (לקריאה בלבד) מזהה המשתמש. |
| שם משתמש (חובה) |
מחרוזת | שם משתמש. |
| roleid (חובה) |
מחרוזת | מזהה תפקיד של המשתמש. |
| attempt_clock | timestamp | (לקריאה בלבד) זמן ניסיון ההתחברות האחרון הלא מוצלח. |
| attempt_failed | integer | (לקריאה בלבד) ספירת ניסיונות כניסה שנכשלו לאחרונה. |
| attempt_ip | string | (לקריאה בלבד) כתובת IP שממנו הגיע ניסיון ההתחברות האחרון הלא מוצלח. |
| autologin | integer | האם לאפשר התחברות אוטומטית. ערכים אפשריים: 0 - (ברירת מחדל) התחברות אוטומטית מושבתת; 1 - התחברות אוטומטית מופעלת. |
| autologout | string | משך חיי הפעלה של משתמש. מקבל שניות ויחידת זמן עם סיומת. אם מוגדר ל-0s, ההפעלה לעולם לא יפוג. ברירת מחדל: 15m. |
| lang | string | קוד שפה של שפת המשתמש, לדוגמה, en_GB.ברירת מחדל: default - ברירת מחדל של המערכת. |
| name | string | שם המשתמש. |
| refresh | string | תקופת רענון אוטומטית. מקבל שניות ויחידת זמן עם סיומת. ברירת מחדל: 30s. |
| rows_per_page | integer | כמות שורות האובייקט להצגה בכל עמוד. ברירת מחדל: 50. |
| surname | string | שם משפחה של המשתמש. |
| theme | string | ערכת הנושא של המשתמש. ערכים אפשריים: ברירת מחדל - (ברירת מחדל) ברירת המחדל של המערכת;blue-theme - כחול;נושא כהה - כהה. |
| url | string | כתובת האתר של הדף שאליו יש להפנות את המשתמש לאחר הכניסה. |
| timezone | string | אזור הזמן של המשתמש, לדוגמה, אירופה/לונדון, UTC.ברירת מחדל: ברירת מחדל - ברירת מחדל של המערכת.לרשימה המלאה של זמן נתמך אזורים נא לעיין בתיעוד PHP. |
| כינוי (הוצא משימוש) |
string | מאפיין זה הוצא משימוש, אנא השתמש ב-'username' במקום זאת. כינוי משתמש. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
מדיה
לאובייקט המדיה יש את המאפיינים הבאים.
| נכס | סוג | תיאור |
|---|---|---|
| mediatypeid (נדרש) |
מחרוזת | מזהה של סוג המדיה המשמש את המדיה. |
| sendto (נדרש) |
string/array | כתובת, שם משתמש או מזהה אחר של הנמען. אם סוג של סוג מדיה הוא דואר אלקטרוני, הערכים מיוצגים כמערך. עבור סוגים אחרים של סוגי מדיה, הערך מיוצג כמחרוזת. |
| פעיל | מספר שלם | האם המדיה מופעלת. ערכים אפשריים: 0 - (ברירת מחדל) מופעלת; 1 - מושבת. |
| חומרה | מספר שלם | מפעיל חומרות לשליחת הודעות לגביהן. חומרות מאוחסנות בצורה בינארית כאשר כל סיביות מייצגות את החומרה המתאימה. לדוגמה, 12 שווה ל-1100 בבינארי ופירושו שהודעות יישלחו מטריגרים עם אזהרת חומרה וממוצע. עיין בדף אובייקט טריגר עבור רשימה של חומרות טריגרים נתמכות. ברירת מחדל: 63 |
| period | string | מועד שבו ניתן לשלוח את ההתראות כ-תקופת זמן או כפקודות מאקרו של משתמש מופרדות באמצעות נקודה-פסיק. ברירת מחדל: 1-7, 00:00-24:00 |