getCurrentAgent (مرجع واجهة برمجة تطبيقات العميل)

إرجاع عامل Copilot Microsoft 365 النشطة حاليا، أو غير معرفة إذا لم تكن حالة العامل معروفة بعد.

إعراب

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

Parameters

اسم المعلمة النوع مطلوب الوصف
successCallback الدالة ‏‏نعم‬ وظيفة للاتصال عند نجاح العملية.
errorCallback الدالة ‏‏نعم‬ وظيفة للاتصال عند فشل العملية.

القيمة المرجعة

النوع: Promise<M365CopilotAgent | undefined> — يتم الحل إلى كائن M365CopilotAgent الذي يصف العامل النشط، أو undefined إذا لم يتم تحديد حالة العامل بعد.

الملاحظات

لا يفعل أي شيء إذا لم يتم تمكين Microsoft 365 Copilot.

يتم إقران خصائص و mode للكائن agentId الذي تم إرجاعه:

  • agentId هي سلسلة غير خالية وهي mode"agentPage" أو "mentioned": عامل نشط.
  • agentId هو nullmodenull: المستخدم على Microsoft 365 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 (مرجع واجهة برمجة تطبيقات العميل)