CallAgent interface
CallAgent est utilisé pour gérer les appels.
- Extends
Propriétés
| calls | Obtenez les appels. |
| display |
Obtenez le nom complet du participant local pour tous les nouveaux appels. |
Propriétés héritées
| connection |
Obtenez l’état de la connexion. |
| kind | Obtenez le type d’objet de l’agent d’appel. |
Méthodes
| join(Group |
Rejoignez un appel de groupe. Pour rejoindre un appel de groupe, passez un groupId. |
| join(Group |
Rejoignez un appel de conversation de groupe. Pour rejoindre un appel de conversation de groupe, passez un threadId. |
| join(Meeting |
Participer à une réunion Teams Pour rejoindre une réunion Teams, transmettez un lien de réunion ou des coordonnées de réunion. |
| join(Room |
Rejoignez un appel de salles. Pour rejoindre un appel de salles, passez un id de salle. |
| join(Teams |
Participer à une réunion Teams Pour participer à une réunion Teams, transmettez un ID de réunion et un code secret. |
| join(Teams |
Participer à une réunion Teams Pour participer à une réunion Teams, passez un lien de réunion. |
| off("calls |
Fonction de désabonnement pour l’événement callsUpdated. |
| off("connection |
Fonction de désabonnement pour l’événement connectionStateChanged. |
| off("incoming |
Fonction de désabonnement pour l’événement incomingCall. |
| on("calls |
Fonction d’abonnement pour l’événement callsUpdated. |
| on("connection |
Fonction Subscribe pour l’événement connectionStateChanged. |
| on("incoming |
Fonction Subscribe pour l’événement incomingCall. |
| start |
Lancez un appel aux participants fournis. |
| start |
Lancez un appel aux participants fournis. |
Méthodes héritées
| dispose() | Supprimer cet agent d’appel |
| feature<TFeature>(Call |
Récupère un objet Feature initialisé et mémorisé avec une API étendue. Vérifiez l’objet Features.* pour connaître toutes les fonctionnalités d’agent d’appel étendu disponibles dans ce package. |
| handle |
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?: stringValeur de propriété
string
Détails de la propriété héritée
connectionState
Obtenez l’état de la connexion.
connectionState: ConnectionStateValeur de propriété
Hérité deCallAgentCommon.connectionState
kind
Obtenez le type d’objet de l’agent d’appel.
kind: CallAgentKindValeur de propriété
Hérité 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): CallParamètres
- groupLocator
- GroupCallLocator
Informations d’appel de groupe.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
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): CallParamètres
- groupChatCallLocator
- GroupChatCallLocator
Informations d’appel GroupChat.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
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.
Participer à une réunion Teams Pour rejoindre une réunion Teams, transmettez un lien de réunion ou des coordonnées de réunion.
function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): CallParamètres
- meetingLocator
- MeetingLocator
Informations de réunion.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
Objet Call associé à l’appel.
join(RoomCallLocator, JoinCallOptions)
Rejoignez un appel de salles. Pour rejoindre un appel de salles, passez un id de salle.
function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): CallParamètres
- roomLocator
- RoomCallLocator
Informations d’appel de salle.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
Objet Call associé à l’appel.
join(TeamsMeetingIdLocator, JoinCallOptions)
Participer à une réunion Teams Pour participer à une réunion Teams, transmettez un ID de réunion et un code secret.
function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): CallParamètres
- meetingLocator
- TeamsMeetingIdLocator
Informations de réunion.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
Objet Call associé à l’appel.
join(TeamsMeetingLinkLocator, JoinCallOptions)
Participer à une réunion Teams Pour participer à une réunion Teams, passez un lien de réunion.
function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): CallParamètres
- meetingLocator
- TeamsMeetingLinkLocator
Informations de réunion.
- options
- JoinCallOptions
Options de démarrage d’appel.
Retours
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
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
callback 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
callback fn qui sera appelé lorsque cette collection changera, il passera 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
callback fn qui sera appelé lorsque la valeur de cette propriété change.
on("incomingCall", IncomingCallEvent)
Fonction Subscribe pour l’événement incomingCall.
function on(event: "incomingCall", listener: IncomingCallEvent)Paramètres
- event
-
"incomingCall"
nom de l’événement.
- listener
- IncomingCallEvent
callback fn qui sera appelé lorsque cet callAgent 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): CallParamètres
- participants
-
(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
- options
- StartCallOptions
Options d’appel de démarrage.
Retours
Objet Call associé à l’appel démarré.
startCall(CommunicationIdentifier[], StartCallOptions)
Lancez un appel aux participants fournis.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): CallParamètres
- participants
- options
- StartCallOptions
Options d’appel de démarrage.
Retours
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é 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 une API étendue. Vérifiez l’objet Features.* pour connaître toutes les fonctionnalités d’agent d’appel étendu disponibles dans ce package.
function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeatureParamètres
- factory
-
CallAgentFeatureFactory<TFeature>
Fabrique du constructeur de fonctionnalité de l’agent d’appel qui fournit une API étendue.
Retours
TFeature
Hérité 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
Données de notification Push
Retours
Promise<void>