CallAgent interface

Paket:

@azure/communication-calling

CallAgent används för att hantera anrop.

Extends

CallAgentCommon

Egenskaper

calls	Hämta samtalen.
displayName	Hämta visningsnamnet för den lokala deltagaren för alla nya anrop.

Ärvda egenskaper

connectionState	Hämta anslutningstillståndet.
kind	Hämta typen av samtalsagentobjekt.

Metoder

join(GroupCallLocator, JoinCallOptions)	Anslut till ett gruppsamtal. Om du vill ansluta till ett gruppsamtal skickar du ett groupId.
join(GroupChatCallLocator, JoinCallOptions)	Gå med i ett gruppchattsamtal. Om du vill ansluta till ett gruppchattsamtal skickar du ett threadId.
join(MeetingLocator, JoinCallOptions)	Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk eller möteskoordinater.
join(RoomCallLocator, JoinCallOptions)	Gå med i ett rumssamtal. Om du vill ansluta till ett rumssamtal skickar du ett roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du ett mötes-ID och lösenord.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Avprenumerationsfunktionen för anropDaterad händelse.
off("connectionStateChanged", ConnectionStateChangedEvent)	Avsluta prenumerationsfunktionen för connectionStateChanged-händelsen.
off("incomingCall", IncomingCallEvent)	Avsluta prenumerationsfunktionen för inkommandeCall-händelse.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Funktionen Prenumerera för anropDaterad händelse.
on("connectionStateChanged", ConnectionStateChangedEvent)	Funktionen Prenumerera för connectionStateChanged-händelsen.
on("incomingCall", IncomingCallEvent)	Prenumerationsfunktion för incomingCall-händelse.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Initiera ett anrop till de angivna deltagarna.
startCall(CommunicationIdentifier[], StartCallOptions)	Initiera ett anrop till de angivna deltagarna.

Ärvda metoder

dispose()	Kassera den här samtalsagenten
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Hämtar ett initierat och pmiserat funktionsobjekt med utökat API. Kontrollera objektfunktionerna.* för alla tillgängliga funktioner för utökade samtalsagenter i det här paketet.
handlePushNotification(IncomingCallPushNotificationData)	Hanterar ett push-meddelande.

Egenskapsinformation

calls

Hämta samtalen.

calls: readonly Call[]

Egenskapsvärde

readonly Call[]

displayName

Hämta visningsnamnet för den lokala deltagaren för alla nya anrop.

displayName?: string

Egenskapsvärde

string

Information om ärvda egenskaper

connectionState

Hämta anslutningstillståndet.

connectionState: ConnectionState

Egenskapsvärde

ConnectionState

Ärvd frånCallAgentCommon.connectionState

kind

Hämta typen av samtalsagentobjekt.

kind: CallAgentKind

Egenskapsvärde

CallAgentKind

Ärvd frånCallAgentCommon.kind

Metodinformation

join(GroupCallLocator, JoinCallOptions)

Anslut till ett gruppsamtal. Om du vill ansluta till ett gruppsamtal skickar du ett groupId.

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

Parametrar

groupLocator

GroupCallLocator

Information om gruppsamtal.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

join(GroupChatCallLocator, JoinCallOptions)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Gå med i ett gruppchattsamtal. Om du vill ansluta till ett gruppchattsamtal skickar du ett threadId.

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

Parametrar

groupChatCallLocator

GroupChatCallLocator

GroupChat-samtalsinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

join(MeetingLocator, JoinCallOptions)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk eller möteskoordinater.

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

Parametrar

meetingLocator

MeetingLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

join(RoomCallLocator, JoinCallOptions)

Gå med i ett rumssamtal. Om du vill ansluta till ett rumssamtal skickar du ett roomId.

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

Parametrar

roomLocator

RoomCallLocator

Information om rumssamtal.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

join(TeamsMeetingIdLocator, JoinCallOptions)

Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du ett mötes-ID och lösenord.

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

Parametrar

meetingLocator

TeamsMeetingIdLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Delta i ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk.

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

Parametrar

meetingLocator

TeamsMeetingLinkLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

Call

Anropa-objektet som är associerat med anropet.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Avprenumerationsfunktionen för anropDaterad händelse.

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

Parametrar

event

"callsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<Call>

callback fn som användes för att prenumerera på den här händelsen.

off("connectionStateChanged", ConnectionStateChangedEvent)

Avsluta prenumerationsfunktionen för connectionStateChanged-händelsen.

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

Parametrar

event

"connectionStateChanged"

händelsenamn.

listener

ConnectionStateChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

off("incomingCall", IncomingCallEvent)

Avsluta prenumerationsfunktionen för inkommandeCall-händelse.

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

Parametrar

event

"incomingCall"

händelsenamn.

listener

IncomingCallEvent

callback fn som användes för att prenumerera på den här händelsen.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Funktionen Prenumerera för anropDaterad händelse.

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

Parametrar

event

"callsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<Call>

callback fn som kommer att anropas när den här samlingen ändras skickas matriser med tillagda och borttagna element.

on("connectionStateChanged", ConnectionStateChangedEvent)

Funktionen Prenumerera för connectionStateChanged-händelsen.

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

Parametrar

event

"connectionStateChanged"

händelsenamn.

listener

ConnectionStateChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("incomingCall", IncomingCallEvent)

Prenumerationsfunktion för incomingCall-händelse.

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

Parametrar

event

"incomingCall"

händelsenamn.

listener

IncomingCallEvent

callback fn som anropas när det här samtaletAgent tar emot ett inkommande samtal.

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

Initiera ett anrop till de angivna deltagarna.

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

Parametrar

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Starta samtalsalternativ.

Returer

Call

Anropa-objektet som är associerat med det startade anropet.

startCall(CommunicationIdentifier[], StartCallOptions)

Initiera ett anrop till de angivna deltagarna.

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

Parametrar

participants

CommunicationIdentifier[]

options

StartCallOptions

Starta samtalsalternativ.

Returer

Call

Anropa-objektet som är associerat med det startade anropet.

Ärvd metodinformation

dispose()

Kassera den här samtalsagenten

function dispose(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Hämtar ett initierat och pmiserat funktionsobjekt med utökat API. Kontrollera objektfunktionerna.* för alla tillgängliga funktioner för utökade samtalsagenter i det här paketet.

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

Parametrar

factory

CallAgentFeatureFactory<TFeature>

Fabriken för funktionskonstruktorn för anropsagenten som tillhandahåller ett utökat API.

Returer

TFeature

Ärvd frånCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Hanterar ett push-meddelande.

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

Parametrar

data

IncomingCallPushNotificationData

Push-meddelandedata

Returer

Promise<void>

Ärvd frånCallAgentCommon.handlePushNotification