addActionHandler (referencia de api de cliente)

Registra una función de controlador personalizada para una acción de Microsoft 365 Copilot.

Syntax

Xrm.Copilot.addActionHandler(actionId, actionHandler).then(successCallback, errorCallback);

Parámetros

Nombre de parámetro	Tipo	Obligatorio	Descripción
actionId	string	Sí	Identificador único de la acción que se va a controlar.
actionHandler	Function	Sí	Función que se va a invocar cuando se desencadena la acción. Recibe la carga de datos de la acción como argumento.
successCallback	Function	Sí	Una función para llamar a la operación es correcta.
errorCallback	Function	Sí	Una función a la que se llama cuando la operación tiene error.

Valor devuelto

Tipo: Promise<void>

Remarks

Puede registrar varios controladores para el mismo actionId. Se ejecutan secuencialmente. La API omite silenciosamente el registro de la misma referencia de función dos veces para el mismo actionId. La API no hace nada si Microsoft 365 Copilot no está habilitado.

Identificadores de acción integrados

Los siguientes identificadores de acción tienen controladores predeterminados de plataforma registrados automáticamente. Puede agregar controladores personalizados junto con ellos o quitar primero los controladores predeterminados mediante removeDefaultActionHandlers.

Id. de la acción	Descripción	Propiedades de datos
MS.PA.CopilotChat.OpenRecord	Abre un registro.	entity (string) — nombre lógico de la tabla; recordId (string) — id. de registro
MS.PA.CopilotChat.NavigateToView	Navega a una vista.	entity (string) — nombre lógico de la tabla; fetchXml (string): consulta FetchXML

Example

const handler = async ({ entity, recordId }) => {
    // Open the record in a side pane instead of navigating away
    const pane = Xrm.App.sidePanes.createPane({ canClose: true });
    await pane.navigate({ pageType: "entityrecord", entityName: entity, entityId: recordId });
};

await Xrm.Copilot.addActionHandler("My.Namespace.MyActionMessage", handler);

Artículos relacionados

Método removeActionHandler
Xrm.Copilot (referencia de la API cliente)