شاشات العرض
المنصة الأساسيةdisplay_brand_settings_writeشاشات العرضChanges Display Screens settings shared by every facility in the facility's brand: the boot screen shown while screens start up, the settings new screens start with, and what templated content shows. Organisation admins only; read the current values and canEdit with display_settings_read boot_screen, screen_defaults or templated.
Actions:
- save_boot_screen: Save the boot screen. Sets the boot screen image (PNG, JPEG or WebP, up to 10 MB, from a public https imageUrl or imageBase64) and/or how it is laid out. Without an image, fit and background re-render the current one. Screens pick it up when they next start. Asks for confirmation.
- reset_boot_screen: Reset the boot screen. Removes the brand's boot screen; screens go back to the default one when they next start. Asks for confirmation.
- save_screen_defaults: Save the screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities. Only the settings you pass change. Screens that are already paired keep their own settings; change those with device_inventory_write configure_screen. Asks for confirmation.
- save_templated: Save templated content settings. What templated content screens and the Schedule show: the data source name, workout names, programs in the Schedule and how far ahead, training phases and how far ahead, and Program Builder training camps (one banner per week) and how far ahead. Asks for confirmation.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "save_boot_screen" | "reset_boot_screen" | "save_screen_defaults" | "save_templated" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
imageUrl | string | عنوان URL عام عبر https للصورة (save_boot_screen) |
imageBase64 | string | الصورة بترميز base64، عند عدم وجود عنوان URL (save_boot_screen) |
fit | "logo" | "fill" | (save_boot_screen) |
background | string | لون الخلفية (#RRGGBB) (save_boot_screen) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
orientation | "normal" | "left" | "right" | "inverted" | Screen rotation (save_screen_defaults) |
airplayEnabled | boolean | Screens accept AirPlay (save_screen_defaults) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (save_screen_defaults) |
sonosEnabled | boolean | Sonos speaker control (save_screen_defaults) |
duressEnabled | boolean | Bluetooth duress button monitoring (save_screen_defaults) |
cameraRestreamingEnabled | boolean | Restream local camera feeds from the screen (save_screen_defaults) |
wifiSupport | boolean | Captive Wi-Fi setup portal (save_screen_defaults) |
showSourceName | boolean | (save_templated) |
showWorkoutNames | boolean | (save_templated) |
showProgramsInSchedule | boolean | (save_templated) |
programLookaheadDays | integernull | عدد الأيام المسبقة (0–90)، أو null لعدم وجود حد (save_templated) |
showTrainingPhases | boolean | (save_templated) |
phaseLookaheadDays | integernull | عدد الأيام المسبقة (0–90)، أو null لعدم وجود حد (save_templated) |
showTrainingCamps | boolean | (save_templated) |
campLookaheadDays | integernull | عدد الأيام المسبقة (0–90)، أو null لعدم وجود حد (save_templated) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_groups_writeشاشات العرضتنشئ مجموعات Display Screens في منشأة وتعيد تسميتها وتحذفها، وتحدد الشاشات التي تضمها. المجموعات هي أهداف للنشر (display_publish targets.groupIds) وأهداف للأوامر (display_screen_command groupIds). عند تحديد عدة شاشات أو مجموعات أو أهداف، تنفّذ الأداة الإجراء عليها جميعًا في استدعاء واحد؛ لذا تحقّق مع المستخدم قبل تنفيذ إجراء على عدد كبير منها.
الإجراءات:
- save: حفظ مجموعة. الإنشاء: name (واختياريًا screenIds). إعادة التسمية: groupId (المعرّف أو الاسم الحالي) وname. يستبدل screenIds الأعضاء؛ والشاشات غير المدرجة تغادر هذه المجموعة لكنها تحتفظ بمجموعاتها الأخرى.
- delete: حذف مجموعة. يحذف مجموعة: تغادرها شاشاتها (مع احتفاظها بمجموعاتها الأخرى) ويُزال المحتوى المنشور إلى المجموعة من الجدول. يتطلب groupId. يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "save" | "delete" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
groupId | string | معرّف مجموعة موجودة أو اسمها، لإعادة تسميتها أو تغيير أعضائها |
name | string | اسم المجموعة (مطلوب عند الإنشاء) (save) |
screenIds | array | الشاشات في المجموعة؛ يستبدل الأعضاء الحاليين (save) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_hosted_apps_writeشاشات العرضتنشر تطبيقات HTML ثابتة ("التطبيقات المستضافة") لـ Display Screens. استدعِ display_library_read app_guidelines أولًا لمعرفة أحجام الشاشات وقواعد التصميم والحدود وSDK، ثم display_screenshot بعد ذلك للتحقق من النتيجة على شاشة. عند تحديد عدة شاشات أو مجموعات أو أهداف، تنفّذ الأداة الإجراء عليها جميعًا في استدعاء واحد؛ لذا تحقّق مع المستخدم قبل تنفيذ إجراء على عدد كبير منها.
الإجراءات:
- publish: نشر تطبيق مستضاف. ينشئ تطبيقًا مستضافًا (name + files) أو ينشر إصدارًا جديدًا (appId + files؛ ويصبح فعّالًا في كل مكان يُعرض فيه التطبيق، ويتراجع rollback عنه). يضعه publishTo على الشاشات أيضًا كما يفعل display_publish؛ ويتطلب الهدف من نوع brand أو organisation القيمة confirm. يتطلب files. قد يطلب التأكيد.
- rollback: التراجع عن إصدار تطبيق مستضاف. يجعل إصدارًا سابقًا هو الحالي مرة أخرى، في كل مكان يُعرض فيه التطبيق. اعرض الإصدارات باستخدام display_library_read app_versions. يتطلب appId وversion.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "publish" | "rollback" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
appId | string | معرّف تطبيق مستضاف موجود (app_…) لنشر إصدار جديد منه |
name | string | اسم التطبيق (مطلوب عند الإنشاء) (publish) |
files | array | ملفات التطبيق. قيمة encoding هي utf8 (الافتراضية) أو base64 للملفات الثنائية. (publish) |
entry | string | ملف HTML الرئيسي (الافتراضي index.html) (publish) |
durationSec | number | مدة العرض الافتراضية على الشاشة في قوائم التشغيل، بالثواني (publish) |
tags | array | (publish) |
ownerScope | "facility" | "brand" | "organisation" | الجهة المالكة للمحتوى الجديد (الافتراضي facility). تتطلب القيمتان brand وorganisation صلاحية وصول على مستوى المنظمة. (publish) |
publishTo | object | (publish) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
version | integer | الإصدار المراد جعله الإصدار الحالي (rollback) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_library_readشاشات العرضتقرأ مكتبة محتوى Display Screens المرئية لمنشأة: الوسائط (الصور ومقاطع الفيديو)، والتطبيقات (صفحات الويب وتطبيقات HTML المستضافة وتطبيقات وكيل الذكاء الاصطناعي وعروض الدوائر التلفزيونية المغلقة)، وقوائم التشغيل، إضافةً إلى تطبيقات وكيل الذكاء الاصطناعي ومصادر الدوائر التلفزيونية المغلقة التي يمكن إضافتها.
لكل عنصر contentRef (media#… أو app#… أو playlist#…) لاستخدامه مع display_publish وقوائم التشغيل. يبيّن ownerScope الجهة المالكة له (facility# أو brand# أو org#)؛ ولا يمكن نشر المحتوى إلا ضمن نطاق مالكه. الوسائط ذات الحالة processing ليست جاهزة بعد؛ والحالة failed تتطلب إعادة الرفع. لا يمكن تشغيل صفحات الويب ذات frameable: false في قوائم التشغيل، بل كشاشة بصفحة كاملة فقط. تتخطى الشاشات العناصر التي لها displayIssue: تطبيق وكيل ذكاء اصطناعي غير منشور أو متوقف مؤقتًا أو display-off أو محدود الجمهور أو بدون Custom Apps؛ أو عرض دوائر تلفزيونية مغلقة بالحالة no-cctv أو cctv-off (يفعّل مسؤول المنشأة الدوائر التلفزيونية المغلقة للشاشات في إعدادات Display Screens) أو no-cameras.
الإجراءات:
- list: عرض عناصر المكتبة. الوسائط والتطبيقات (مقسّمة إلى صفحات؛ مع التصفية حسب type أو kind أو tag أو name)، أو مع type agent-apps تطبيقات وكيل الذكاء الاصطناعي المسموح بها على الشاشات والتي يمكنك نشرها باستخدام display_publish content.agentAppId. لكل عنصر type: media أو app أو agent-app.
- cctv_sources: عرض مصادر الدوائر التلفزيونية المغلقة. كاميرات المنشأة وعروض Live View المشتركة لاستخدامها مع display_publish content.cctv، وما إذا كانت الدوائر التلفزيونية المغلقة مفعّلة على الشاشات. يتطلب صلاحية الوصول إلى الدوائر التلفزيونية المغلقة في المنشأة.
- get: الحصول على عنصر من المكتبة. عنصر وسائط أو تطبيق أو قائمة تشغيل واحدة حسب contentRef. يتطلب contentRef.
- usages: أماكن استخدام المحتوى. تعيينات الجدول الفعّالة وقوائم التشغيل التي تستخدم عنصر وسائط أو تطبيقًا (أو التعيينات الخاصة بقائمة تشغيل). لا يمكن حذف المحتوى قيد الاستخدام. يتطلب contentRef.
- app_versions: عرض إصدارات التطبيق المستضاف. إصدارات تطبيق مستضاف وأيها الحالي، لاستخدامها مع display_hosted_apps_write rollback. يتطلب appId.
- app_guidelines: إرشادات التطبيقات المستضافة. أحجام الشاشات وقواعد التصميم وحدود الحزمة وDisplay App SDK وقالب أولي. استدعِ هذا الإجراء قبل إنشاء تطبيق لـ display_hosted_apps_write publish.
- check_url: التحقق من صفحة ويب. ما إذا كان يمكن عرض صفحة ويب داخل قوائم التشغيل (بعض المواقع ترفض التضمين في إطار)، مع تلميحات حول مظهرها. يمكن عرض الصفحات التي ترفض التضمين كشاشة بصفحة كاملة. يتطلب url.
- playlists: عرض قوائم التشغيل. قوائم التشغيل المرئية للمنشأة (مقسّمة إلى صفحات)، ولكل منها عناصرها (contentRef وduration وfit).
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "list" | "cctv_sources" | "get" | "usages" | "app_versions" | "app_guidelines" | "check_url" | "playlists" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
type | "media" | "apps" | "agent-apps" | نوع واحد فقط من العناصر (الافتراضي: الوسائط والتطبيقات) (list) |
kind | "image" | "video" | "url" | "hosted" | "agent-app" | "cctv-view" | (list) |
tag | string | العناصر التي تحمل هذه العلامة فقط (list) |
search | string | عامل تصفية للاسم لا يميّز حالة الأحرف (list) |
limit | integer | عدد العناصر في كل صفحة (الافتراضي 25، والحد الأقصى 100) (list, playlists) |
cursor | string | قيمة nextCursor من الصفحة السابقة (list, playlists) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. (list, cctv_sources, get, usages, app_versions, check_url, playlists) |
contentRef | string | media#<id> أو app#<id> أو playlist#<id>، من display_library_read list أو playlists (get, usages) |
appId | string | معرّف التطبيق المستضاف (app_…) (app_versions) |
url | string | عنوان URL عام عبر https (check_url) |
display_library_writeشاشات العرضتضيف محتوى مكتبة Display Screens وتغيّره: رفع الصور ومقاطع الفيديو، وإنشاء تطبيقات صفحات الويب وتطبيقات وكيل الذكاء الاصطناعي وتطبيقات عروض الدوائر التلفزيونية المغلقة، وتعديل الأسماء والعلامات والمدد والتواريخ، وحذف العناصر غير المستخدمة، وتحديث معاينة التطبيق. تُنشر تطبيقات HTML المستضافة باستخدام display_hosted_apps_write؛ وقوائم التشغيل باستخدام display_playlists_write.
صمّم الصور بدقة 1920×1080 (أفقي) أو 1080×1920 (عمودي). تبدأ الوسائط الجديدة بالحالة processing أثناء إعداد نسخ جاهزة للويب؛ ويمكن إضافتها إلى قوائم التشغيل فورًا وتُشغَّل حالما تصبح جاهزة. ownerScope: facility (الافتراضي) أو brand أو organisation (تتطلب القيمتان brand وorganisation صلاحية وصول على مستوى المنظمة).
الإجراءات:
- upload_media: رفع صورة أو فيديو. يضيف صورة أو فيديو من url عام عبر https (مفضّل؛ الصور حتى 25 MB، ومقاطع الفيديو حتى 200 MB) أو بترميز base64 مع mimeType (حتى 20 MB). الصور بتنسيقات JPEG وPNG وWebP وGIF؛ ومقاطع الفيديو بتنسيقات MP4 وWebM وMOV (تُحوَّل إلى H.264 MP4 حتى 1080p). لمقاطع الفيديو الأكبر: create_video_upload.
- create_video_upload: بدء رفع فيديو كبير. لمقاطع الفيديو حتى 2 GB: يسجّل الفيديو ويعيد رفعًا موقّعًا مسبقًا (أرسل الملف بطلب PUT إلى upload.url مع upload.headers قبل upload.expiresAt)، ثم استدعِ transcode مع contentRef الخاص به. يتطلب name وmimeType وbytes.
- transcode: معالجة فيديو. يحوّل فيديو ليناسب الشاشات: بعد create_video_upload، أو مرة أخرى بعد فشل، أو لفيديو قديم لا تستطيع الشاشات تشغيله. يتطلب contentRef.
- create_app: إضافة تطبيق. يضيف صفحة ويب (kind url، مع تمرير url؛ ويُتحقق من قابلية تضمينها في إطار)، أو تطبيق وكيل ذكاء اصطناعي (kind agent-app، مع تمرير agentAppId من display_library_read list type agent-apps)، أو عرض دوائر تلفزيونية مغلقة (kind cctv-view، مملوك للمنشأة، ويتطلب صلاحية الوصول إلى الدوائر التلفزيونية المغلقة). يتطلب kind وname.
- update: تحديث عنصر في المكتبة. يغيّر اسم عنصر وسائط أو تطبيق أو علاماته أو مدته؛ أو validFrom/validTo لعنصر وسائط (بتنسيق ISO، وnull يمسح القيمة؛ وخارج هذه الفترة يُتخطّى العنصر)؛ أو url لصفحة ويب؛ أو الكاميرات أو العرض أو التخطيط أو الجودة لعرض دوائر تلفزيونية مغلقة. يتطلب contentRef.
- delete: حذف عنصر من المكتبة. يحذف عنصر وسائط أو تطبيقًا. يُمنع الحذف ما دام العنصر في جدول فعّال أو قائمة تشغيل: يعرض الخطأ هذه الأماكن (أزلها أولًا باستخدام display_schedule_write delete أو display_playlists_write save). يتطلب contentRef. يطلب التأكيد.
- refresh_preview: تحديث معاينة التطبيق. يلتقط لقطة شاشة جديدة لتطبيق لمعاينته في المكتبة (مثلًا بعد تغيّر الصفحة). يتطلب contentRef.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "upload_media" | "create_video_upload" | "transcode" | "create_app" | "update" | "delete" | "refresh_preview" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
url | string | عنوان URL عام عبر https للصورة أو الفيديو (مفضّل) (upload_media, create_app, update) |
base64 | string | محتوى الملف بترميز base64 (بحد أقصى 20 MB)، عند عدم وجود عنوان URL (upload_media) |
mimeType | string | مطلوب مع base64، مثل image/png (upload_media, create_video_upload) |
name | string | الاسم في المكتبة (upload_media, create_video_upload, create_app, update) |
tags | array | العلامات (تستبدل العلامات الحالية) (upload_media, create_video_upload, create_app, update) |
ownerScope | "facility" | "brand" | "organisation" | الجهة المالكة للمحتوى الجديد (الافتراضي facility). تتطلب القيمتان brand وorganisation صلاحية وصول على مستوى المنظمة. (upload_media, create_video_upload, create_app) |
durationSec | number | مدة العرض الافتراضية للصور على الشاشة، بالثواني (upload_media, create_app, update) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
bytes | integer | حجم الملف بالبايت (create_video_upload) |
resolution | "720" | "1080" | "1440" | "2160" | "original" | أكبر حجم يُحوَّل إليه الفيديو للشاشات (الافتراضي 1080؛ والقيمة original تحتفظ بحجمه) (create_video_upload, transcode) |
contentRef | string | media#<id> أو app#<id> أو playlist#<id>، من display_library_read list أو playlists (transcode, update, delete, refresh_preview) |
kind | "url" | "agent-app" | "cctv-view" | (create_app) |
agentAppId | string | تطبيقات وكيل الذكاء الاصطناعي: معرّف التطبيق (create_app) |
source | "view" | "cameras" | عروض الدوائر التلفزيونية المغلقة: view (مرّر viewId) أو cameras (مرّر cameras) (create_app, update) |
viewId | string | عروض الدوائر التلفزيونية المغلقة: معرّف Live View (display_library_read cctv_sources) (create_app, update) |
cameras | array | عروض الدوائر التلفزيونية المغلقة: معرّفات الكاميرات (display_library_read cctv_sources) (create_app, update) |
layout | "auto" | "1x1" | "2x1" | "1+2" | "2x2" | "1+5" | "2x3" | "3x3" | عروض الدوائر التلفزيونية المغلقة: تخطيط المربعات (create_app, update) |
quality | "auto" | "native" | "1080p" | "720p" | "480p" | "360p" | "240p" | عروض الدوائر التلفزيونية المغلقة: جودة البث (create_app, update) |
showNames | boolean | عروض الدوائر التلفزيونية المغلقة: إظهار أسماء الكاميرات على المربعات (create_app, update) |
validFrom | stringnull | الوسائط: التاريخ والوقت بتنسيق ISO لبدء التشغيل؛ وnull يمسح القيمة (update) |
validTo | stringnull | الوسائط: التاريخ والوقت بتنسيق ISO لإيقاف التشغيل؛ وnull يمسح القيمة (update) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_playlists_writeشاشات العرضتنشئ قوائم تشغيل Display Screens وتحدّثها وتحذفها: حلقات مرتبة من الوسائط والتطبيقات. تصل التغييرات إلى كل شاشة تعرض قائمة التشغيل خلال ثوانٍ. انشر قائمة تشغيل باستخدام display_publish content.contentRef "playlist#
الإجراءات:
- save: حفظ قائمة تشغيل. الإنشاء: name + items (يمكن أن تكون items فارغة). التحديث: playlistId + أيٌّ من name أو items أو transition؛ تستبدل items القائمة بأكملها، لذا أرسل كل العناصر بالترتيب.
- delete: حذف قائمة تشغيل. يحذف قائمة تشغيل. يُمنع الحذف ما دامت منشورة في أي مكان: يعرض الخطأ التعيينات التي يجب إزالتها أولًا (display_schedule_write delete). يتطلب playlistId. يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "save" | "delete" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
playlistId | string | معرّف قائمة تشغيل موجودة (pl_…) لتحديثها |
name | string | اسم قائمة التشغيل (مطلوب عند الإنشاء) (save) |
transition | "fade" | "none" | (save) |
ownerScope | "facility" | "brand" | "organisation" | الجهة المالكة للمحتوى الجديد (الافتراضي facility). تتطلب القيمتان brand وorganisation صلاحية وصول على مستوى المنظمة. (save) |
items | array | القائمة بأكملها بالترتيب (تستبدل العناصر الحالية؛ احتفظ بـ itemId للإبقاء على عنصر). لن تُشغَّل صفحات الويب ذات frameable: false. (save) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_publishشاشات العرضتضع المحتوى على Display Screens: عنصر وسائط أو قائمة تشغيل أو تطبيق أو صفحة ويب أو تطبيق وكيل ذكاء اصطناعي أو عرض مباشر للدوائر التلفزيونية المغلقة، على الشاشات أو المجموعات أو المنشأة أو علامتها التجارية أو منظمتها.
mode: يستبدل now (الافتراضي) ما تعرضه الأهداف عادةً؛ ويعرض scheduled المحتوى فقط في فترات أسبوعية (بالمنطقة الزمنية للمنشأة) و/أو بين from وto؛ ويقاطع takeover كل شيء لمدة durationMin (أو حتى وقت محدد)، ثم ينتهي تلقائيًا (أوقفه مبكرًا باستخدام display_takeover_stop). تحدد الشاشات ما تعرضه حسب الطبقة (takeover > scheduled > default)، ثم حسب مدى تحديد الهدف (screen > group > facility > brand > organisation).
الدوائر التلفزيونية المغلقة: بث الكاميرات المباشر مرئي لأي شخص بالقرب من الشاشات. يعيد الاستدعاء الأول requiresConfirmation (الرمز CCTV_CONFIRMATION_REQUIRED)؛ اسأل المستخدم، ثم استدعِ الأداة مرة أخرى مع confirmCctv: true. يجب أن يكون الخيار "Allow CCTV on display screens" مفعّلًا في المنشأة.
لا تعرض المحتوى المنشور إلا الشاشات في وضع المشغّل؛ وتُدرج الشاشات الأخرى في warnings. تعيد batchId؛ ويؤدي استخدامه مع display_schedule_write delete إلى التراجع عن عملية النشر بأكملها. عند تحديد عدة شاشات أو مجموعات أو أهداف، تنفّذ الأداة الإجراء عليها جميعًا في استدعاء واحد؛ لذا تحقّق مع المستخدم قبل تنفيذ إجراء على عدد كبير منها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
targets* | object | وجهة المحتوى. يمكنك الجمع بين أي من هذه الخيارات. تعمل أسماء المجموعات كما تعمل المعرّفات. تتطلب القيمتان brand وorganisation صلاحية وصول إلى Display Screens على مستوى المنظمة. |
content* | object | ما سيُعرض: واحد فقط من contentRef أو url أو agentAppId أو cctv. |
mode | "now" | "default" | "scheduled" | "takeover" | `now`/`default` (الافتراضي): يستبدل ما تعرضه الأهداف عادةً. `scheduled`: فقط ضمن الفترات و/أو بين from وto. `takeover`: يقاطع كل شيء لمدة durationMin (أو حتى وقت محدد)، ثم ينتهي تلقائيًا. |
windows | array | فترات أسبوعية بالمنطقة الزمنية للمنشأة. قيم days هي أيام الأسبوع بتنسيق ISO (1 = الاثنين … 7 = الأحد)؛ وstart/end بتنسيق "HH:MM" (يُسمح بالقيمة "24:00" لـ end). |
from | string | التاريخ والوقت بتنسيق ISO لبدء النشر المجدول |
to | string | التاريخ والوقت بتنسيق ISO لانتهاء النشر المجدول |
durationMin | number | مدة الاستحواذ (takeover) بالدقائق (بحد أقصى 7 أيام) |
until | string | التاريخ والوقت بتنسيق ISO لانتهاء الاستحواذ (takeover) (بدلًا من durationMin) |
priority | integer | يحسم التعادل بين العناصر المجدولة المتداخلة (القيمة الأعلى هي التي تُعتمد) |
confirmCctv | boolean | اضبطه فقط بعد أن يؤكد المستخدم صراحةً عرض بث الدوائر التلفزيونية المغلقة المباشر |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_schedule_readشاشات العرضتقرأ ما هو منشور على Display Screens: لشاشة واحدة، ما تعرضه في وقت معيّن وخلال نطاق زمني (بعد حسمه عبر كل طبقة وهدف ترث منه) إضافةً إلى التعيينات التي تصل إليها؛ أو التعيينات المنشورة إلى مجموعة أو المنشأة أو علامتها التجارية أو منظمتها.
معرّفات التعيينات (as_…) ومعرّفات الدفعات (bt_…) هي ما يحدّثه display_schedule_write أو يحذفه. الأوقات بتنسيق ISO؛ والفترات بالمنطقة الزمنية للمنشأة.
الإجراءات:
- get: الحصول على جدول شاشة. ما تعرضه الشاشة في
at(الافتراضي الآن)، وخطها الزمني منfromإلىto(الافتراضي 24 ساعة)، وكل تعيين يصل إليها. يتطلب screenId. - list_assignments: عرض التعيينات. التعيينات المنشورة إلى مجموعة (groupId)، أو إلى المنشأة أو علامتها التجارية أو منظمتها (target، والافتراضي facility). مقسّمة إلى صفحات، والأحدث تغييرًا أولًا.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "get" | "list_assignments" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
screenId | string | معرّف الشاشة (الرمز المكوّن من 6 أحرف) من display_screens_read list (get) |
at | string | التاريخ والوقت بتنسيق ISO للتحقق مما يُعرض (الافتراضي الآن) (get) |
from | string | بداية الخط الزمني بتنسيق ISO (الافتراضي at، وإلا الآن) (get) |
to | string | نهاية الخط الزمني بتنسيق ISO (الافتراضي 24 ساعة بعد from) (get) |
includeExpired | boolean | تضمين التعيينات التي انتهت |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
groupId | string | معرّف مجموعة الشاشات أو اسمها، من display_screens_read groups (list_assignments) |
target | "facility" | "brand" | "organisation" | عند عدم تحديد groupId (الافتراضي facility) (list_assignments) |
limit | integer | عدد العناصر في كل صفحة (الافتراضي 25، والحد الأقصى 100) (list_assignments) |
cursor | string | قيمة nextCursor من الصفحة السابقة (list_assignments) |
display_schedule_writeشاشات العرضتغيّر ما هو منشور على Display Screens: تعديل توقيت تعيين أو أولويته أو محتواه (اختياريًا عبر عملية النشر بأكملها)، أو إزالة تعيين واحد أو عملية نشر كاملة. اعثر على المعرّفات باستخدام display_schedule_read. تؤدي إزالة المحتوى من الجدول إلى إبقائه في المكتبة؛ ولإنهاء استحواذ (takeover) مبكرًا مع الاحتفاظ بسجله، استخدم display_takeover_stop.
الإجراءات:
- update: تحديث تعيين. يغيّر توقيت التعيين (الفترات الأسبوعية، from/to؛ وnull يمسح التاريخ) أو أولويته أو محتواه. يطبّق applyToBatch التغيير نفسه على كل أهداف عملية النشر. لا يمكن تغيير شيء في الاستحواذ (takeover) سوى وقت انتهائه. يتطلب محتوى الدوائر التلفزيونية المغلقة confirmCctv بعد موافقة المستخدم. يتطلب assignmentId.
- delete: الإزالة من الجدول. يزيل تعيينًا واحدًا (assignmentId) أو كل ما يخص عملية نشر واحدة (batchId). تعود الشاشات خلال ثوانٍ إلى ما كانت ستعرضه في غير ذلك. يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "update" | "delete" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
assignmentId | string | تعيين واحد (as_…) من display_schedule_read |
applyToBatch | boolean | تطبيق التغيير نفسه على كل أهداف عملية النشر (update) |
windows | array | فترات أسبوعية بالمنطقة الزمنية للمنشأة. قيم days هي أيام الأسبوع بتنسيق ISO (1 = الاثنين … 7 = الأحد)؛ وstart/end بتنسيق "HH:MM" (يُسمح بالقيمة "24:00" لـ end). (update) |
from | stringnull | التاريخ والوقت بتنسيق ISO للبدء؛ وnull يمسح القيمة (update) |
to | stringnull | التاريخ والوقت بتنسيق ISO للانتهاء؛ وnull يمسح القيمة (update) |
priority | integer | يحسم التعادل بين العناصر المجدولة المتداخلة (القيمة الأعلى هي التي تُعتمد) (update) |
contentRef | string | media#<id> أو app#<id> أو playlist#<id>، من display_library_read list أو playlists (update) |
confirmCctv | boolean | اضبطه فقط بعد أن يؤكد المستخدم صراحةً عرض بث الدوائر التلفزيونية المغلقة المباشر (update) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
batchId | string | عملية نشر كاملة (bt_…) من display_publish أو display_schedule_read، عبر كل أهدافها (delete) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_screen_commandشاشات العرضترسل أمرًا مباشرًا إلى Display Screens في منشأة: reload (تعيد شاشات المشغّل جلب جدولها)، أو identify (يومض اسم الشاشة ورمزها للعثور عليها في المكان)، أو displayOn/displayOff (لوحة التلفاز)، أو rebootDevice (يعيد تشغيل حاسوب الشاشة، مع شاشة فارغة لمدة 1–2 دقيقة؛ ويتطلب confirm: true)، أو osd (رسالة قصيرة على الشاشة؛ مرّر message).
اختر الشاشات باستخدام screenIds و/أو groupIds (كل شاشة في تلك المجموعات في المنشأة)، أو allScreens: true لكل شاشة في المنشأة (عندئذٍ يصل displayOn/displayOff إلى شاشات Templated content أيضًا). تعيد نتائج لكل شاشة. عند تحديد عدة شاشات أو مجموعات أو أهداف، تنفّذ الأداة الإجراء عليها جميعًا في استدعاء واحد؛ لذا تحقّق مع المستخدم قبل تنفيذ إجراء على عدد كبير منها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
screenIds | array | معرّفات الشاشات (الرموز المكوّنة من 6 أحرف) من display_screens_read list. احذفها عند استخدام allScreens. |
groupIds | array | معرّفات مجموعات الشاشات أو أسماؤها: كل شاشة في تلك المجموعات في المنشأة |
allScreens | boolean | كل شاشة في المنشأة، بما في ذلك شاشات Templated content |
command* | "reload" | "identify" | "displayOn" | "displayOff" | "rebootDevice" | "osd" | الإجراء المطلوب (يتطلب rebootDevice القيمة confirm) |
message | string | نص osd |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_screens_readشاشات العرضتقرأ Display Screens في منشأة: عرضها مع حالتها وما يُعرض الآن وما يليه (مع التصفية حسب المجموعة أو الحالة أو وضع العرض)، أو الحصول على التفاصيل الكاملة لشاشة واحدة وخطها الزمني، أو عرض مجموعات الشاشات مع شاشاتها.
يظهر وضع العرض للمستخدمين باسم "Data Source": القيمة player هي "User managed content"، والقيمة program-builder هي "Templated content" (لا تستخدم أبدًا مع المستخدمين أي اسم آخر لهذا الوضع)، والقيمة url هي "Full-page website (Kiosk Mode)". الأوقات بتنسيق ISO؛ وتُعاد المنطقة الزمنية للمنشأة.
الإجراءات:
- list: عرض الشاشات. الشاشات في المنشأة (مقسّمة إلى صفحات)، ولكل منها الحالة وآخر نبضة اتصال والمجموعات والعلامات وما يُعرض الآن وما يليه. تعيد المجموعات أيضًا.
- get: الحصول على شاشة. التفاصيل الكاملة لشاشة واحدة (الحالة ونبضة الاتصال وإصدار المشغّل والأخطاء الأخيرة)، ولشاشات المشغّل ما تعرضه خلال نطاق زمني (الافتراضي الساعات الـ 24 التالية، والحد الأقصى 14 يومًا). يتطلب screenId.
- groups: عرض مجموعات الشاشات. مجموعات الشاشات في المنشأة (مقسّمة إلى صفحات)، ولكل منها شاشاتها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "list" | "get" | "groups" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
groupId | string | الشاشات في هذه المجموعة فقط (المعرّف أو الاسم) (list) |
status | "playing" | "provisioning" | "display-off" | "not-responding" | "offline" | "online" | (list) |
mode | "player" | "program-builder" | "url" | (list) |
limit | integer | عدد العناصر في كل صفحة (الافتراضي 25، والحد الأقصى 100) (list, groups) |
cursor | string | قيمة nextCursor من الصفحة السابقة (list, groups) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
screenId | string | معرّف الشاشة (الرمز المكوّن من 6 أحرف) من display_screens_read list (get) |
from | string | بداية الخط الزمني بتنسيق ISO (الافتراضي الآن) (get) |
to | string | نهاية الخط الزمني بتنسيق ISO (الافتراضي 24 ساعة بعد from) (get) |
display_screens_writeشاشات العرضإدارة الجهازتغيّر Display Screens: إقران شاشة جديدة برمز الإقران الخاص بها؛ أو إعادة تسمية شاشة، أو تعيين مجموعاتها وعلاماتها، أو تبديل وضع العرض الخاص بها (يظهر للمستخدمين باسم "Data Source")؛ أو تدوير الرمز المميز لشاشة مشغّل؛ أو إنشاء رابط معاينة محدود المدة لشاشة أو محتوى؛ أو إعادة ضبط شاشة إلى إعدادات المصنع (يزيلها من المنشأة).
أوضاع العرض: player ("User managed content")، وurl ("Full-page website (Kiosk Mode)"، مع تمرير url، عبر https فقط)، وprogram-builder ("Templated content"؛ لا تستخدم أبدًا مع المستخدمين أي اسم آخر لهذا الوضع). يؤدي تغيير الوضع إلى إعادة تحميل الشاشة فورًا وتغيير ما يراه الأعضاء، لذا يتطلب تأكيد المستخدم.
الإجراءات:
- update: تحديث شاشة. يضبط اسم الشاشة ومجموعاتها (المعرّفات أو الأسماء؛ تستبدل المجموعات الحالية) وعلاماتها (تستبدلها) و/أو وضع العرض. يعيد تغيير الوضع requiresConfirmation أولًا. يتطلب screenId. قد يطلب التأكيد.
- rotate_token: تدوير الرمز المميز للشاشة. يصدر رمزًا مميزًا جديدًا لشاشة مشغّل ويعيد تحميلها؛ ويتوقف الرمز القديم عن العمل. استخدمه عند احتمال تسرّب عنوان URL لمشغّل الشاشة. يتطلب screenId. يطلب التأكيد.
- create_preview_link: إنشاء رابط معاينة. رابط (صالح لمدة محدودة) يعرض ما تعرضه الشاشة أو مظهر المحتوى، اختياريًا في وقت مستقبلي. يمكن لأي شخص لديه الرابط عرضه حتى انتهاء صلاحيته.
- reset: إعادة ضبط شاشة إلى إعدادات المصنع. يزيل الشاشة من المنشأة ويعيد ضبطها إلى إعدادات المصنع؛ وتُعاد ضبط الشاشة المطفأة عندما تتصل بالإنترنت في المرة التالية، ثم تعرض صفحة الإقران الخاصة بها. مرّر confirmName: اسم الشاشة تمامًا كما كتبه المستخدم. يتطلب إدارة الجهاز. يتطلب screenId وconfirmName. يطلب التأكيد.
- pair: إقران شاشة جديدة. يضيف شاشة جديدة إلى المنشأة باستخدام الرمز المكوّن من 6 أحرف في صفحة الإقران الخاصة بها، ثم يعيد تحميلها. في المنشآت التي لديها Display Screens فقط تبدأ الشاشة على player؛ وإذا كان لديها Templated content أيضًا، يحدد mode ذلك (الافتراضي program-builder). يتطلب إدارة الجهاز. يتطلب pairingCode وname. يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "update" | "rotate_token" | "create_preview_link" | "reset" | "pair" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
screenId | string | معرّف الشاشة (الرمز المكوّن من 6 أحرف) من display_screens_read list (update, rotate_token, create_preview_link, reset) |
name | string | اسم الشاشة (update, pair) |
groupIds | array | معرّفات المجموعات أو أسماؤها؛ تستبدل المجموعات الحالية (أنشئ المجموعات باستخدام display_groups_write save) (update) |
tags | array | تستبدل العلامات الحالية (update) |
mode | "player" | "program-builder" | "url" | وضع العرض ("Data Source") (update, pair) |
url | string | الموقع الإلكتروني لوضع url (عبر https) (update) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
contentRef | string | media#<id> أو app#<id> أو playlist#<id>، من display_library_read list أو playlists (create_preview_link) |
orientation | "landscape" | "portrait" | لمعاينات contentRef (الافتراضي landscape) (create_preview_link) |
at | string | التاريخ والوقت بتنسيق ISO للمعاينة (الافتراضي الآن) (create_preview_link) |
confirmName | string | اسم الشاشة كما كتبه المستخدم للتأكيد (يجب أن يتطابق تمامًا) (reset) |
pairingCode | string | الرمز الذي تعرضه الشاشة في صفحة الإقران الخاصة بها (يتشابه 0 وO في الشكل) (pair) |
contentStream | string | Templated content: المسار (الجولة) الذي تشغّله الشاشة، والافتراضي 1 (pair) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_screenshotشاشات العرضتلتقط ما تعرضه شاشة Display Screens الآن وتعيد الصورة، لتتمكن من التحقق من عملك بعد النشر (التخطيط وحجم النص وعدم وجود أجزاء مقطوعة أو تمرير). تنتظر حتى 15 ثانية لاستجابة الشاشة؛ وتنتهي مهلة الشاشات غير المتصلة. تعيد أيضًا عنوان URL في البوابة لصورة JPEG (للمستخدمين الذين سجّلوا الدخول فقط، ويُحتفظ به لمدة 10 دقائق).
قد تتضمن لقطات الشاشة بث الدوائر التلفزيونية المغلقة المباشر وأعضاء ظاهرين فيها؛ لا تشاركها خارج المحادثة.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
screenId* | string | معرّف الشاشة (الرمز المكوّن من 6 أحرف) من display_screens_read list |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
display_settings_readشاشات العرضReads Display Screens settings for a facility: the fallback slate, polling and nightly reload, CCTV on screens; the screen power schedule (with the next days' on/off times); automations (brightness, bell volume, check-in power, round timer state); the brand's boot screen, screen defaults and templated content settings; and, with templated content, the scheduled program dates and the templated schedule.
Actions:
- settings: Get facility display settings. The fallback slate (message, background, logo, facility name), polling interval, nightly reload time and whether CCTV may be shown on screens.
- power_schedule: Get the power schedule. When screens turn on and off: the saved schedule (or the older automations' equivalent), the facility time zone and the on/off times for the next 7 days.
- power_schedule_preview: Preview a power schedule. The on/off times a schedule would give over the next 7 days, without saving it. Needs schedule.
- automations: Get display automations. Automatic brightness (day/night levels and triggers), bell volume levels and schedule (decimal hours, 6.5 = 06:30), check-in power, and the round timer state, for one or several facilities. usesGlobalDefaults is true until the facility saves its own.
- boot_screen: Get the brand's boot screen. The image the facility's brand shows while screens start up (fit, background, image URLs) and whether you can change it (organisation admins).
- screen_defaults: Get the brand's screen defaults. The settings a screen starts with when it is paired at one of the brand's facilities (orientation, screen mirroring, session timer, speaker control, duress monitoring, camera restreaming, Wi-Fi support) and whether you can change them (organisation admins). Screens that are already paired keep their own settings; see device_inventory_read for those.
- templated: Get the brand's templated content settings. What templated content screens and the Schedule show for the facility's brand (source name, workout names, programs and training phases, look-ahead days) and whether you can change it (organisation admins).
- program_dates: List scheduled program dates. The dates with a workout program, from the start of this month to the brand's look-ahead. Needs templated content (Program Builder) at the facility.
- templated_schedule: Get the templated schedule. Programs and training phases between two dates (YYYY-MM-DD, at most 62 days), as the brand shows them. Needs templated content (Program Builder) at the facility. Needs from, to.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "settings" | "power_schedule" | "power_schedule_preview" | "automations" | "boot_screen" | "screen_defaults" | "templated" | "program_dates" | "templated_schedule" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
schedule | object | تعمل الشاشات خلال ساعات وجود الموظفين (موسّعة بفترات الإزاحة) أو خلال الفترات الأسبوعية المخصصة، مع قاعدة للعطلات. (power_schedule_preview) |
facilityIds | array | عدة معرّفات منشآت لتنفيذ الطلب نفسه في كل منها. استخدمه بدلًا من facilityId. (automations) |
from | string | التاريخ الأول (YYYY-MM-DD) (templated_schedule) |
to | string | التاريخ الأخير (YYYY-MM-DD) (templated_schedule) |
display_settings_writeشاشات العرضتغيّر إعدادات Display Screens لمنشأة: Fallback Slate، والاستطلاع وإعادة التحميل الليلية، و"Allow CCTV on display screens"؛ وجدول تشغيل الشاشات؛ والأتمتة (السطوع، ومستوى صوت الجرس، والتشغيل عند تسجيل الحضور). تحتفظ الحقول التي لا تحددها بقيمها الحالية. الإعدادات على مستوى العلامة التجارية (شاشة الإقلاع وTemplated content) موجودة في display_brand_settings_write.
الإجراءات:
- save_settings: حفظ إعدادات العرض للمنشأة. Fallback Slate الذي يظهر عند عدم وجود أي محتوى مجدول، والفاصل الزمني للاستطلاع (30–300 s)، ووقت إعادة التحميل الليلية (HH:mm)، وallowCctv. يتطلب تفعيل allowCctv تأكيد المستخدم ومسؤول منشأة لديه صلاحية الوصول إلى الدوائر التلفزيونية المغلقة. قد يطلب التأكيد.
- save_power_schedule: حفظ جدول التشغيل. يغيّر أوقات تشغيل الشاشات وإطفائها؛ وتُدمج الحقول التي تمرّرها في الجدول المحفوظ. يعيد أوقات التشغيل والإيقاف للأيام السبعة التالية. تحقّق أولًا باستخدام display_settings_read power_schedule_preview. يتطلب schedule.
- save_automations: حفظ أتمتة العرض. يغيّر إعدادات السطوع التلقائي ومستوى صوت الجرس والتشغيل عند تسجيل الحضور. تحتفظ المنشأة بعد ذلك بإعداداتها الخاصة بدلًا من الإعدادات الافتراضية العامة.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "save_settings" | "save_power_schedule" | "save_automations" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
slate | object | (save_settings) |
pollIntervalSec | integer | (save_settings) |
nightlyReloadTime | string | HH:mm (save_settings) |
allowCctv | boolean | السماح بالدوائر التلفزيونية المغلقة على Display Screens (save_settings) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
schedule | object | تعمل الشاشات خلال ساعات وجود الموظفين (موسّعة بفترات الإزاحة) أو خلال الفترات الأسبوعية المخصصة، مع قاعدة للعطلات. (save_power_schedule) |
autoPowerDisplays | boolean | تشغيل/إيقاف أتمتة التشغيل الأقدم (يحل جدول التشغيل محلها) (save_automations) |
minsBeforeOpenDisplayOn | integer | أتمتة التشغيل الأقدم: عدد الدقائق قبل الافتتاح (save_automations) |
minsAfterCloseDisplayOff | integer | أتمتة التشغيل الأقدم: عدد الدقائق بعد الإغلاق (save_automations) |
displaysOnCheckIn | boolean | تشغيل الشاشات عندما يسجّل أحد حضوره (save_automations) |
minsLastCheckInDisplayOff | integer | مع displaysOnCheckIn: عدد الدقائق بعد آخر تسجيل حضور التي تنطفئ بعدها الشاشات (save_automations) |
enableAutoBrightness | boolean | التبديل بين سطوع النهار وسطوع الليل (save_automations) |
dayTriggerType | "auto" | "staffed" | "custom" | وقت بدء سطوع النهار (save_automations) |
dayTimeStart | string | عندما تكون قيمة dayTriggerType هي custom: HH:mm (بتوقيت المنشأة) (save_automations) |
dayOffsetMinutes | integer | عدد الدقائق بعد الفجر أو الافتتاح (save_automations) |
dayBrightnessLevel | integer | سطوع النهار، % (save_automations) |
nightTriggerType | "auto" | "staffed" | "custom" | وقت بدء سطوع الليل (save_automations) |
nightTimeStart | string | عندما تكون قيمة nightTriggerType هي custom: HH:mm (بتوقيت المنشأة) (save_automations) |
nightOffsetMinutes | integer | عدد الدقائق بعد حلول الليل، أو قبل الإغلاق (save_automations) |
nightBrightnessLevel | integer | سطوع الليل، % (save_automations) |
bellMasterLevel | integer | مستوى صوت الجرس الرئيسي، % (save_automations) |
bellClubHoursLevel | integer | مستوى صوت الجرس في ساعات وجود الموظفين، % (save_automations) |
bellExtendedHoursLevel | integer | مستوى صوت الجرس في الساعات الممتدة، % (save_automations) |
enableBellAutoVolume | boolean | اتباع جدول مستوى صوت الجرس (save_automations) |
bellVolumeSchedule | object | فترات مستوى صوت الجرس الأسبوعية لكل يوم من أيام الأسبوع (mon … sun)؛ تستبدل الجدول بأكمله (save_automations) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
display_takeover_stopشاشات العرضتنهي فورًا عمليات الاستحواذ (takeover) الجارية على Display Screens: لعملية نشر واحدة (batchId من display_publish)، أو لأهداف محددة (الافتراضي: عمليات الاستحواذ المنشورة إلى المنشأة بأكملها)، أو باستخدام allScreens لكل عملية استحواذ منشورة إلى المنشأة أو شاشاتها أو مجموعاتها. لا تتوقف عمليات الاستحواذ على مستوى العلامة التجارية والمنظمة إلا باستخدام batchId. تعود الشاشات إلى محتواها المجدول أو الافتراضي خلال ثوانٍ؛ وتعيد الأداة عدد العمليات التي توقفت. عند تحديد عدة شاشات أو مجموعات أو أهداف، تنفّذ الأداة الإجراء عليها جميعًا في استدعاء واحد؛ لذا تحقّق مع المستخدم قبل تنفيذ إجراء على عدد كبير منها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
batchId | string | عملية نشر الاستحواذ (bt_…) من display_publish |
targets | object | وجهة المحتوى. يمكنك الجمع بين أي من هذه الخيارات. تعمل أسماء المجموعات كما تعمل المعرّفات. تتطلب القيمتان brand وorganisation صلاحية وصول إلى Display Screens على مستوى المنظمة. |
allScreens | boolean | كل عملية استحواذ منشورة إلى المنشأة أو شاشاتها أو مجموعاتها |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
display_templated_writeشاشات العرضتتحكم في شاشات Templated content (وضع العرض "Templated content" في display_screens_read): تحميل برنامج تمارين يوم معيّن عليها، أو التحكم في مؤقت الجولات. لا تتأثر أبدًا شاشات User managed content وشاشات مواقع الويب بصفحة كاملة.
الإجراءات:
- load_program: تحميل برنامج تمارين. يحمّل برنامج تمارين تاريخ معيّن (YYYY-MM-DD، والافتراضي اليوم) من مصدر بيانات المنشأة على كل شاشة Templated content في منشأة واحدة أو عدة منشآت؛ وتعيد الشاشات التحميل خلال ثوانٍ. استخدمه لعرض تمرين اليوم أو يوم آخر، أو عندما تعرض الشاشات تمرينًا خاطئًا. تتطلب المنشآت المتعددة confirm. قد يطلب التأكيد.
- clock: التحكم في مؤقت الجولات. يشغّل مؤقت الجولات على شاشات Templated content أو يوقفه مؤقتًا أو يعيد تشغيله أو يوقفه، ويكتم أصوات الجولات أو يلغي كتمها، ويضبط مستوى صوت الجرس (setvolume مع volume بين 0–100) أو يطلب حالته. يتطلب Templated content في المنشأة. يتطلب command.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "load_program" | "clock" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
facilityIds | array | عدة معرّفات منشآت لتنفيذ الطلب نفسه في كل منها. استخدمه بدلًا من facilityId. (load_program) |
date | string | تاريخ التمرين، YYYY-MM-DD (الافتراضي اليوم) (load_program) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
command | "getstate" | "play" | "pause" | "restart" | "stop" | "mute" | "unmute" | "setvolume" | (clock) |
volume | integer | لـ setvolume: مستوى صوت الجرس، % (clock) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |