CallAgent interface

Paket:

@azure/communication-calling

CallAgent digunakan untuk menangani panggilan.

Memperluas

CallAgentCommon

Properti

calls	Dapatkan panggilan.
displayName	Dapatkan nama tampilan peserta lokal untuk semua panggilan baru.

Properti yang Diwariskan

connectionState	Dapatkan status koneksi.
kind	Dapatkan jenis objek agen panggilan.

Metode

join(GroupCallLocator, JoinCallOptions)	Bergabung dalam panggilan grup. Untuk bergabung dengan panggilan grup, lewati groupId.
join(GroupChatCallLocator, JoinCallOptions)	Bergabunglah dengan panggilan obrolan grup. Untuk bergabung dengan panggilan obrolan grup, lewati threadId.
join(MeetingLocator, JoinCallOptions)	Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, berikan tautan rapat atau koordinat rapat.
join(RoomCallLocator, JoinCallOptions)	Bergabunglah dengan panggilan ruang. Untuk bergabung dengan panggilan kamar, berikan roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, berikan id rapat dan kode akses.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, lewati tautan rapat.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Berhenti berlangganan fungsi untuk peristiwa callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Berhenti berlangganan fungsi untuk peristiwa IncomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Berlangganan fungsi untuk peristiwa callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Berlangganan fungsi untuk peristiwa connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Berlangganan fungsi untuk peristiwa IncomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Mulai panggilan ke peserta yang disediakan.
startCall(CommunicationIdentifier[], StartCallOptions)	Mulai panggilan ke peserta yang disediakan.

Metode yang Diwarisi

dispose()	Buang Agen Panggilan ini
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Mengambil objek Fitur yang diinisialisasi dan memoisasi dengan API yang diperluas. Periksa fitur objek.* untuk semua fitur agen panggilan yang diperluas yang tersedia dalam paket ini.
handlePushNotification(IncomingCallPushNotificationData)	Menangani pemberitahuan push.

Detail Properti

calls

Dapatkan panggilan.

calls: readonly Call[]

Nilai Properti

readonly Call[]

displayName

Dapatkan nama tampilan peserta lokal untuk semua panggilan baru.

displayName?: string

Nilai Properti

string

Detail Properti yang Diwariskan

connectionState

Dapatkan status koneksi.

connectionState: ConnectionState

Nilai Properti

ConnectionState

Diwariskan DariCallAgentCommon.connectionState

kind

Dapatkan jenis objek agen panggilan.

kind: CallAgentKind

Nilai Properti

CallAgentKind

Diwariskan DariCallAgentCommon.kind

Detail Metode

join(GroupCallLocator, JoinCallOptions)

Bergabung dalam panggilan grup. Untuk bergabung dengan panggilan grup, lewati groupId.

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

Parameter

groupLocator

GroupCallLocator

Informasi panggilan grup.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

join(GroupChatCallLocator, JoinCallOptions)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Bergabunglah dengan panggilan obrolan grup. Untuk bergabung dengan panggilan obrolan grup, lewati threadId.

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

Parameter

groupChatCallLocator

GroupChatCallLocator

Informasi panggilan GroupChat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

join(MeetingLocator, JoinCallOptions)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, berikan tautan rapat atau koordinat rapat.

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

Parameter

meetingLocator

MeetingLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

join(RoomCallLocator, JoinCallOptions)

Bergabunglah dengan panggilan ruang. Untuk bergabung dengan panggilan kamar, berikan roomId.

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

Parameter

roomLocator

RoomCallLocator

Informasi panggilan kamar.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

join(TeamsMeetingIdLocator, JoinCallOptions)

Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, berikan id rapat dan kode akses.

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

Parameter

meetingLocator

TeamsMeetingIdLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, lewati tautan rapat.

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

Parameter

meetingLocator

TeamsMeetingLinkLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Berhenti berlangganan fungsi untuk peristiwa callsUpdated.

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

Parameter

event

"callsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<Call>

callback fn yang digunakan untuk berlangganan kejadian ini.

off("connectionStateChanged", ConnectionStateChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa connectionStateChanged.

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

Parameter

event

"connectionStateChanged"

nama peristiwa.

listener

ConnectionStateChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

off("incomingCall", IncomingCallEvent)

Berhenti berlangganan fungsi untuk peristiwa IncomingCall.

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

Parameter

event

"incomingCall"

nama peristiwa.

listener

IncomingCallEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Berlangganan fungsi untuk peristiwa callsUpdated.

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

Parameter

event

"callsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<Call>

callback fn yang akan dipanggil ketika koleksi ini akan berubah, itu akan melewati array elemen yang ditambahkan dan dihapus.

on("connectionStateChanged", ConnectionStateChangedEvent)

Berlangganan fungsi untuk peristiwa connectionStateChanged.

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

Parameter

event

"connectionStateChanged"

nama peristiwa.

listener

ConnectionStateChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

on("incomingCall", IncomingCallEvent)

Berlangganan fungsi untuk peristiwa IncomingCall.

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

Parameter

event

"incomingCall"

nama peristiwa.

listener

IncomingCallEvent

callback fn yang akan dipanggil ketika callAgent ini akan menerima panggilan masuk.

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

Mulai panggilan ke peserta yang disediakan.

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

Parameter

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Mulai opsi Panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan mulai.

startCall(CommunicationIdentifier[], StartCallOptions)

Mulai panggilan ke peserta yang disediakan.

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

Parameter

participants

CommunicationIdentifier[]

options

StartCallOptions

Mulai opsi Panggilan.

Mengembalikan

Call

Objek Panggilan yang terkait dengan panggilan mulai.

Detail Metode yang Diwarisi

dispose()

Buang Agen Panggilan ini

function dispose(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Mengambil objek Fitur yang diinisialisasi dan memoisasi dengan API yang diperluas. Periksa fitur objek.* untuk semua fitur agen panggilan yang diperluas yang tersedia dalam paket ini.

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

Parameter

factory

CallAgentFeatureFactory<TFeature>

Pabrik untuk konstruktor fitur agen panggilan yang menyediakan API yang diperluas.

Mengembalikan

TFeature

Diwariskan Dari fitur CallAgentCommon.

handlePushNotification(IncomingCallPushNotificationData)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Menangani pemberitahuan push.

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

Parameter

data

IncomingCallPushNotificationData

Data pemberitahuan push

Mengembalikan

Promise<void>

Diwarisi DariCallAgentCommon.handlePushNotification