addActionHandler (Клиент API сілтемесі)

Microsoft 365 Copilot әрекеті үшін арнайы басқарушы функциясын тіркейді.

Синтаксис

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

Параметрлер

Параметр атауы Түр Қажетті Сипаттама
actionId жол Иә Әрекеттің бірегей идентификаторы.
actionHandler Функция Иә Әрекет іске қосылғанда шақыру функциясы. Әрекеттің деректер жүктемесін аргумент ретінде қабылдайды.
successCallback Функция Иә Операция табысқа жеткенде қоңырау шалуға арналған функция.
errorCallback Функция Иә Операция істен шыққанда қоңырау шалу функциясы.

Қайтару мәні

Раа Promise<void>

Ескертпелер

Бірдей actionIdүшін бірнеше хендлерді тіркеуге болады. Олар ретімен жүреді. API бірдей функция сілтемесін екі рет actionIdтіркеуді үнсіз елемейді. Егер Microsoft 365 Copilot қосулы болмаса, API ештеңе істемейді.

Кіріктірілген әрекет идентификаторлары

Төмендегі әрекет идентификаторларында платформадағы әдепкі эшкәртушілер автоматты түрде тіркеледі. Олармен бірге арнайы эшкәртушілерді қосуға болады немесе алдымен 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 әдісі
Xrm.Copilot (Клиент API анықтамасы)