CallAgent interface

Paquet:

@azure/communication-calling

CallAgent est utilisé pour gérer les appels.

Extends

CallAgentCommon

Propriétés

calls	Obtenez les appels.
displayName	Obtenez le nom complet du participant local pour tous les nouveaux 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(GroupCallLocator, JoinCallOptions)	Rejoignez un appel de groupe. Pour rejoindre un appel de groupe, passez un groupId.
join(GroupChatCallLocator, JoinCallOptions)	Rejoignez un appel de conversation de groupe. Pour rejoindre un appel de conversation de groupe, passez un threadId.
join(MeetingLocator, JoinCallOptions)	Participez à une réunion Teams. Pour participer à une réunion Teams, transmettez un lien de réunion ou des coordonnées de réunion.
join(RoomCallLocator, JoinCallOptions)	Rejoignez un appel de salles. Pour rejoindre un appel de salle, passez un roomId.
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<Call>)	Fonction de désabonnement pour l’événement callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Fonction de désabonnement pour l’événement connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Fonction De désabonnement pour l’événement incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Fonction d’abonnement pour l’événement callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Fonction Subscribe pour l’événement connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Fonction d’abonnement pour l’événement incomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Lancez un appel aux participants fournis.
startCall(CommunicationIdentifier[], StartCallOptions)	Lancez un appel aux participants fournis.

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 Call[]

Valeur de propriété

readonly Call[]

displayName

Obtenez le nom complet du participant local pour tous les nouveaux appels.

displayName?: string

Valeur de propriété

string

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(GroupCallLocator, JoinCallOptions)

Rejoignez un appel de groupe. Pour rejoindre un appel de groupe, passez un groupId.

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

Paramètres

groupLocator

GroupCallLocator

Informations d’appel de groupe.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

Objet Call associé à l’appel.

join(GroupChatCallLocator, 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.

Rejoignez un appel de conversation de groupe. Pour rejoindre un appel de conversation de groupe, passez un threadId.

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

Paramètres

groupChatCallLocator

GroupChatCallLocator

Informations d’appel GroupChat.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

Objet Call associé à l’appel.

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 des coordonnées de réunion.

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

Paramètres

meetingLocator

MeetingLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

Objet Call associé à l’appel.

join(RoomCallLocator, JoinCallOptions)

Rejoignez un appel de salles. Pour rejoindre un appel de salle, passez un roomId.

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

Paramètres

roomLocator

RoomCallLocator

Informations d’appel de salle.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

Objet Call 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): Call

Paramètres

meetingLocator

TeamsMeetingIdLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

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

Paramètres

meetingLocator

TeamsMeetingLinkLocator

Informations de réunion.

options

JoinCallOptions

Options de démarrage d’appel.

Retours

Call

Objet Call associé à l’appel.

off("callsUpdated", CollectionUpdatedEvent<Call>)

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

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

Paramètres

event

"callsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<Call>

rappel 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", IncomingCallEvent)

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

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

Paramètres

event

"incomingCall"

nom de l’événement.

listener

IncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<Call>)

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

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

Paramètres

event

"callsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<Call>

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

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

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

Paramètres

event

"incomingCall"

nom de l’événement.

listener

IncomingCallEvent

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

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

Lancez un appel aux participants fournis.

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

Paramètres

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Options Démarrer l’appel.

Retours

Call

Objet Call associé à l’appel démarré.

startCall(CommunicationIdentifier[], StartCallOptions)

Lancez un appel aux participants fournis.

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

Paramètres

participants

CommunicationIdentifier[]

options

StartCallOptions

Options Démarrer l’appel.

Retours

Call

Objet Call associé à l’appel démarré.

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