mediatype.get

תיאור

integer/array mediatype.get(object parameters)

השיטה מאפשרת לשלוף סוגי מדיה לפי הנתון פרמטרים.

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

פרמטרים

(object) פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

פרמטר סוג תיאור
mediatypeids string/array החזר רק סוגי מדיה עם המזהים הנתונים.
mediaids string/array החזר רק סוגי מדיה המשמשים את המדיה הנתונה.
userids string/array החזר רק סוגי מדיה המשמשים את המשתמשים הנתונים.
selectMessageTemplates query החזר מאפיין message_templates עם מערך של הודעות מסוג מדיה.
selectUsers query החזר מאפיין משתמשים עם המשתמשים שמשתמשים בסוג המדיה.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: mediatypeid.
countOutput boolean הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled בוליאני
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

דוגמאות

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

מידע נוסף

מקור

CMediaType::get()‎ בתוך ui/include/classes/api/services/CMediaType.php.