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

مهم

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

تنفيذ موضوع Microsoft Copilot Studio استنادا إلى اسم الحدث المسجل. إرجاع صفيف من نوع MCSResponse.

بناء الجملة

Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

المعلمات

اسم المعلمة	نوع	مطلوبة	‏‏الوصف
eventName	string	‏‏نعم‬	اسم الحدث المسجل في موضوع Microsoft Copilot Studio
eventParameters	Unknown	‏‏نعم‬	المعلمات المطلوبة لتنفيذ الحدث. تعتمد هذه على ما يفعله الموضوع.
successCallback	الوظيفة	‏‏نعم‬	وظيفة للاتصال عند نجاح العملية.
errorCallback	الوظيفة	‏‏نعم‬	وظيفة للاتصال عند فشل العملية.

قيمة الإرجاع

صفيف MCSResponse

الوصول إلى سياق التطبيق

عند استدعاء واجهة برمجة تطبيقات عامل، يتم تمرير سياق التطبيق إلى موضوع Copilot Studio من خلال مجموعة من المتغيرات. فيما يلي متغيرات السياق المتوفرة كمتغيرات عمومية ل Copilot Studio.

المتغير	‏‏الوصف
Global.PA__Copilot_Model_PageContext.pageContext.id.guid	معرف سجل الجدول في النموذج الرئيسي
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName	الاسم المنطقي للجدول في الصفحة الرئيسية
Global.PA__Copilot_Model_PageContext.pageContext.pageName	اسم الصفحة الرئيسية
Global.PA__Copilot_Model_PageContext.pageContext.pageType	نوع الصفحة الرئيسية
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName	اسم فريد للتطبيق المستند إلى النموذج

على سبيل المثال، باستخدام Global.PA__Copilot_Model_PageContext.pageContext.id.guid و Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName، يمكن استرداد سجل النموذج من Dataverse.

الوصول إلى EventParameters

ضمن موضوع Copilot Studio، eventParameters يمكن الوصول إلى من استدعاء واجهة برمجة التطبيقات باستخدام المتغير Activity.Value. استخدم عقدة قيمة التحليل لتحويل JSON إلى سجل به حقل واحد أو أكثر. يتيح تحديد من نموذج البياناتلنوع البيانات توفير مثال JSON لإنشاء السجل.

مثال

في Microsoft Copilot Studio، حيث يتم تسجيل موضوع يقبل معرف (معرف سجل الكيان) كمعلمة إدخال. استنادا إلى الإدخال، فإنه يسترد الأنشطة ذات الصلة لسجل الكيان هذا ويعيد النتائج كنشاق حدث Copilot Studio.

const response = await Xrm.Copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"}); 

Response

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

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

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