Zdieľať cez

executeEvent (odkaz na klientske rozhranie API) (ukážka)

Dôležité

  • Toto je ukážková funkcia.
  • Funkcie verzie Preview nie sú určené na produkčné účely a môžu mať obmedzenú funkčnosť. Tieto funkcie podliehajú doplnkovým podmienkam používaniaa sú k dispozícii pred oficiálnym vydaním, aby k nim zákazníci mali skorý prístup a mohli poskytnúť spätnú väzbu.

Spustí tému microsoft Copilot Studio založenú na registrovanom názve udalosti. Vráti pole typu MCSResponse.

Syntax

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

Parametre

Názov parametra Typ Požaduje sa Popis
eventName reťazec Áno Názov udalosti zaregistrovaný v téme pre Microsoft Copilot Studio
eventParameters Neznámy Áno Parametre potrebné na vykonanie udalosti. Závisí to od toho, čo téma robí.
successCallback Function Áno Funkcia, ktorá sa volá po úspešnej operácii.
errorCallback Function Áno Funkcia, ktorá sa volá v prípade zlyhania operácie.

Vrátená hodnota

Pole hodnoty MCSResponse

Prístup k kontextu aplikácie

Pri volaní rozhrania Agent API sa kontext pre aplikáciu odovzdá téme Copilot Studio prostredníctvom množiny premenných. Nižšie sú uvedené kontextové premenné, ktoré sú k dispozícii ako globálne premenné aplikácie Copilot Studio.

Premenná Popis
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID záznamu tabuľky v hlavnom formulári
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logický názov tabuľky na hlavnej stránke
Global.PA__Copilot_Model_PageContext.pageContext.pageName Názov hlavnej stránky
Global.PA__Copilot_Model_PageContext.pageContext.pageType Typ hlavnej stránky
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Jedinečný názov aplikácie riadenej modelom

Napríklad pomocou Global.PA__Copilot_Model_PageContext.pageContext.id.guid a Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNamemožno záznam formulára načítať z dataverse.

Prístup k udalostiParameters

V téme eventParameters Aplikácie Copilot Studio je možné získať prístup z volania rozhrania API pomocou premennej Activity.Value. Ak chcete skonvertovať kód JSON na záznam s jedným alebo viacerými poľami, použite uzol hodnoty Analyzovať . Ak vyberiete možnosť Zo vzorového údajov pre položku Typ údajov , poskytne sa príklad JSON na vytvorenie záznamu.

Príklad

V aplikácii Microsoft Copilot Studio, kde je zaregistrovaná téma, ktorá prijíma ID (ID záznamu entity) ako vstupný parameter. Na základe vstupu sa načítajú súvisiace aktivity daného záznamu entity a vráti výsledky ako aktivitu udalosti 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 (odkaz na klientske rozhranie API)

  • Last updated on