CallAgent interface
CallAgent viene usato per gestire le chiamate.
- Extends
Proprietà
calls | Ottenere le chiamate. |
display |
Ottiene il nome visualizzato del partecipante locale per tutte le nuove chiamate. |
Proprietà ereditate
connection |
Ottenere lo stato della connessione. |
kind | Ottiene il tipo di oggetto dell'agente di chiamata. |
Metodi
join(Group |
Partecipare a una chiamata di gruppo. Per partecipare a una chiamata di gruppo, passare un groupId. |
join(Group |
Partecipare a una chiamata di chat di gruppo. Per partecipare a una chiamata di chat di gruppo, passare un threadId. |
join(Meeting |
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione o le coordinate delle riunioni. |
join(Room |
Partecipa a una chiamata di sala. Per partecipare a una chiamata di sale, passare un elemento roomId. |
join(Teams |
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un ID riunione e un passcode. |
join(Teams |
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione. |
off("calls |
Annulla la sottoscrizione della funzione per gli eventi callsUpdated. |
off("connection |
Funzione Unsubscribe per l'evento connectionStateChanged. |
off("incoming |
Annulla la sottoscrizione della funzione per l'evento incomingCall. |
on("calls |
Funzione Subscribe per gli eventi callsUpdated. |
on("connection |
Funzione Subscribe per l'evento connectionStateChanged. |
on("incoming |
Funzione Subscribe per l'evento incomingCall. |
start |
Avviare una chiamata ai partecipanti forniti. |
start |
Avviare una chiamata ai partecipanti forniti. |
Metodi ereditati
dispose() | Eliminare l'agente di chiamata |
feature<TFeature>(Call |
Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità dell'agente di chiamata estese disponibili in questo pacchetto. |
handle |
Gestisce una notifica push. |
Dettagli proprietà
calls
Ottenere le chiamate.
calls: readonly Call[]
Valore della proprietà
readonly Call[]
displayName
Ottiene il nome visualizzato del partecipante locale per tutte le nuove chiamate.
displayName?: string
Valore della proprietà
string
Dettagli proprietà ereditate
connectionState
Ottenere lo stato della connessione.
connectionState: ConnectionState
Valore della proprietà
Ereditato daCallAgentCommon.connectionState
kind
Ottiene il tipo di oggetto dell'agente di chiamata.
kind: CallAgentKind
Valore della proprietà
ereditato daCallAgentCommon.kind
Dettagli metodo
join(GroupCallLocator, JoinCallOptions)
Partecipare a una chiamata di gruppo. Per partecipare a una chiamata di gruppo, passare un groupId.
function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call
Parametri
- groupLocator
- GroupCallLocator
Informazioni sulle chiamate di gruppo.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
join(GroupChatCallLocator, JoinCallOptions)
Nota
La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.
Partecipare a una chiamata di chat di gruppo. Per partecipare a una chiamata di chat di gruppo, passare un threadId.
function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call
Parametri
- groupChatCallLocator
- GroupChatCallLocator
Informazioni sulle chiamate di GroupChat.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
join(MeetingLocator, JoinCallOptions)
Nota
La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione o le coordinate delle riunioni.
function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): Call
Parametri
- meetingLocator
- MeetingLocator
Informazioni sulla riunione.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
join(RoomCallLocator, JoinCallOptions)
Partecipa a una chiamata di sala. Per partecipare a una chiamata di sale, passare un elemento roomId.
function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call
Parametri
- roomLocator
- RoomCallLocator
Informazioni sulle chiamate in sala.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
join(TeamsMeetingIdLocator, JoinCallOptions)
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un ID riunione e un passcode.
function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): Call
Parametri
- meetingLocator
- TeamsMeetingIdLocator
Informazioni sulla riunione.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
join(TeamsMeetingLinkLocator, JoinCallOptions)
Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione.
function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): Call
Parametri
- meetingLocator
- TeamsMeetingLinkLocator
Informazioni sulla riunione.
- options
- JoinCallOptions
Chiamare le opzioni di avvio.
Restituisce
Oggetto Call associato alla chiamata.
off("callsUpdated", CollectionUpdatedEvent<Call>)
Annulla la sottoscrizione della funzione per gli eventi callsUpdated.
function off(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)
Parametri
- event
-
"callsUpdated"
nome dell'evento.
- listener
callback fn usato per sottoscrivere questo evento.
off("connectionStateChanged", ConnectionStateChangedEvent)
Funzione Unsubscribe per l'evento connectionStateChanged.
function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)
Parametri
- event
-
"connectionStateChanged"
nome dell'evento.
- listener
- ConnectionStateChangedEvent
callback fn che verrà chiamato quando il valore di questa proprietà cambierà.
off("incomingCall", IncomingCallEvent)
Annulla la sottoscrizione della funzione per l'evento incomingCall.
function off(event: "incomingCall", listener: IncomingCallEvent)
Parametri
- event
-
"incomingCall"
nome dell'evento.
- listener
- IncomingCallEvent
callback fn usato per sottoscrivere questo evento.
on("callsUpdated", CollectionUpdatedEvent<Call>)
Funzione Subscribe per gli eventi callsUpdated.
function on(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)
Parametri
- event
-
"callsUpdated"
nome dell'evento.
- listener
callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.
on("connectionStateChanged", ConnectionStateChangedEvent)
Funzione Subscribe per l'evento connectionStateChanged.
function on(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)
Parametri
- event
-
"connectionStateChanged"
nome dell'evento.
- listener
- ConnectionStateChangedEvent
callback fn che verrà chiamato quando il valore di questa proprietà cambierà.
on("incomingCall", IncomingCallEvent)
Funzione Subscribe per l'evento incomingCall.
function on(event: "incomingCall", listener: IncomingCallEvent)
Parametri
- event
-
"incomingCall"
nome dell'evento.
- listener
- IncomingCallEvent
callback fn che verrà chiamato quando questo callAgent riceverà una chiamata in arrivo.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Avviare una chiamata ai partecipanti forniti.
function startCall(participants: (PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call
Parametri
- participants
-
(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
- options
- StartCallOptions
Avviare le opzioni di chiamata.
Restituisce
Oggetto Call associato alla chiamata avviata.
startCall(CommunicationIdentifier[], StartCallOptions)
Avviare una chiamata ai partecipanti forniti.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call
Parametri
- participants
- options
- StartCallOptions
Avviare le opzioni di chiamata.
Restituisce
Oggetto Call associato alla chiamata avviata.
Dettagli dei metodi ereditati
dispose()
Eliminare l'agente di chiamata
function dispose(): Promise<void>
Restituisce
Promise<void>
ereditato daCallAgentCommon.dispose
feature<TFeature>(CallAgentFeatureFactory<TFeature>)
Nota
La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.
Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità dell'agente di chiamata estese disponibili in questo pacchetto.
function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature
Parametri
- factory
-
CallAgentFeatureFactory<TFeature>
Factory per il costruttore di funzionalità dell'agente di chiamata che fornisce un'API estesa.
Restituisce
TFeature
Ereditato daCallAgentCommon.feature
handlePushNotification(IncomingCallPushNotificationData)
Nota
La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.
Gestisce una notifica push.
function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>
Parametri
Eseguire il push dei dati delle notifiche
Restituisce
Promise<void>
Ereditato daCallAgentCommon.handlePushNotification