getCurrentAgent (חומר עזר עבור API של לקוח)

הפונקציה מחזירה את רשימת סוכן Copilot הפעילה כעת, או לא מוגדרת אם מצב הסוכן עדיין לא ידוע.

תחביר

Xrm.Copilot.getCurrentAgent().then(successCallback, errorCallback);

פרמטרים

שם פרמטר	סוג	חובה	תיאור
successCallback	פונקציה	‏‏כן‬	פונקציה שיש לקרוא לה כאשר הפעולה מצליחה.
errorCallback	פונקציה	‏‏כן‬	פונקציה שיש לקרוא לה כאשר הפעולה נכשלת.

ערך החזרה

Type: Promise<M365CopilotAgent | undefined> — פותר לאובייקט M365CopilotAgent המתאר את הסוכן הפעיל, undefined או אם מצב הסוכן עדיין לא נקבע.

הערות

לא עושה Microsoft Copilot אם אפשרות זו אינה זמינה.

האובייקט המוחזר והמאפיינים agentIdmode שלו מקושרים:

• agentId היא מחרוזת שאינה Null ו- mode is "agentPage" או "mentioned": סוכן פעיל.
• agentIdis null וmode- nullהוא : המשתמש נמצא על קו Microsoft Copilot (אין סוכן פעיל).

לדוגמה

const agent = await Xrm.Copilot.getCurrentAgent();
if (agent && agent.agentId) {
    console.log(`Active agent: ${agent.agentId}, mode: ${agent.mode}`);
} else if (agent) {
    console.log("User is on mainline M365 Copilot (no agent).");
} else {
    console.log("Agent state not yet determined.");
}

מאמרים קשורים

ממשק M365CopilotAgent
Xrm.Copilot (חומר עזר עבור API של לקוח)