Dalintis per


executeEvent (kliento API nuoroda) (peržiūra)

Svarbu

  • Tai yra peržiūros versijos funkcija.
  • Peržiūros versijos funkcijos nėra skirtos naudoti gamybai ir gali būti apribotas jų funkcionalumas. Šioms funkcijoms taikomos papildomos naudojimo sąlygos ir jos pasiekiamos prieš oficialų leidimą, kad klientai galėtų gauti išankstinę prieigą ir pateikti atsiliepimus.

Vykdo "Microsoft Copilot Studio" temą pagal registruotą įvykio pavadinimą. Grąžina MCSResponse tipo masyvą.

Sintaksė

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

Parametrai

Parametro pavadinimas Tipas Privalomas Aprašą
eventName eilutė Taip "Microsoft Copilot Studio" temoje užregistruotas įvykio pavadinimas
eventParameters Nežinoma Taip Parametrai, reikalingi įvykiui vykdyti. Jie priklauso nuo to, ką daro tema.
successCallback Funkcija Taip Funkcija, kurią reikia iškviesti, kai operacija sėkminga.
errorCallback Funkcija Taip Funkcija, kurią reikia iškviesti, kai operacija nepavyksta.

Grąžinimo reikšmė

MCSResponse masyvas

Prieiga prie taikomosios programos konteksto

Iškvietus agento API, programos kontekstas perduodamas į "Copilot Studio" temą per kintamųjų rinkinį. Toliau pateikiami kontekstiniai kintamieji, galimi kaip "Copilot Studio" visuotiniai kintamieji.

Kintamasis Aprašą
Global.PA__Copilot_Model_PageContext.pageContext.id.guid Pagrindinės formos lentelės įrašo ID
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Pagrindinio puslapio lentelės loginis pavadinimas
Global.PA__Copilot_Model_PageContext.pageContext.pageName Pagrindinio puslapio pavadinimas
Global.PA__Copilot_Model_PageContext.pageContext.pageType Pagrindinio puslapio tipas
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Unikalus modeliu pagrįstos programėlės pavadinimas

Pavyzdžiui, naudojant Global.PA__Copilot_Model_PageContext.pageContext.id.guid ir Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, formos įrašą galima gauti iš "Dataverse".

Prieiga prie eventParameters

"Copilot Studio" temoje API iškvietimą eventParameters galima pasiekti naudojant kintamąjį Activity.Value. Naudokite analizės reikšmių mazgą , kad konvertuotumėte JSON į įrašą su vienu ar daugiau laukų. Pasirinkus Iš duomenų tipopavyzdžių, galima pateikti JSON pavyzdį įrašui sukurti.

Pavyzdžiui

"Microsoft Copilot Studio", kur užregistruota tema, kuri priima ID (objekto įrašo ID) kaip įvesties parametrą. Atsižvelgiant į įvestį, ji nuskaito susijusią to objekto įrašo veiklą ir pateikia rezultatus kaip "Copilot Studio" įvykio veiklą.

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

Atsakas

[
    {
        "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 (kliento API nuoroda)