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
Xrm.Copilot (חומר עזר עבור API של לקוח)