CallAgent interface

Paket:

@azure/communication-calling

CallAgent, çağrıları işlemek için kullanılır.

Extends

CallAgentCommon

Özellikler

calls	Aramaları al.
displayName	Tüm yeni çağrılar için yerel katılımcının görünen adını alın.

Devralınan Özellikler

connectionState	Bağlantı durumunu alın.
kind	Çağrı aracısı nesnesinin türünü alın.

Yöntemler

join(GroupCallLocator, JoinCallOptions)	Bir grup çağrısına katılın. Bir grup çağrısına katılmak için bir groupId geçirin.
join(GroupChatCallLocator, JoinCallOptions)	Bir grup sohbeti çağrısına katılın. Bir grup sohbeti çağrısına katılmak için threadId geçirin.
join(MeetingLocator, JoinCallOptions)	Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı bağlantısı veya toplantı koordinatları geçirin.
join(RoomCallLocator, JoinCallOptions)	Oda aramalarına katılın. Odalar çağrısına katılmak için bir roomId geçirin.
join(TeamsMeetingIdLocator, JoinCallOptions)	Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı kimliği ve geçiş kodu geçirin.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı bağlantısı geçirin.
off("callsUpdated", CollectionUpdatedEvent<Call>)	CallsUpdated olayı için abonelikten çıkma işlevi.
off("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged olayı için abonelikten çıkma işlevi.
off("incomingCall", IncomingCallEvent)	incomingCall olayı için abonelikten çıkma işlevi.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Çağrılar için Subscribe işleviGüncelleştirme olayı.
on("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged olayı için Subscribe işlevi.
on("incomingCall", IncomingCallEvent)	incomingCall olayı için Subscribe işlevi.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Sağlanan katılımcılara bir çağrı başlatın.
startCall(CommunicationIdentifier[], StartCallOptions)	Sağlanan katılımcılara bir çağrı başlatın.

Devralınan Yöntemler

dispose()	Bu Çağrı Aracısını at
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Genişletilmiş API ile başlatılan ve notlaştırılmış bir Özellik nesnesi alır. Bu paketteki tüm kullanılabilir genişletilmiş çağrı aracısı özellikleri için Features.* nesnesini denetleyin.
handlePushNotification(IncomingCallPushNotificationData)	Anında iletme bildirimini işler.

Özellik Ayrıntıları

calls

Aramaları al.

calls: readonly Call[]

Özellik Değeri

readonly Call[]

displayName

Tüm yeni çağrılar için yerel katılımcının görünen adını alın.

displayName?: string

Özellik Değeri

string

Devralınan Özellik Detayları

connectionState

Bağlantı durumunu alın.

connectionState: ConnectionState

Özellik Değeri

ConnectionState

CallAgentCommon.connectionState'dan Devralınan

kind

Çağrı aracısı nesnesinin türünü alın.

kind: CallAgentKind

Özellik Değeri

CallAgentKind

CallAgentCommon.kind Devralınan

Yöntem Ayrıntıları

join(GroupCallLocator, JoinCallOptions)

Bir grup çağrısına katılın. Bir grup çağrısına katılmak için bir groupId geçirin.

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

Parametreler

groupLocator

GroupCallLocator

Arama bilgilerini gruplandırma.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

join(GroupChatCallLocator, JoinCallOptions)

Not

Bu API, Beta sürümünde ve geliştiriciler için önizleme olarak sunulmuş durumda; alacağımız geri bildirimler doğrultusunda değiştirilebilir. Bu API’yi üretim ortamında kullanmayın.

Bir grup sohbeti çağrısına katılın. Bir grup sohbeti çağrısına katılmak için threadId geçirin.

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

Parametreler

groupChatCallLocator

GroupChatCallLocator

GroupChat arama bilgileri.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

join(MeetingLocator, JoinCallOptions)

Not

Bu API, Beta sürümünde ve geliştiriciler için önizleme olarak sunulmuş durumda; alacağımız geri bildirimler doğrultusunda değiştirilebilir. Bu API’yi üretim ortamında kullanmayın.

Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı bağlantısı veya toplantı koordinatları geçirin.

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

Parametreler

meetingLocator

MeetingLocator

Toplantı bilgileri.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

join(RoomCallLocator, JoinCallOptions)

Oda aramalarına katılın. Odalar çağrısına katılmak için bir roomId geçirin.

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

Parametreler

roomLocator

RoomCallLocator

Oda arama bilgileri.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

join(TeamsMeetingIdLocator, JoinCallOptions)

Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı kimliği ve geçiş kodu geçirin.

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

Parametreler

meetingLocator

TeamsMeetingIdLocator

Toplantı bilgileri.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Teams toplantısına katılın. Teams toplantısına katılmak için bir toplantı bağlantısı geçirin.

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

Parametreler

meetingLocator

TeamsMeetingLinkLocator

Toplantı bilgileri.

options

JoinCallOptions

Arama başlangıç seçenekleri.

Döndürülenler

Call

Çağrıyla ilişkili Call nesnesi.

off("callsUpdated", CollectionUpdatedEvent<Call>)

CallsUpdated olayı için abonelikten çıkma işlevi.

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

Parametreler

event

"callsUpdated"

olay adı.

listener

CollectionUpdatedEvent<Call>

bu olaya abone olmak için kullanılan geri çağırma fn.

off("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged olayı için abonelikten çıkma işlevi.

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

Parametreler

event

"connectionStateChanged"

olay adı.

listener

ConnectionStateChangedEvent

bu özelliğin değeri değiştiğinde çağrılacak geri çağırma fn.

off("incomingCall", IncomingCallEvent)

incomingCall olayı için abonelikten çıkma işlevi.

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

Parametreler

event

"incomingCall"

olay adı.

listener

IncomingCallEvent

bu olaya abone olmak için kullanılan geri çağırma fn.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Çağrılar için Subscribe işleviGüncelleştirme olayı.

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

Parametreler

event

"callsUpdated"

olay adı.

listener

CollectionUpdatedEvent<Call>

bu koleksiyon değiştiğinde çağrılacak geri çağırma fn, eklenen ve kaldırılan öğelerin dizilerini geçirir.

on("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged olayı için Subscribe işlevi.

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

Parametreler

event

"connectionStateChanged"

olay adı.

listener

ConnectionStateChangedEvent

bu özelliğin değeri değiştiğinde çağrılacak geri çağırma fn.

on("incomingCall", IncomingCallEvent)

incomingCall olayı için Subscribe işlevi.

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

Parametreler

event

"incomingCall"

olay adı.

listener

IncomingCallEvent

bu callAgent gelen bir çağrı aldığında çağrılacak geri çağırma fn.

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

Sağlanan katılımcılara bir çağrı başlatın.

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

Parametreler

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Arama seçeneklerini başlatın.

Döndürülenler

Call

Başlatılan çağrıyla ilişkili Call nesnesi.

startCall(CommunicationIdentifier[], StartCallOptions)

Sağlanan katılımcılara bir çağrı başlatın.

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

Parametreler

participants

CommunicationIdentifier[]

options

StartCallOptions

Arama seçeneklerini başlatın.

Döndürülenler

Call

Başlatılan çağrıyla ilişkili Call nesnesi.

Devralınan Yöntemin Ayrıntıları

dispose()

Bu Çağrı Aracısını at

function dispose(): Promise<void>

Döndürülenler

Promise<void>

CallAgentCommon.dispose'dan Devralınmış

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Not

Bu API, Beta sürümünde ve geliştiriciler için önizleme olarak sunulmuş durumda; alacağımız geri bildirimler doğrultusunda değiştirilebilir. Bu API’yi üretim ortamında kullanmayın.

Genişletilmiş API ile başlatılan ve notlaştırılmış bir Özellik nesnesi alır. Bu paketteki tüm kullanılabilir genişletilmiş çağrı aracısı özellikleri için Features.* nesnesini denetleyin.

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

Parametreler

factory

CallAgentFeatureFactory<TFeature>

Genişletilmiş API sağlayan çağrı aracısı özellik oluşturucusunun fabrikası.

Döndürülenler

TFeature

CallAgentCommon.feature'dan Devralınmış

handlePushNotification(IncomingCallPushNotificationData)

Not

Bu API, Beta sürümünde ve geliştiriciler için önizleme olarak sunulmuş durumda; alacağımız geri bildirimler doğrultusunda değiştirilebilir. Bu API’yi üretim ortamında kullanmayın.

Anında iletme bildirimini işler.

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

Parametreler

data

IncomingCallPushNotificationData

Anında iletme bildirimi verileri

Döndürülenler

Promise<void>

CallAgentCommon.handlePushNotificationDevralındı