重要
- 这是一项预览功能。
- 预览功能不适用于生产用途，并且可能具有受限功能。 这些功能受 补充使用条款的约束，在正式发布之前提供，以便客户能够提前访问并提供反馈。
根据已注册的事件名称执行 Microsoft Copilot Studio 主题。 返回 MCSResponse 类型的数组。
Syntax
Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);
参数
| 参数名称 | 类型 | 必选 | Description |
|---|---|---|---|
eventName |
字符串 | 是的 | 在 Microsoft Copilot Studio 主题中注册的事件名称 |
eventParameters |
未知 | 是的 | 事件执行所需的参数。 这些取决于主题的作用。 |
successCallback |
功能 | 是的 | 作成功时要调用的函数。 |
errorCallback |
功能 | 是的 | 作失败时要调用的函数。 |
返回值
MCSResponse 数组
访问应用上下文
调用代理 API 时，应用的上下文将通过一组变量传递到 Copilot Studio 主题。 以下是作为 Copilot Studio 全局变量提供的上下文变量。
| Variable | Description |
|---|---|
Global.PA__Copilot_Model_PageContext.pageContext.id.guid |
主窗体上表记录的 ID |
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 检索表单的记录。
访问 eventParameters
在 Copilot Studio 主题中， eventParameters 可以使用变量 Activity.Value访问 API 调用。 使用 分析值节点 将 JSON 转换为包含一个或多个字段的记录。 从数据类型的示例数据中进行选择，可提供 JSON 示例来创建记录。
Example
在 Microsoft Copilot Studio 中，其中注册了接受 ID（实体记录 ID）作为输入参数的主题。 根据输入，它会检索该实体记录的相关活动，并将结果作为 Copilot Studio 事件活动返回。
const response = await Xrm.Copilot.executeEvent(
"Microsoft.PowerApps.Copilot.RelatedActivities",
{ id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"});
响应
[
{
"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"
}
]