executeEvent (การอ้างอิง Client API) (ตัวอย่าง)

สําคัญ

• นี่คือคุณลักษณะพรีวิว
• คุณลักษณะพรีวิวไม่ได้มีไว้สำหรับการนำไปใช้งานจริง และอาจมีการจำกัดฟังก์ชันการทำงาน คุณลักษณะเหล่านี้อยู่ภายใต้ ข้อกำหนดการใช้งานเพิ่มเติม และสามารถใช้ได้ก่อนการเผยแพร่อย่างเป็นทางการเพื่อให้ลูกค้าสามารถเข้าถึงล่วงหน้าและแสดงความคิดเห็น

ใช้หัวข้อ Microsoft Copilot Studio ที่ยึดตามชื่อเหตุการณ์ที่ลงทะเบียนไว้ แสดงอาร์เรย์ชนิด MCSResponse

ไวยากรณ์

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

พารามิเตอร์

ชื่อพารามิเตอร์	ประเภท	ต้องมี	คำอธิบาย
eventName	สตริง	ได้	ชื่อเหตุการณ์ที่ลงทะเบียนในหัวข้อ Microsoft Copilot Studio
eventParameters	ไม่รู้จัก	ได้	พารามิเตอร์ที่จําเป็นสําหรับการดําเนินการเหตุการณ์ สิ่งเหล่านี้ขึ้นอยู่กับสิ่งที่หัวข้อทํา
successCallback	ฟังก์ชัน	ได้	ฟังก์ชันที่จะเรียกใช้เมื่อการดําเนินการสําเร็จ
errorCallback	ฟังก์ชัน	ได้	ฟังก์ชันที่จะเรียกใช้เมื่อการดําเนินการล้มเหลว

ค่าส่งกลับ

อาร์เรย์ของ MCSResponse

การเข้าถึงบริบทของแอป

เมื่อมีการเรียกใช้ API ตัวแทน บริบทสําหรับแอปจะถูกส่งผ่านไปยังหัวข้อ Copilot Studio ผ่านชุดของตัวแปร ต่อไปนี้เป็นตัวแปรบริบทที่สามารถใช้งานเป็นตัวแปรส่วนกลางของ Copilot Studio

ตัวแปร	คำอธิบาย
Global.PA__Copilot_Model_PageContext.pageContext.id.guid	ID ของเรกคอร์ดตารางบนฟอร์มหลัก
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

ภายในหัวข้อ eventParameters Copilot Studio คุณสามารถเข้าถึง จากการเรียกใช้ API ได้โดยใช้ตัวแปรActivity.Value ใช้ โหนดค่าการแยกวิเคราะห์ เพื่อแปลง JSON ลงในระเบียนที่มีเขตข้อมูลอย่างน้อยหนึ่งรายการ การเลือก จากข้อมูลตัวอย่าง สําหรับ ชนิดข้อมูล อนุญาตให้มีตัวอย่าง JSON เพื่อสร้างระเบียน

ตัวอย่าง

ใน Microsoft Copilot Studio ที่มีการลงทะเบียนหัวข้อที่ยอมรับ ID (รหัสเรกคอร์ดเอนทิตี) เป็นพารามิเตอร์การป้อนข้อมูล โดยยึดตามข้อมูลป้อนเข้า จะเรียกใช้กิจกรรมที่เกี่ยวข้องของบันทึกเอนทิตีนั้นและส่งกลับผลลัพธ์เป็นกิจกรรม Copilot Studio

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

การตอบสนอง

[
    {
        "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 (การอ้างอิง API ไคลเอ็นต์)