Partilhar via

executeEvent (visualização)

Importante

  • Este é um recurso de visualização.
  • As funcionalidades de pré-visualização não se destinam a utilização em produção e podem ter funcionalidades restritas. Esses recursos estão sujeitos a termos de uso suplementares e estão disponíveis antes de um lançamento oficial para que os clientes possam obter acesso antecipado e fornecer feedback.

Executa um tópico do Microsoft Copilot Studio com base no Nome do Evento registrado. Retorna uma matriz do tipo MCSResponse.

Disponível para

Aplicações condicionadas por modelo

Sintaxe

context.copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Parâmetros

Nome do parâmetro Tipo Obrigatório Description
eventName cadeia (de caracteres) Yes Nome do evento registrado no tópico Copilot Studio
eventParameters Desconhecido Yes Parâmetros necessários para a execução do evento. Estes dependem do que o tópico faz.
successCallback Função Yes Uma função a ser chamada quando a operação for bem-sucedida.
errorCallback Função Yes Uma função para chamar quando a operação falhar.

Valor de retorno

Tipo: Promise<MCSResponse>

Veja Promise e MCSResponse

Aceder ao contexto da aplicação

Quando uma API de agente é chamada, o contexto do aplicativo é passado para o tópico do Copilot Studio por meio de um conjunto de variáveis. Seguem-se as variáveis de contexto disponíveis como Variáveis globais do Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid O ID do registo da tabela no formulário principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName O nome lógico da tabela na página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageName O nome da página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageType O tipo da página principal
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName O nome exclusivo da aplicação condicionada por modelo

Por exemplo, usando Global.PA__Copilot_Model_PageContext.pageContext.id.guid e Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, o registro do formulário pode ser recuperado do Dataverse.

Acessando eventParameters

Dentro do tópico Copilot Studio, a eventParameters chamada da API pode ser acessada usando a variável Activity.Value. Use o nó do valor de análise para converter o JSON em um registro com um ou mais campos. Selecionar De dados de exemplo para Tipo de dados permite fornecer um exemplo JSON para criar o registro.

Example

No Microsoft Copilot Studio, onde é registrado um tópico que aceita uma ID (ID de registro de entidade) como um parâmetro de entrada. Com base na entrada, ele recupera as atividades relacionadas desse registro de entidade e retorna os resultados como uma atividade de evento do Copilot Studio. A API de contexto PCF permite a execução desses métodos dentro do contexto de controles PCF.

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

Resposta

[
    {
        "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"
    }
]

Copilot
executePrompt
Referência da API da estrutura do componente Power Apps
Visão geral da estrutura do componente Power Apps

  • Last updated on