Споделяне чрез


executeEvent (препратка към API на клиент) (предварителен преглед)

Важно

  • Това е функция за предварителен преглед.
  • Функциите на етап преглед не са предназначени за производствена употреба и може да са с ограничени възможности. Тези функции са предмет на допълнителни условия за ползване и са налични преди официалното издание, така че клиентите да могат да получат ранен достъп и да предоставят обратна връзка.

Изпълнява тема на Microsoft Copilot Studio, базирана на регистрираното име на събитие. Връща масив от тип MCSResponse.

Синтаксис

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

Параметри

Име на параметъра Тип Необходимо Описание
eventName низ Да Име на събитие, регистрирано в темата на Microsoft Copilot Studio
eventParameters Неизвестен Да Параметри, необходими за изпълнението на събитието. Те зависят от това, което прави темата.
successCallback Function Да Функция, която да извика, когато операцията е успешна.
errorCallback Function Да Функция, която да се извика, когато операцията е неуспешна.

Връщана стойност

Масив от MCSResponse

Достъп до контекста на приложението

Когато се извика API на агент, контекстът за приложението се подава към темата Copilot Studio чрез набор от променливи. По-долу са дадени контекстни променливи, налични като Copilot Studio глобални променливи.

Променлива Описание
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ИД на записа на таблицата в основния формуляр
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Логическо име на таблицата в главната страница
Global.PA__Copilot_Model_PageContext.pageContext.pageName Име на главната страница
Global.PA__Copilot_Model_PageContext.pageContext.pageType Тип на главната страница
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Уникално име на приложението, управлявано от модел

Например използването Global.PA__Copilot_Model_PageContext.pageContext.id.guid и Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, записът на формуляра може да бъде извлечен от Dataverse.

Достъп до събитиеПараметри

В темата Copilot Studio от повикването eventParameters на API може да бъде достъпен с помощта на променливата Activity.Value. Използвайте възела на анализираната стойност , за да преобразувате JSON в запис с едно или повече полета. Избирането на От примерни данни за тип данни позволява създаването на JSON пример.

Пример

В Microsoft Copilot Studio, където е регистрирана тема, която приема ИД (ИД на запис на обект) като входен параметър. Въз основа на входните данни извлича свързаните дейности на този запис на обект и връща резултатите като дейност на събитието 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 (препратка към API на клиент)