addActionHandler (довідник з API клієнта)

Реєструє спеціальну функцію обробника для дії Microsoft 365 Copilot.

Синтаксис

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

Параметри

Ім’я параметра	Тип	Обов’язково	Опис
actionId	рядок	Так	Унікальний ідентифікатор дії, яка обробляється.
actionHandler	Функція	Так	Функція, яка викликається під час запуску дії. Отримує корисне навантаження на дані дії як аргумент.
successCallback	Функція	Так	Функція для виклику в разі успіху операції.
errorCallback	Функція	Так	Функція для виклику, коли операція не вдається.

Значення для повернення

Тип: Promise<void>

Примітки

Для одного й того самого actionIdобробника можна зареєструвати кілька обробників. Вони працюють послідовно. API мовчки ігнорує реєстрацію тієї ж функції посилання двічі для того ж actionId. API нічого не робить, якщо Microsoft 365 Copilot не ввімкнуто.

Вбудовані ідентифікатори дій

У наведених нижче діях ідентифікатори мають обробники платформи за замовчуванням, зареєстровані автоматично. Ви можете додати настроювані обробники разом із ними або спочатку видалити обробники за замовчуванням, використовуючи removeDefaultActionHandlers.

Ідентифікатор дії	Опис	Властивості даних
MS.PA.CopilotChat.OpenRecord	Відкриття запису.	entity (рядок) – логічне ім'я таблиці; recordId (рядок) – ідентифікатор запису
MS.PA.CopilotChat.NavigateToView	Перехід до подання.	entity (рядок) – логічне ім'я таблиці; fetchXml (рядок) – запит FetchXML

Приклад

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);

Пов’язані статті

removeActionHandler method
Xrm.Copilot (довідник з API клієнта)