addActionHandler (مرجع واجهة برمجة تطبيقات العميل)

تسجيل دالة معالج مخصص لإجراء Microsoft 365 Copilot.

إعراب

Xrm.Copilot.addActionHandler(actionId, actionHandler).then(successCallback, errorCallback);

Parameters

اسم المعلمة	النوع	مطلوب	الوصف
actionId	سلسلة نصية	‏‏نعم‬	المعرف الفريد للإجراء الذي يجب معالجته.
actionHandler	الدالة	‏‏نعم‬	الدالة التي يجب استدعاؤها عند تشغيل الإجراء. يتلقى حمولة بيانات الإجراء كوسيطة.
successCallback	الدالة	‏‏نعم‬	وظيفة للاتصال عند نجاح العملية.
errorCallback	الدالة	‏‏نعم‬	وظيفة للاتصال عند فشل العملية.

القيمة المرجعة

نوع: Promise<void>

الملاحظات

يمكنك تسجيل معالجات متعددة لنفس actionId. يتم تشغيلها بشكل تسلسلي. تتجاهل واجهة برمجة التطبيقات بصمت تسجيل نفس مرجع الدالة مرتين لنفس actionId. لا تفعل واجهة برمجة التطبيقات أي شيء إذا لم يتم تمكين Microsoft 365 Copilot.

معرفات الإجراءات المضمنة

تحتوي معرفات الإجراء التالية على معالجات افتراضية للنظام الأساسي مسجلة تلقائيا. يمكنك إضافة معالجات مخصصة إلى جانبها، أو إزالة المعالجات الافتراضية أولا باستخدام removeDefaultActionHandlers.

معرف الإجراء	الوصف	خصائص البيانات
MS.PA.CopilotChat.OpenRecord	فتح سجل.	entity (سلسلة) — اسم منطقي للجدول؛ recordId (سلسلة) — معرف السجل
MS.PA.CopilotChat.NavigateToView	الانتقال إلى طريقة عرض.	entity (سلسلة) — اسم منطقي للجدول؛ fetchXml (سلسلة) — استعلام FetchXML

مثال

const handler = async ({ entity, recordId }) => {
    // Open the record in a side pane instead of navigating away
    const pane = Xrm.App.sidePanes.createPane({ canClose: true });
    await pane.navigate({ pageType: "entityrecord", entityName: entity, entityId: recordId });
};

await Xrm.Copilot.addActionHandler("My.Namespace.MyActionMessage", handler);

المقالات ذات الصلة

إزالة أسلوبActionHandler
Xrm.Copilot (مرجع واجهة برمجة تطبيقات العميل)