TeamsCallAgent interface

Paquet:

@azure/communication-calling

TeamsCallAgent est utilisé pour gérer les appels Teams.

Extends

CallAgentCommon

Propriétés

calls

Obtenez les appels.

Propriétés héritées

connectionState	Obtenez l’état de connexion.
kind	Obtenez le type d’objet de l’agent d’appel.

Méthodes

join(MeetingLocator, JoinCallOptions)	Participez à une réunion Teams. Pour participer à une réunion Teams, transmettez un lien de réunion ou un ID de réunion ou des coordonnées de réunion.
join(TeamsMeetingIdLocator, JoinCallOptions)	Participez à une réunion Teams. Pour participer à une réunion Teams, passez un ID de réunion et un code secret.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Participez à une réunion Teams. Pour participer à une réunion Teams, passez un lien de réunion.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Fonction de désabonnement pour l’événement callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Fonction de désabonnement pour l’événement connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Fonction De désabonnement pour l’événement incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Fonction d’abonnement pour l’événement callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Fonction Subscribe pour l’événement connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Fonction d’abonnement pour l’événement incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Démarrez un appel 1 :N.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Démarrez l’appel 1:1.

Méthodes héritées

dispose()	Supprimer cet agent d’appel
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Vérifiez les fonctionnalités de l’objet Features.* pour toutes les fonctionnalités de l’agent d’appel étendu disponibles dans ce package.
handlePushNotification(IncomingCallPushNotificationData)	Gère une notification Push.

Détails de la propriété

calls

Obtenez les appels.

calls: readonly TeamsCall[]

Valeur de propriété

readonly TeamsCall[]

Détails de la propriété héritée

connectionState

Obtenez l’état de connexion.

connectionState: ConnectionState

Valeur de propriété

ConnectionState

héritée deCallAgentCommon.connectionState

kind

Obtenez le type d’objet de l’agent d’appel.

kind: CallAgentKind

Valeur de propriété

CallAgentKind

héritée deCallAgentCommon.kind

Détails de la méthode

join(MeetingLocator, JoinCallOptions)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Participez à une réunion Teams. Pour participer à une réunion Teams, transmettez un lien de réunion ou un ID de réunion ou des coordonnées de réunion.

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

Paramètres

meetingLocator

MeetingLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage des appels Teams.

Retours

TeamsCall

Objet TeamsCall associé à l’appel.

join(TeamsMeetingIdLocator, JoinCallOptions)

Participez à une réunion Teams. Pour participer à une réunion Teams, passez un ID de réunion et un code secret.

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

Paramètres

meetingLocator

TeamsMeetingIdLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

TeamsCall

Objet Call associé à l’appel.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Participez à une réunion Teams. Pour participer à une réunion Teams, passez un lien de réunion.

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

Paramètres

meetingLocator

TeamsMeetingLinkLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

TeamsCall

Objet Call associé à l’appel.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Fonction de désabonnement pour l’événement callsUpdated.

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

Paramètres

event

"callsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn utilisé pour s’abonner à cet événement.

off("connectionStateChanged", ConnectionStateChangedEvent)

Fonction de désabonnement pour l’événement connectionStateChanged.

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

Paramètres

event

"connectionStateChanged"

nom de l’événement.

listener

ConnectionStateChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

off("incomingCall", TeamsIncomingCallEvent)

Fonction De désabonnement pour l’événement incomingCall.

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

Paramètres

event

"incomingCall"

nom de l’événement.

listener

TeamsIncomingCallEvent

rappel fn utilisé pour s’abonner à cet événement.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Fonction d’abonnement pour l’événement callsUpdated.

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

Paramètres

event

"callsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<TeamsCall>

rappel fn qui sera appelé lorsque cette collection va changer, elle transmet des tableaux d’éléments ajoutés et supprimés.

on("connectionStateChanged", ConnectionStateChangedEvent)

Fonction Subscribe pour l’événement connectionStateChanged.

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

Paramètres

event

"connectionStateChanged"

nom de l’événement.

listener

ConnectionStateChangedEvent

rappel fn qui sera appelé lorsque la valeur de cette propriété change.

on("incomingCall", TeamsIncomingCallEvent)

Fonction d’abonnement pour l’événement incomingCall.

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

Paramètres

event

"incomingCall"

nom de l’événement.

listener

TeamsIncomingCallEvent

rappel fn qui sera appelé lorsque cet appelAgent recevra un appel entrant.

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

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Démarrez un appel 1 :N.

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

Paramètres

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Retours

TeamsCall

Objet TeamsCall associé à l’appel.

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

Démarrez l’appel 1:1.

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

Paramètres

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Retours

TeamsCall

Objet TeamsCall associé à l’appel.

Détails de la méthode héritée

dispose()

Supprimer cet agent d’appel

function dispose(): Promise<void>

Retours

Promise<void>

héritée deCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Récupère un objet Feature initialisé et mémorisé avec l’API étendue. Vérifiez les fonctionnalités de l’objet Features.* pour toutes les fonctionnalités de l’agent d’appel étendu disponibles dans ce package.

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

Paramètres

factory

CallAgentFeatureFactory<TFeature>

Fabrique du constructeur de fonctionnalités de l’agent d’appel qui fournit une API étendue.

Retours

TFeature

héritée deCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Gère une notification Push.

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

Paramètres

data

IncomingCallPushNotificationData

Données de notification Push

Retours

Promise<void>

héritée deCallAgentCommon.handlePushNotification