Comparteix via

executeEvent (referència de l'API del client) (versió preliminar)

Important

  • Aquesta és una característica de visualització prèvia.
  • Les característiques en versió preliminar no estan dissenyades per a un entorn de producció i poden tenir una funcionalitat restringida. Aquestes funcions estan subjectes a condicions d'ús addicionals i estan disponibles abans d'un llançament oficial perquè els clients puguin obtenir accés anticipat i proporcionar comentaris.

Executa un tema del Microsoft Copilot Studio basat en el nom de l'esdeveniment registrat. Retorna una matriu de tipus MCSResponse.

Sintaxi

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

Paràmetres

Nom del paràmetre Type Necessari Descripció
eventName cadena Sí Nom de l'esdeveniment registrat al tema del Microsoft Copilot Studio
eventParameters Desconegut Sí Paràmetres necessaris per a l'execució de l'esdeveniment. Aquests depenen del que faci el tema.
successCallback Function Sí Una funció per cridar quan l'operació té èxit.
errorCallback Function Sí Una funció per cridar quan l'operació falla.

Valor de retorn

Una matriu de MCSResponse

Accés al context de l'aplicació

Quan es crida a una API d'agent, el context de l'aplicació es passa al tema de Copilot Studio mitjançant un conjunt de variables. A continuació es mostren variables de context disponibles com a variables globals de Copilot Studio.

Variable Descripció
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID del registre de taula al formulari principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nom lògic de la taula a la pàgina principal
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nom de la pàgina principal
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipus de pàgina principal
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nom únic de l'aplicació basada en models

Per exemple, utilitzant Global.PA__Copilot_Model_PageContext.pageContext.id.guid i Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, el registre del formulari es pot recuperar del Dataverse.

Accés a eventParameters

Dins del tema Copilot Studio, es pot accedir a la eventParameters crida des de l'API mitjançant la variable Activity.Value. Utilitzeu el node de valor d'Analitza per convertir el JSON en un registre amb un o més camps. Si seleccioneu Des de dades d'exemple per a Tipus de dades , es permet proporcionar un exemple JSON per crear el registre.

Exemple

Al Microsoft Copilot Studio, on es registra un tema que accepta un identificador (identificador de registre d'entitat) com a paràmetre d'entrada. En funció de l'entrada, recupera les activitats relacionades d'aquest registre d'entitat i retorna els resultats com a activitat d'esdeveniment del 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 (Referència de l'API del client)

  • Last updated on