CallAgent interface

الحزمة:

@azure/communication-calling

يتم استخدام CallAgent لمعالجة المكالمات.

يمتد

CallAgentCommon

الخصائص

calls	احصل على المكالمات.
displayName	احصل على اسم العرض للمشارك المحلي لجميع المكالمات الجديدة.

الخصائص الموروثة

connectionState	الحصول على حالة الاتصال.
kind	الحصول على نوع كائن عامل الاستدعاء.

الأساليب

join(GroupCallLocator, JoinCallOptions)	الانضمام إلى مكالمة جماعية. للانضمام إلى مكالمة جماعية، مرر groupId.
join(GroupChatCallLocator, JoinCallOptions)	الانضمام إلى مكالمة دردشة جماعية. للانضمام إلى مكالمة دردشة جماعية، مرر threadId.
join(MeetingLocator, JoinCallOptions)	الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، قم بتمرير ارتباط اجتماع أو إحداثيات اجتماع.
join(RoomCallLocator, JoinCallOptions)	الانضمام إلى مكالمة الغرف. للانضمام إلى مكالمة غرف، مرر roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، مرر معرف الاجتماع ورمز المرور.
join(TeamsMeetingLinkLocator, JoinCallOptions)	الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، قم بتمرير ارتباط اجتماع.
off("callsUpdated", CollectionUpdatedEvent<Call>)	دالة إلغاء الاشتراك لحدث تم تحديث الاستدعاءات.
off("connectionStateChanged", ConnectionStateChangedEvent)	دالة إلغاء الاشتراك لحدث connectionStateChanged.
off("incomingCall", IncomingCallEvent)	قم بإلغاء اشتراك الدالة لحدث incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	قم بالاشتراك في دالة لحدث callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	قم بالاشتراك في دالة حدث connectionStateChanged.
on("incomingCall", IncomingCallEvent)	قم بالاشتراك في دالة حدث incomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	بدء مكالمة إلى المشاركين المقدمين.
startCall(CommunicationIdentifier[], StartCallOptions)	بدء مكالمة إلى المشاركين المقدمين.

الأساليب المتوارثة

dispose()	التخلص من عامل الاتصال هذا
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	استرداد كائن ميزة تمت تهيئته ومذكرته باستخدام واجهة برمجة تطبيقات موسعة. تحقق من ميزات الكائن.* لجميع ميزات عامل الاتصال الموسعة المتوفرة في هذه الحزمة.
handlePushNotification(IncomingCallPushNotificationData)	يعالج إعلاما دفعيا.

تفاصيل الخاصية

calls

احصل على المكالمات.

calls: readonly Call[]

قيمة الخاصية

readonly Call[]

displayName

احصل على اسم العرض للمشارك المحلي لجميع المكالمات الجديدة.

displayName?: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

connectionState

الحصول على حالة الاتصال.

connectionState: ConnectionState

قيمة الخاصية

ConnectionState

موروث منCallAgentCommon.connectionState

kind

الحصول على نوع كائن عامل الاستدعاء.

kind: CallAgentKind

قيمة الخاصية

CallAgentKind

موروث منCallAgentCommon.kind

تفاصيل الأسلوب

join(GroupCallLocator, JoinCallOptions)

الانضمام إلى مكالمة جماعية. للانضمام إلى مكالمة جماعية، مرر groupId.

function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call

المعلمات

groupLocator

GroupCallLocator

معلومات مكالمة المجموعة.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

join(GroupChatCallLocator, JoinCallOptions)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

الانضمام إلى مكالمة دردشة جماعية. للانضمام إلى مكالمة دردشة جماعية، مرر threadId.

function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call

المعلمات

groupChatCallLocator

GroupChatCallLocator

معلومات مكالمة GroupChat.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

join(MeetingLocator, JoinCallOptions)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، قم بتمرير ارتباط اجتماع أو إحداثيات اجتماع.

function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): Call

المعلمات

meetingLocator

MeetingLocator

معلومات الاجتماع.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

join(RoomCallLocator, JoinCallOptions)

الانضمام إلى مكالمة الغرف. للانضمام إلى مكالمة غرف، مرر roomId.

function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call

المعلمات

roomLocator

RoomCallLocator

معلومات مكالمة الغرفة.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

join(TeamsMeetingIdLocator, JoinCallOptions)

الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، مرر معرف الاجتماع ورمز المرور.

function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): Call

المعلمات

meetingLocator

TeamsMeetingIdLocator

معلومات الاجتماع.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

join(TeamsMeetingLinkLocator, JoinCallOptions)

الانضمام إلى اجتماع Teams. للانضمام إلى اجتماع Teams، قم بتمرير ارتباط اجتماع.

function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): Call

المعلمات

meetingLocator

TeamsMeetingLinkLocator

معلومات الاجتماع.

options

JoinCallOptions

خيارات بدء الاتصال.

المرتجعات

Call

كائن Call المقترن بالمكالمة.

off("callsUpdated", CollectionUpdatedEvent<Call>)

دالة إلغاء الاشتراك لحدث تم تحديث الاستدعاءات.

function off(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)

المعلمات

event

"callsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<Call>

fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث.

off("connectionStateChanged", ConnectionStateChangedEvent)

دالة إلغاء الاشتراك لحدث connectionStateChanged.

function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

المعلمات

event

"connectionStateChanged"

اسم الحدث.

listener

ConnectionStateChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

off("incomingCall", IncomingCallEvent)

قم بإلغاء اشتراك الدالة لحدث incomingCall.

function off(event: "incomingCall", listener: IncomingCallEvent)

المعلمات

event

"incomingCall"

اسم الحدث.

listener

IncomingCallEvent

fn رد الاتصال الذي تم استخدامه للاشتراك في هذا الحدث.

on("callsUpdated", CollectionUpdatedEvent<Call>)

قم بالاشتراك في دالة لحدث callsUpdated.

function on(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)

المعلمات

event

"callsUpdated"

اسم الحدث.

listener

CollectionUpdatedEvent<Call>

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير هذه المجموعة، سيمرر صفائف من العناصر المضافة والمزالة.

on("connectionStateChanged", ConnectionStateChangedEvent)

قم بالاشتراك في دالة حدث connectionStateChanged.

function on(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

المعلمات

event

"connectionStateChanged"

اسم الحدث.

listener

ConnectionStateChangedEvent

fn رد الاتصال الذي سيتم استدعاؤه عند تغيير قيمة هذه الخاصية.

on("incomingCall", IncomingCallEvent)

قم بالاشتراك في دالة حدث incomingCall.

function on(event: "incomingCall", listener: IncomingCallEvent)

المعلمات

event

"incomingCall"

اسم الحدث.

listener

IncomingCallEvent

fn رد الاتصال الذي سيتم استدعاؤه عندما يتلقى callAgent هذا مكالمة واردة.

startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

بدء مكالمة إلى المشاركين المقدمين.

function startCall(participants: (PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call

المعلمات

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

بدء تشغيل خيارات المكالمة.

المرتجعات

Call

كائن الاتصال المقترن باستدعاء البدء.

startCall(CommunicationIdentifier[], StartCallOptions)

بدء مكالمة إلى المشاركين المقدمين.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call

المعلمات

participants

CommunicationIdentifier[]

options

StartCallOptions

بدء تشغيل خيارات المكالمة.

المرتجعات

Call

كائن الاتصال المقترن باستدعاء البدء.

تفاصيل الأساليب المتوارثة

dispose()

التخلص من عامل الاتصال هذا

function dispose(): Promise<void>

المرتجعات

Promise<void>

موروث منCallAgentCommon.dispos

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

استرداد كائن ميزة تمت تهيئته ومذكرته باستخدام واجهة برمجة تطبيقات موسعة. تحقق من ميزات الكائن.* لجميع ميزات عامل الاتصال الموسعة المتوفرة في هذه الحزمة.

function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature

المعلمات

factory

CallAgentFeatureFactory<TFeature>

مصنع منشئ ميزة عامل الاستدعاء الذي يوفر واجهة برمجة تطبيقات موسعة.

المرتجعات

TFeature

موروث منCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

ملاحظة

واجهة برمجة التطبيقات (API) هذا موجود في الإصدار بيتا ويتوفر كمعاينة للمطورين وقد يتغير بناءً على الملاحظات التي نستلمها. تجنب استخدام API هذه في بيئة الإنتاج.

يعالج إعلاما دفعيا.

function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>

المعلمات

data

IncomingCallPushNotificationData

دفع بيانات الإعلام

المرتجعات

Promise<void>

موروث منCallAgentCommon.handlePushNotification