Kongsi melalui

executeEvent (rujukan API Klien) (pratonton)

Penting

  • Ini adalah ciri pratonton.
  • Ciri pratonton bukan untuk kegunaan pengeluaran dan mungkin mempunyai kefungsian yang terbatas. Ciri-ciri ini tertakluk kepada syarat penggunaan tambahan, dan tersedia sebelum keluaran rasmi supaya pelanggan boleh mendapatkan akses awal dan memberikan maklum balas.

Melaksanakan topik Microsoft Copilot Studio berdasarkan Nama Acara yang didaftarkan. Mengembalikan tatasusunan jenis MCSResponse.

Sintaks

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

Parameter

Nama Parameter Jenis Wajib Penerangan
eventName rentetan Ya Nama Acara yang didaftarkan dalam topik Microsoft Copilot Studio
eventParameters Unknown Ya Parameter yang diperlukan untuk pelaksanaan acara. Ini bergantung pada apa yang dilakukan oleh topik itu.
successCallback Function Ya Fungsi untuk memanggil apabila operasi berjaya.
errorCallback Function Ya Fungsi untuk memanggil apabila operasi gagal.

Nilai Pulangan

Pelbagai MCSResponse

Mengakses konteks apl

Apabila API Ejen dipanggil, konteks untuk apl dihantar kepada topik Copilot Studio melalui satu set pembolehubah. Berikut ialah pembolehubah konteks yang tersedia sebagai pembolehubah global Copilot Studio.

Pemboleh ubah Penerangan
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID rekod jadual pada borang utama
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nama logik jadual di halaman utama
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nama halaman utama
Global.PA__Copilot_Model_PageContext.pageContext.pageType Jenis halaman utama
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nama unik apl dipacu model

Contohnya, menggunakan Global.PA__Copilot_Model_PageContext.pageContext.id.guid dan Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, rekod borang boleh diambil daripada Dataverse.

Mengakses eventParameters

Dalam topik Copilot Studio, eventParameters daripada panggilan API boleh diakses menggunakan pembolehubah Activity.Value. Gunakan nod nilai Parse untuk menukar JSON kepada rekod dengan satu atau lebih medan. Memilih Daripada data sampel untuk Jenis Data membolehkan menyediakan contoh JSON untuk mencipta rekod.

Contoh

Dalam Microsoft Copilot Studio, di mana topik didaftarkan yang menerima ID (ID rekod entiti) sebagai parameter input. Berdasarkan input, ia mendapatkan semula aktiviti berkaitan rekod entiti itu dan mengembalikan hasil sebagai aktiviti acara 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 (Rujukan API Pelanggan)

  • Last updated on