TeamsCallAgent interface

Paket:

@azure/communication-calling

TeamsCallAgent digunakan untuk menangani panggilan Teams.

Extends

CallAgentCommon

Properti

calls

Dapatkan panggilan.

Properti yang Diwariskan

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

Metode

join(MeetingLocator, JoinCallOptions)	Bergabung dalam rapat Teams. Untuk bergabung dalam rapat Teams, lewati tautan rapat atau id rapat atau koordinat rapat.
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<TeamsCall>)	Berhenti berlangganan fungsi untuk peristiwa callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Berhenti berlangganan fungsi untuk peristiwa incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Berlangganan fungsi untuk peristiwa callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Berlangganan fungsi untuk peristiwa connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Berlangganan fungsi untuk peristiwa incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Mulai panggilan 1:N.
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Mulai panggilan 1:1.

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(PushNotificationData)	Menangani pemberitahuan push.

Detail Properti

calls

Dapatkan panggilan.

calls: ReadonlyArray<TeamsCall>

Nilai Properti

ReadonlyArray<TeamsCall>

Detail Properti yang Diwariskan

connectionState

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.

Dapatkan status koneksi.

connectionState: ConnectionState

Nilai Properti

ConnectionState

Diwarisi DariCallAgentCommon.connectionState

kind

Dapatkan jenis objek agen panggilan.

kind: CallAgentKind

Nilai Properti

CallAgentKind

Diwarisi DariCallAgentCommon.kind

Detail Metode

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, lewati tautan rapat atau id rapat atau koordinat rapat.

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

Parameter

meetingLocator

MeetingLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan Teams.

Mengembalikan

TeamsCall

Objek TeamsCall 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): TeamsCall

Parameter

meetingLocator

TeamsMeetingIdLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

TeamsCall

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): TeamsCall

Parameter

meetingLocator

TeamsMeetingLinkLocator

Informasi rapat.

options

JoinCallOptions

Opsi mulai panggilan.

Mengembalikan

TeamsCall

Objek Panggilan yang terkait dengan panggilan.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Berhenti berlangganan fungsi untuk peristiwa callsUpdated.

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

Parameter

event

"callsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn yang digunakan untuk berlangganan kejadian ini.

off("connectionStateChanged", ConnectionStateChangedEvent)

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.

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", TeamsIncomingCallEvent)

Berhenti berlangganan fungsi untuk peristiwa incomingCall.

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

Parameter

event

"incomingCall"

nama peristiwa.

listener

TeamsIncomingCallEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Berlangganan fungsi untuk peristiwa callsUpdated.

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

Parameter

event

"callsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<TeamsCall>

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

on("connectionStateChanged", ConnectionStateChangedEvent)

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.

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", TeamsIncomingCallEvent)

Berlangganan fungsi untuk peristiwa incomingCall.

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

Parameter

event

"incomingCall"

nama peristiwa.

listener

TeamsIncomingCallEvent

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

startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)

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.

Mulai panggilan 1:N.

function startCall(participants: (PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartTeamsGroupCallOptions): TeamsCall

Parameter

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Mengembalikan

TeamsCall

Objek TeamsCall yang terkait dengan panggilan.

startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)

Mulai panggilan 1:1.

function startCall(participant: MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: StartTeamsCallOptions): TeamsCall

Parameter

participant

MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Mengembalikan

TeamsCall

Objek TeamsCall yang terkait dengan panggilan.

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

Diwarisi dariCallAgentCommon.feature

handlePushNotification(PushNotificationData)

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: PushNotificationData): Promise<void>

Parameter

data

PushNotificationData

Data pemberitahuan push

Mengembalikan

Promise<void>

Diwarisi DariCallAgentCommon.handlePushNotification