Megosztás:

executeEvent (ügyfél API-referencia) (előzetes verzió)

Fontos

  • Ez egy előzetes verziójú funkció.
  • Az előzetes funkciókat nem célszerű termelési környezetben használni, és előfordulhat, hogy korlátozott funkcionalitással rendelkeznek. Ezekre a funkciókra kiegészítő használati feltételek vonatkoznak, és a hivatalos kiadás előtt érhetők el, hogy az ügyfelek korai hozzáférést kaphassanak, és visszajelzést adhassanak.

Végrehajt egy Microsoft Copilot Studio-témakört a regisztrált eseménynév alapján. McSResponse típusú tömböt ad vissza.

Szemantika

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

Paraméterek

Paraméter neve Típus Kötelező Description
eventName karakterlánc Igen A Microsoft Copilot Studio témakörében regisztrált eseménynév
eventParameters Ismeretlen Igen Az esemény végrehajtásához szükséges paraméterek. Ezek attól függenek, hogy mit tesz a témakör.
successCallback Funkció Igen A művelet sikeres végrehajtása esetén meghívandó függvény.
errorCallback Funkció Igen A művelet sikertelensége esetén meghívandó függvény.

Visszaadott érték

AZ MCSResponse tömbje

Alkalmazáskörnyezet elérése

Ügynök API meghívása esetén az alkalmazás környezete változók halmazán keresztül továbbítja a Copilot Studio témakörének. Az alábbiakban globális változóként Copilot Studio elérhető környezeti változók találhatók.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid A táblarekord azonosítója a főűrlapon
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName A főoldalon lévő tábla logikai neve
Global.PA__Copilot_Model_PageContext.pageContext.pageName A főoldal neve
Global.PA__Copilot_Model_PageContext.pageContext.pageType A főoldal típusa
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName A modellvezérelt alkalmazás egyedi neve

Az űrlap rekordjának használata Global.PA__Copilot_Model_PageContext.pageContext.id.guid és Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNamehasználata például lekérhető a Dataverse-ből.

EventParameters elérése

A Copilot Studio témakörében az eventParameters API-hívásból származó hívás a változóval Activity.Valueérhető el. Az Elemzés értékcsomóponttal átalakíthatja a JSON-t egy vagy több mezővel rendelkező rekordmá. Az Adattípusmintaadataiból lehetőség kiválasztásával JSON-példát adhat meg a rekord létrehozásához.

Example

A Microsoft Copilot Studióban egy olyan témakör van regisztrálva, amely egy azonosítót (entitásrekord-azonosítót) fogad el bemeneti paraméterként. A bemenet alapján lekéri az entitásrekord kapcsolódó tevékenységeit, és copilot Studio-eseménytevékenységként adja vissza az eredményeket.

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

Válasz

[
    {
        "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 (Ügyfél API-referencia)

  • Last updated on