مشاركة عبر

إطار عمل تكامل القناة (التحكم المستضاف)

استخدم نوع إطار عمل تكامل القناة لعنصر التحكم المستضاف لدمج موفر القناة الخاص بك مع تطبيق عميل Unified Service Desk. يمكنك إنشاء نوع متعدد من عناصر التحكم المستضاف لتكامل القنوات لاستضافة قنوات مختلفة. لمعرفة المزيد، راجع دمج القناة باستخدام إطار عمل تكامل القنوات.

لإنشاء نوع إطار عمل تكامل القناة لعنصر التحكم المستضاف، راجع إنشاء عنصر تحكم مستضاف في إطار عمل تكامل القناة

إجراءات UII محددة مسبقا

يتم دعم الإجراءات التالية لهذا النوع من عناصر التحكم المستضافة.

إغلاق

يتم استخدام هذا الإجراء لإغلاق عنصر التحكم المستضاف.

FireEvent

إطلاق حدث معرف من قبل المستخدم من عنصر التحكم المستضاف هذا.

المعلمة وصف
اسم اسم الحدث المعرف من قبل المستخدم.

تصبح جميع أزواج الاسم = القيمة اللاحقة معلمات الحدث. لمزيد من المعلومات حول إنشاء حدث معرف من قبل المستخدم، يرجى الاطلاع على إنشاء حدث معرف من قبل المستخدم.

MoveToPanel

يستخدم هذا الإجراء لنقل عناصر التحكم المستضافة بين اللوحات في وقت التشغيل.

المعلمة وصف
التطبيق اسم عنصر التحكم المستضاف المراد نقله.
خشب اللوحة المستهدفة لعنصر التحكم المستضاف.

ينبثق عنوان URL من عنصر التحكم المستضاف ويقوم بتشغيل قواعد التنقل في النافذة ضده لتوجيه النافذة المنبثقة إلى الموقع المناسب.

المعلمة وصف
عنوان URL توجيه نافذة منبثقة من عنصر التحكم المستضاف هذا باستخدام عنوان URL هذا كما لو كانت نافذة منبثقة مطلوبة من عنصر التحكم المعروض.
إطار الإطار الذي نشأت منه هذه النافذة المنبثقة.

برنامج RunScript

يقوم هذا الإجراء بحقن JavaScript في الإطار الرئيسي للتطبيق.

المعلمة وصف
معلمة البيانات هي JavaScript التي سيتم إدخالها في النموذج. ملاحظه: يمكن استخدام معلمات الاستبدال في البرنامج النصي ، وسيتم استبدالها قبل تنفيذ البرنامج النصي.

SetSize

يحدد هذا الإجراء بشكل صريح عرض عنصر التحكم المستضاف وارتفاعه. هذا مفيد بشكل خاص عند استخدام "auto" في تخطيطات اللوحة الخاصة بك.

المعلمة وصف
عرض عرض عنصر التحكم المستضاف.
ارتفاع ارتفاع عنصر التحكم المستضاف.

SetUserCanإغلاق

يمكن المستخدم من إغلاق عنصر التحكم المستضاف بالنقر فوق الرمز X في الزاوية العلوية اليسرى من علامة تبويب عنصر التحكم المستضاف.

المعلمة وصف
UserCanإغلاق قم بتعيين هذا إلى true تمكين المستخدم من إغلاق عنصر التحكم المستضاف. خلاف ذلك ، قم بتعيين false.

RaiseCifClientEvent

يرسل هذا الإجراء البيانات التي تم جمعها من الحدث من جانب العميل إلى عنصر التحكم المستضاف.

المعلمة وصف
حدث الأحداث من جانب العميل من حيث تريد رفع البيانات.
بيانات تأخذ معلمة البيانات قيم eventData.

قم بتمرير البيانات كسلسلة تم استلامها من الحدث باستخدام معلمات الاستبدال.
Person.

الأحداث المدعومة من جانب العميل هي كما يلي:

UpdateCifContext

يرسل هذا الإجراء البيانات من عميل إلى موفر القناة.

المعلمة وصف
معرف يجب أن يكون المعرف الفريد هو نفسه الذي تم تمريره في الحدث الأولي من موفر القناة حتى يسترجع UpdateCifContext النتيجة.
فعل المعلمة لقبول كائن الوعد أو رفضه. يأخذ القيمة ك accept أو reject. إذا نجحت accept، تستدعي واجهة برمجة التطبيقات وظيفة النجاح ، والتي ستنفذ معلمة النتيجة بشكل أكبر. إذا قمت بتمرير reject، تستدعي واجهة برمجة التطبيقات دالة الخطأ.
نتيجة البيانات التي تريد إرسالها من عميل إلى موفر قناة.

الأحداث المحددة مسبقا

يتم دعم الأحداث التالية لهذا النوع من عناصر التحكم المستضافة.

إنشاء سجل

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لإنشاء كيان. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان.
بيانات سلسلة تحدد السمات والقيم لسجل الكيان الجديد.
معرف المعرف الفريد لحدث CreateRecord الذي تم إثارته.

لمعرفة المزيد، راجع createRecord (مرجع واجهة برمجة تطبيقات CIF JavaScript)

استرجاع السجل

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لاسترداد كيان. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للسجل الذي تريد استرداده.
معرف الكيان GUID لسجل الكيان الذي تريد استرداده.
معرف المعرف الفريد لحدث RetrieveRecord الذي تم إثارته.
خيارات خيارات استعلام نظام OData ، $select و $expand ، لاسترداد بياناتك.
  • استخدم خيار استعلام نظام $select للحد من الخصائص التي تم إرجاعها عن طريق تضمين قائمة مفصولة بفواصل. هذه ممارسة مهمة لأفضل الأداء. إذا لم يتم تحديد الخصائص باستخدام $select، إرجاع جميع الخصائص.
  • استخدم خيار استعلام نظام $expand للتحكم في البيانات من الكيانات ذات الصلة التي يتم إرجاعها. إذا قمت فقط بتضمين اسم خاصية التنقل، فستتلقى جميع الخصائص للسجلات ذات الصلة. يمكنك تقييد الخصائص التي تم إرجاعها للسجلات ذات الصلة باستخدام خيار استعلام نظام $select بين قوسين بعد اسم خاصية التنقل. استخدم هذا لكل من خصائص التنقل أحادية القيمةوذات قيمة المجموعة .

يمكنك تحديد خيارات الاستعلام بدءا من ?. يمكنك أيضا تحديد خيارات استعلام متعددة باستخدام & لفصل خيارات الاستعلام. على سبيل المثال:
?$select=name&$expand=primarycontactid($select=contactid,fullname)

لمعرفة المزيد، راجع retrieveRecord (مرجع واجهة برمجة تطبيقات CIF JavaScript)

تحديث

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لتحديث كيان. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للسجل الذي تريد تحديثه.
معرف الكيان GUID لسجل الكيان الذي تريد تحديثه.
بيانات سلسلة تحتوي على key: value أزواج، حيث key هي خاصية الكيان وهي value قيمة الخاصية التي تريد تحديثها.
معرف المعرف الفريد لحدث UpdateRecord الذي تم رفعه.

لمعرفة المزيد، راجع updateRecord (مرجع واجهة برمجة تطبيقات CIF JavaScript)

حذف السجل

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لحذف كيان. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للسجل الذي تريد حذفه.
بيانات سلسلة تحدد السمات والقيم لسجل الكيان الجديد.
معرف الكيان GUID لسجل الكيان الذي تريد حذفه.
معرف المعرف الفريد لحدث DeleteRecord الذي تم رفعه.

لمعرفة المزيد، راجع deleteRecord (مرجع واجهة برمجة تطبيقات CIF JavaScript)

GetEntityMetadata

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لإرجاع بيانات تعريف الكيان للكيان المحدد. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للكيان.
سمات السمات التي تريد الحصول على بيانات التعريف الخاصة بها.
معرف المعرف الفريد لحدث GetEntityMetadata الذي تم إثارته.

لمعرفة المزيد، راجع [getEntityMetadata (مرجع واجهة برمجة تطبيقات CIF JavaScript)](.. /Channel-integration-framework/v1/develop/reference/microsoft-ciFramework /getentitymetadata.md)

GetEnvironment

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة للحصول على تطبيق الواجهة الموحدة الحالية وتفاصيل الصفحة. تتضمن التفاصيل appId وpageType وrecordId (إن وجدت). يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

لا توجد معلمات لهذا الحدث.

لمعرفة المزيد، راجع getEnvironment (مرجع واجهة برمجة تطبيقات CIF JavaScript)

أوبن فورم

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة لفتح نموذج كيان أو نموذج إنشاء سريع. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
entityFormOptions خيارات نموذج الكيان لفتح النموذج.
entityFormParameters كائن قاموس يمرر معلمات إضافية إلى النموذج. ستؤدي المعلمات غير الصالحة إلى حدوث خطأ.

للحصول على معلومات حول تمرير المعلمات إلى نموذج، راجع تعيين قيم الحقول باستخدام المعلمات التي تم تمريرها إلى نموذجوتكوين نموذج لقبول معلمات سلسلة الاستعلام المخصصة
معرف المعرف الفريد لحدث OpenForm الذي تم رفعه.

لمعرفة المزيد، راجع [openForm (مرجع واجهة برمجة تطبيقات CIF JavaScript)](.. /إطار تكامل القناة/مشترك /openform.md)

RenderSearchPage

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة مما يسمح بالبحث بين سجلات نوع كيان معين. تفتح واجهة برمجة التطبيقات هذه صفحة كيان الواجهة الموحدة مع ملء حقل البحث عليها مسبقا بسلسلة البحث التي يتم تمريرها كمعلمة. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للسجل الذي تريد الاستعلام عنه.
سلسلة البحث سلسلة للبحث بين سمات سجلات الكيانات.
معرف المعرف الفريد لحدث RenderSearchPage الذي تم إثارته.

لمعرفة المزيد، راجع [renderSearchPage (مرجع واجهة برمجة تطبيقات جافا سكريبت CIF)](.. /إطار تكامل القناة/مشترك /rendersearchpage.md)

SearchAndOpenRecords

يحدث الحدث عند استدعاء واجهة برمجة تطبيقات JavaScript لإطار تكامل القناة المقابلة من موفر القناة للبحث عن السجل من موفر القناة أثناء الاتصال الوارد وفتح السجل. يتم أيضا تمرير البيانات التي تم تمريرها في واجهة برمجة التطبيقات إلى تطبيق عميل Unified Service Desk.

المعلمة وصف
كيان الاسم المنطقي للكيان للبحث والفتح.
queryParmeters خيارات استعلام نظام OData ، $select و $expand ، لاسترداد بياناتك.
  • استخدم خيار استعلام نظام $select للحد من الخصائص التي تم إرجاعها عن طريق تضمين قائمة مفصولة بفواصل. هذه ممارسة مهمة لأفضل الأداء. إذا لم يتم تحديد الخصائص باستخدام $select، إرجاع جميع الخصائص.
  • استخدم خيار استعلام نظام $expand للتحكم في البيانات من الكيانات ذات الصلة التي يتم إرجاعها. إذا قمت فقط بتضمين اسم خاصية التنقل، فستتلقى جميع الخصائص للسجلات ذات الصلة. يمكنك تقييد الخصائص التي تم إرجاعها للسجلات ذات الصلة باستخدام خيار استعلام نظام $select بين قوسين بعد اسم خاصية التنقل. استخدم هذا لكل من خصائص التنقل أحادية القيمة وذات قيمة المجموعة.
يمكنك تحديد خيارات الاستعلام بدءا من ?. يمكنك أيضا تحديد خيارات استعلام متعددة باستخدام & لفصل خيارات الاستعلام.
على سبيل المثال: ?$select=name&$expand=primarycontactid($select=contactid,fullname)
searchOnly تعيين false لفتح السجل في صفحة الواجهة الموحدة إذا كان سجل البحث عبارة عن سجل واحد. قم بتعيين false لفتح صفحة البحث إذا كانت نتيجة البحث تحتوي على سجلات متعددة وقم بملء صفحة البحث تلقائيا بقيمة العلامة المذكورة عند استخدام حقل البحث في queryParmeters.

قم بتعيين true فقط للحصول على نتائج البحث كنتيجة وعد وعدم فتح السجل أو صفحة البحث.
معرف المعرف الفريد لحدث SearchAndOpenRecords الذي تم إثارته.

(راجع أيضًا )