TeamsCallAgent interface

Paket:

@azure/communication-calling

TeamsCallAgent används för att hantera Teams-anrop.

Extends

CallAgentCommon

Egenskaper

calls

Hämta anropen.

Ärvda egenskaper

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

Metoder

join(MeetingLocator, JoinCallOptions)	Anslut till ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk eller mötes-ID eller möteskoordinater.
join(TeamsMeetingIdLocator, JoinCallOptions)	Anslut till 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)	Anslut till ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Funktionen Avbryt prenumeration för anropUppdateringshändelse.
off("connectionStateChanged", ConnectionStateChangedEvent)	Funktionen Avbryt prenumeration för connectionStateChanged-händelsen.
off("incomingCall", TeamsIncomingCallEvent)	Funktionen Avbryt prenumeration för incomingCall-händelsen.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Prenumerationsfunktion för callsUpdated-händelse.
on("connectionStateChanged", ConnectionStateChangedEvent)	Funktionen Subscribe för connectionStateChanged-händelsen.
on("incomingCall", TeamsIncomingCallEvent)	Funktionen Subscribe för incomingCall-händelsen.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Starta ett 1:N-samtal.
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Starta 1:1-samtalet.

Ärvda metoder

dispose()	Ta bort 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(PushNotificationData)	Hanterar ett push-meddelande.

Egenskapsinformation

calls

Hämta anropen.

calls: ReadonlyArray<TeamsCall>

Egenskapsvärde

ReadonlyArray<TeamsCall>

Information om ärvda egenskaper

connectionState

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ämta anslutningstillståndet.

connectionState: ConnectionState

Egenskapsvärde

ConnectionState

Ärvd frånCallAgentCommon.connectionState

kind

Hämta typen av anropsagentobjekt.

kind: CallAgentKind

Egenskapsvärde

CallAgentKind

Ärvd frånCallAgentCommon.kind

Metodinformation

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ö.

Anslut till ett Teams-möte. Om du vill ansluta till ett Teams-möte skickar du en möteslänk eller mötes-ID eller möteskoordinater.

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

Parametrar

meetingLocator

MeetingLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för Teams-samtal.

Returer

TeamsCall

TeamsCall-objektet som är associerat med anropet.

join(TeamsMeetingIdLocator, JoinCallOptions)

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

Parametrar

meetingLocator

TeamsMeetingIdLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

TeamsCall

Anropsobjektet som är associerat med anropet.

join(TeamsMeetingLinkLocator, JoinCallOptions)

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

Parametrar

meetingLocator

TeamsMeetingLinkLocator

Mötesinformation.

options

JoinCallOptions

Startalternativ för samtal.

Returer

TeamsCall

Anropsobjektet som är associerat med anropet.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Funktionen Avbryt prenumeration för anropUppdateringshändelse.

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

Parametrar

event

"callsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<TeamsCall>

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

off("connectionStateChanged", ConnectionStateChangedEvent)

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ö.

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

Funktionen Avbryt prenumeration för incomingCall-händelsen.

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

Parametrar

event

"incomingCall"

händelsenamn.

listener

TeamsIncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Prenumerationsfunktion för callsUpdated-händelse.

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

Parametrar

event

"callsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<TeamsCall>

motringning fn som anropas när den här samlingen kommer att ändras, kommer den att skicka matriser med tillagda och borttagna element.

on("connectionStateChanged", ConnectionStateChangedEvent)

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ö.

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

Funktionen Subscribe för incomingCall-händelsen.

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

Parametrar

event

"incomingCall"

händelsenamn.

listener

TeamsIncomingCallEvent

callback fn som anropas när denna callAgent tar emot ett inkommande samtal.

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

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ö.

Starta ett 1:N-samtal.

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

Parametrar

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Returer

TeamsCall

TeamsCall-objektet som är associerat med anropet.

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

Starta 1:1-samtalet.

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

Parametrar

participant

MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Returer

TeamsCall

TeamsCall-objektet som är associerat med anropet.

Ärvd metodinformation

dispose()

Ta bort 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(PushNotificationData)

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

Parametrar

data

PushNotificationData

Push-meddelandedata

Returer

Promise<void>

Ärvd frånCallAgentCommon.handlePushNotification