@azure/communication-react package
Classi
CallError |
Errore generato dai metodi API con stato non riusciti. |
ChatError |
Errore generato dai metodi StatefulChatClient non riusciti. |
Interfacce
ActiveErrorMessage |
Messaggi di errore attivi da visualizzare tramite ErrorBar. |
AdapterError |
Errore segnalato tramite eventi di errore e archiviati nello stato dell'adattatore. |
AdapterState |
Funzionalità per l'interfacciamento con lo stato dell'adattatore composito. |
BaseCompositeProps |
Proprietà comuni a tutti i compositi esportati da questa libreria. |
BaseCustomStyles |
Stili fluenti di base per tutti i componenti esportati da questa libraia. |
CallAdapter |
Un'interfaccia adapter specifica per l'identità di comunicazione di Azure che estende CommonCallAdapter. |
CallAdapterCallManagement |
Funzionalità per la gestione della chiamata corrente o l'avvio di una nuova chiamata |
CallAdapterCallOperations |
Funzionalità per la gestione della chiamata corrente. |
CallAdapterDeviceManagement |
Funzionalità per la gestione dei dispositivi all'interno di una chiamata. |
CallAdapterSubscribers |
Chiamare eventi compositi che possono essere sottoscritti. |
CallAgentProviderProps |
Argomenti per inizializzare un CallAgentProvider. |
CallAgentState |
Lo stato solo della <xref:%40azure%2Fcommunication-calling%23CallAgent> chiamata viene spostato in modo che sia figlio direttamente di CallClientState e non incluso qui. Il motivo per cui lo stato di CallAgent è quello di fornire l'accesso a displayName. Non si flat callAgent.displayName e lo si inserisce in CallClientState perché sarebbe ambiguo che displayName sia effettivamente dipendente dalla creazione/esistenza di CallAgent per essere disponibile. |
CallAndChatLocator |
Argomenti da usare in createAzureCommunicationCallWithChatAdapter per aggiungere una chiamata a un thread chat associato. |
CallClientProviderProps |
Argomenti per inizializzare un CallClientProvider. |
CallClientState |
Contenitore per tutti i dati di stato proxied by StatefulCallClient. Le chiamate, le chiamateEnded, in ingressoCalls e gli stati in ingressoCallsEnded verranno forniti automaticamente se è stato creato un callAgent. Il deviceManager verrà inizialmente vuoto fino a quando non verrà popolato deviceManagerState. Lo stato userId viene fornito come praticità per lo sviluppatore ed è completamente controllato e impostato dallo sviluppatore. |
CallCompositeProps |
Props per CallComposite. |
CallCompositeStrings |
Stringhe usate direttamente da CallComposite . Queste stringhe si aggiungono a quelle usate dai componenti della libreria dei componenti. |
CallProviderProps |
Argomenti per inizializzare un CallProvider. |
CallState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recupera automaticamente lo stato della chiamata e lo aggiunge allo stato esposto da StatefulCallClient. |
CallWithChatAdapter |
CallWithChatComposite Interfaccia dell'adattatore. |
CallWithChatAdapterManagement |
Funzionalità per la gestione della chiamata corrente con chat. |
CallWithChatAdapterState |
CallWithChat State è una combinazione di client con chat con stato e chiamate con stato con uno stato specifico solo per CallWithChat Composite. |
CallWithChatAdapterSubscriptions |
Chiamare e chat eventi che possono essere sottoscritti in CallWithChatAdapter. |
CallWithChatAdapterUiState |
Stato dell'interfaccia utente relativo a CallWithChatComposite. |
CallWithChatClientState |
Stato dai servizi back-end che unità CallWithChatComposite. |
CallWithChatCompositeProps |
Props necessari per CallWithChatComposite |
CallWithChatCompositeStrings |
Stringhe usate direttamente da CallWithChatComposite . Queste stringhe si aggiungono a quelle usate dai componenti della libreria dei componenti. |
CallWithChatControlOptions |
CallWithChatComposite Chiamare i controlli per visualizzare o nascondere i pulsanti sulla barra di controllo chiamante. |
CallingHandlers |
Oggetto contenente tutti i gestori necessari per chiamare i componenti. La chiamata di componenti correlati da questo pacchetto è in grado di selezionare gestori pertinenti da questo oggetto. Vedere <xref:useHandlers> e usarePropsFor. |
CallingTheme |
Pallet del tema Fluent personalizzato usato chiamando componenti correlati in questa libreria. |
CameraButtonContextualMenuStyles |
Stili per il menu CameraButton . |
CameraButtonProps |
Props per il componente CameraButton . |
CameraButtonStrings |
Stringhe di CameraButton che possono essere sottoposte a override. |
CameraButtonStyles |
Stili per CameraButton |
ChatAdapterSubscribers |
Eventi compositi chat che possono essere sottoscritti. |
ChatAdapterThreadManagement |
Funzionalità per la gestione del thread di chat corrente. |
ChatCompositeProps |
Props per ChatComposite. |
ChatCompositeStrings |
Stringhe usate direttamente da ChatComposite . Queste stringhe si aggiungono a quelle usate dai componenti della libreria dei componenti. |
ChatMessage |
Messaggio di chat. |
CommonCallAdapter |
CallComposite Interfaccia dell'adattatore. |
CommonCallingHandlers |
Oggetto contenente tutti i gestori necessari per chiamare i componenti. La chiamata di componenti correlati da questo pacchetto è in grado di selezionare gestori pertinenti da questo oggetto. Vedere <xref:useHandlers> e usarePropsFor. |
ComponentLocale |
Informazioni sulle impostazioni locali per tutti i componenti esportati da questa libreria. |
ComponentStrings |
Stringhe usate da tutti i componenti esportati da questa libreria. |
CompositeLocale |
Informazioni sulle impostazioni locali per tutti i compositi esportati da questa libreria. |
CompositeStrings |
Stringhe usate direttamente nei compositi. Queste stringhe vengono usate direttamente dai compositi anziché dai componenti contenuti. |
ContentSystemMessage |
Messaggio di sistema con contenutobitario. |
ControlBarButtonProps |
Props per ControlBarButton. |
ControlBarButtonStrings |
Stringhe di ControlBarButton che possono essere sottoposte a override. |
ControlBarProps |
Props per ControlBar. |
CreateVideoStreamViewResult |
Oggetto restituito dopo la creazione di un videostream locale o remoto. Contiene funzioni helper per modificare il rendering del flusso. |
CustomMessage |
Tipo di messaggio personalizzato. I messaggi personalizzati non vengono visualizzati per impostazione predefinita, ma le applicazioni possono fornire renderer personalizzati. |
DevicesButtonContextualMenuStyles |
Stili per il menu DevicesButton . |
DevicesButtonProps |
Props for DevicesButton. |
DevicesButtonStrings |
Stringhe di DevicesButton che possono essere sottoposte a override. |
DevicesButtonStyles |
Stili per le voci di menu del pulsante Dispositivi. |
DiagnosticsCallFeatureState |
Solo proxy di stato per <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>. |
Disposable |
Funzionalità per la corretta eliminazione di un composito. |
EndCallButtonProps |
Props per EndCallButton. |
EndCallButtonStrings |
Stringhe di EndCallButton che possono essere sottoposte a override. |
ErrorBarProps |
Props for ErrorBar. Oltre a quanto segue, ErrorBar inoltra tutto <xref:%40fluentui%2Freact%23IMessageBarProps> all'oggetto sottostante <xref:%40fluentui%2Freact%23MessageBar>. |
ErrorBarStrings |
Tutte le stringhe che possono essere visualizzate nell'interfaccia utente nella Barra degli errori. |
FluentThemeProviderProps |
Props for FluentThemeProvider. |
GridLayoutProps |
Props per GridLayout. |
GridLayoutStyles |
GridLayout Stili componente. |
HorizontalGalleryStyles |
<xref:HorizontalGallery> Stili componente. |
IncomingCallState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient rileva automaticamente le chiamate in ingresso e aggiungerà il relativo stato allo stato esposto da StatefulCallClient. |
JumpToNewMessageButtonProps |
Argomenti per <xref:MessageThreadProps.onRenderJumpToNewMessageButton>. |
LocalVideoCameraCycleButtonProps | |
LocalVideoStreamState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>. |
MediaDiagnosticsState |
Solo proxy di stato per <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>. |
MessageCommon |
Proprietà comuni di tutti i tipi di messaggio. |
MessageStatusIndicatorProps |
Props for MessageStatusIndicator. |
MessageStatusIndicatorStrings |
Stringhe di MessageStatusIndicator che possono essere sottoposte a override. |
MessageThreadStrings |
Stringhe di MessageThread di cui è possibile eseguire l'override. |
MessageThreadStyles |
Stili Fluent per MessageThread. |
MicrophoneButtonContextualMenuStyles |
Stili per il menu MicrophoneButton . |
MicrophoneButtonProps |
Proprietà per MicrophoneButton. |
MicrophoneButtonStrings |
Stringhe di MicrophoneButton di cui è possibile eseguire l'override. |
MicrophoneButtonStyles |
Stili per MicrophoneButton |
NetworkDiagnosticsState |
Proxy di stato solo per <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>. |
OptionsDevice |
Un dispositivo, ad esempio fotocamera, microfono o altoparlante, nel riquadro a comparsa DevicesButton . |
ParticipantAddedSystemMessage |
Messaggio di sistema che informa che un partecipante è stato aggiunto al thread di chat. |
ParticipantItemProps |
Proprietà per ParticipantItem. |
ParticipantItemStrings |
Stringhe di ParticipantItem di cui è possibile eseguire l'override. |
ParticipantItemStyles |
Stili Fluent per ParticipantItem. |
ParticipantListItemStyles |
Stili per ParticipantList ParticipantItem. |
ParticipantListStyles |
Stili per l'oggetto ParticipantList. |
ParticipantRemovedSystemMessage |
Messaggio di sistema che informa che un partecipante è stato rimosso dal thread di chat. |
ParticipantsButtonContextualMenuStyles |
Stili per il menu ParticipantsButton . |
ParticipantsButtonProps |
Proprietà per i partecipantiButton. |
ParticipantsButtonStrings |
Stringhe di ParticipantsButton di cui è possibile eseguire l'override. |
ParticipantsButtonStyles |
Proprietà degli stili per i partecipantiButton. |
RecordingCallFeature |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient ascolterà automaticamente lo stato di registrazione della chiamata e aggiornerà di conseguenza lo stato esposto da StatefulCallClient . |
RemoteParticipantState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recupererà automaticamente RemoteParticipants e aggiungerà il relativo stato allo stato esposto da StatefulCallClient. |
RemoteVideoStreamState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>. |
ScreenShareButtonProps |
Proprietà per ScreenShareButton. |
ScreenShareButtonStrings |
Stringhe di ScreenShareButton di cui è possibile eseguire l'override. |
SendBoxProps |
Proprietà per SendBox. |
SendBoxStrings |
Stringhe di SendBox di cui è possibile eseguire l'override. |
SendBoxStylesProps |
Stili Fluent per <xref:Sendbox>. |
StatefulCallClient |
Definisce i metodi che consentono l'uso di CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> con stato. L'interfaccia fornisce l'accesso allo stato proxy e consente anche di registrare un gestore per gli eventi di modifica dello stato. Per la definizione dello stato, vedere CallClientState. Gli eventi di modifica dello stato sono basati su:
|
StatefulChatClient |
Definisce i metodi che consentono l'uso di {@Link @azure/communication-chat#ChatClient} con uno stato generato centralizzato. L'interfaccia fornisce l'accesso allo stato proxy e consente anche di registrare un gestore per gli eventi di modifica dello stato. |
StatefulDeviceManager |
Definisce i metodi aggiuntivi aggiunti dall'oggetto con stato all'inizio di <xref:%40azure%2Fcommunication-calling%23DeviceManager>. |
StreamMediaProps |
Proprietà per StreamMedia. |
SystemMessageCommon |
Proprietà comuni di tutti i messaggi di sistema. |
TopicUpdatedSystemMessage |
Messaggio di sistema che informa che l'argomento del thread di chat è stato aggiornato. |
TranscriptionCallFeature |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient rimane automaticamente in ascolto dello stato di trascrizione della chiamata e aggiorna di conseguenza lo stato esposto da StatefulCallClient . |
TypingIndicatorProps |
Proprietà per TypingIndicator. |
TypingIndicatorStrings |
Stringhe di TypingIndicator di cui è possibile eseguire l'override. |
TypingIndicatorStylesProps |
Stili Fluent per TypingIndicator. |
VideoGalleryProps |
Proprietà per VideoGallery. |
VideoGalleryRemoteParticipant |
Stato di un partecipante remoto in VideoGallery. |
VideoGalleryStream |
Flusso video di un partecipante in VideoGallery. |
VideoGalleryStrings |
Tutte le stringhe che possono essere visualizzate nell'interfaccia utente in VideoGallery. |
VideoGalleryStyles |
Videogallery Stili dei componenti. |
VideoStreamOptions |
Opzioni per controllare il rendering dei flussi video. |
VideoStreamRendererViewState |
Stato solo versione di <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Questa proprietà viene aggiunta allo stato esposto da StatefulCallClient da createView e rimosso da disposeView. |
VideoTileProps |
Proprietà per VideoTile. |
VideoTileStylesProps |
Stili Fluent per VideoTile. |
Alias tipo
AdapterErrors |
Gli adattatori archivia l'errore più recente per ogni operazione nello stato.
|
AreEqual |
Confrontare se 2 componenti react sono esattamente uguali, il tipo di risultato sarà true/false |
AreParamEqual |
Confrontare se i componenti di 2 reazione sono uguali, il tipo di risultato sarà true/false |
AreTypeEqual |
Confrontare se due tipi sono uguali, il tipo di risultato sarà true/false |
AvatarPersonaData |
Attributi di dati personalizzati per la visualizzazione di avatar per un utente. |
AvatarPersonaDataCallback |
Funzione di callback usata per fornire dati personalizzati per creare un avatar per un utente. |
AzureCommunicationCallAdapterArgs |
Argomenti per la creazione dell'implementazione Servizi di comunicazione di Azure di CallAdapter. Nota: |
AzureCommunicationCallWithChatAdapterArgs |
Argomenti per creareAzureCommunicationCallWithChatAdapter |
AzureCommunicationCallWithChatAdapterFromClientArgs |
Argomenti per <xref:createAzureCommunicationCallWithChatAdapterFromClient> |
AzureCommunicationChatAdapterArgs |
Argomenti per la creazione dell'implementazione Servizi di comunicazione di Azure di ChatAdapter. |
CallAdapterCallEndedEvent |
Payload per CallEndedListener contenente dettagli sulla chiamata terminata. |
CallAdapterClientState |
Stato CommonCallAdapter dedotto da Servizi di comunicazione di Azure back-end. |
CallAdapterLocator |
Localizzatore usato da createAzureCommunicationCallAdapter per individuare la chiamata a join |
CallAdapterState | |
CallAdapterUiState |
Stato CommonCallAdapter per scopi di interfaccia utente pura. |
CallCompositeIcons |
Icone che possono essere sottoposte a override per CallComposite. |
CallCompositeOptions |
Funzionalità facoltative di CallComposite. |
CallCompositePage |
Schermate principali dell'interfaccia utente visualizzate in CallComposite. |
CallControlDisplayType |
Tipo di visualizzazione della barra di controllo per CallComposite. |
CallControlOptions |
Opzioni di personalizzazione per la barra di controllo nell'esperienza di chiamata. |
CallEndedListener |
Callback per l'evento callAdapterSubscribers 'callEnded'. |
CallErrorBarSelector |
Tipo di selettore per il componente ErrorBar . |
CallErrorTarget |
Tipo letterale stringa per tutte le chiavi consentite in {@Link CallErrors}. |
CallErrors |
Errori generati dalle chiamate API all'SDK chiamante. Ogni proprietà nell'oggetto archivia l'errore più recente per un determinato metodo API SDK. Gli errori di questo oggetto possono essere cancellati usando .<xref:newClearCallErrorsModifier> Inoltre, gli errori vengono cancellati automaticamente quando:
|
CallIdChangedListener |
Callback per l'evento callAdapterSubscribers 'callIdChanged'. |
CallParticipantListParticipant |
Lo stato del partecipante viene chiamato come riflesso nei componenti dell'interfaccia utente. |
CallWithChatCompositeIcons |
Icone che possono essere sostituite per CallWithChatComposite. |
CallWithChatCompositeOptions |
Funzionalità facoltative di CallWithChatComposite. |
CallWithChatEvent |
Eventi generati dal CallWithChatAdapter. |
CallingBaseSelectorProps |
Prop comuni usati per fare riferimento allo stato del client dichiarativo dichiarativo. |
CallingReturnProps |
Tipo helper per usePropsFor. |
CameraButtonSelector |
Tipo di selettore per il componente CameraButton . |
ChatAdapter |
ChatComposite Interfaccia dell'adattatore. |
ChatAdapterState |
Stato chatAdapter. |
ChatAdapterUiState |
Stato chatAdapter per scopi di interfaccia utente pura. |
ChatBaseSelectorProps |
Prop comuni per i selettore per ChatClientState. |
ChatClientProviderProps |
Argomenti per inizializzare un ChatClientProvider. |
ChatClientState |
Stato centralizzato per <xref:%40azure%2Fcommunication-chat%23ChatClient>. |
ChatCompositeClientState |
Stato chatAdapter dedotto dal back-end di Servizi di comunicazione di Azure. |
ChatCompositeIcons |
Icone che possono essere sottoposte a override per ChatComposite. |
ChatCompositeOptions |
Funzionalità facoltative di ChatComposite. |
ChatErrorBarSelector |
Tipo di selettore per il componente ErrorBar . |
ChatErrorTarget |
Tipo letterale stringa per tutte le chiavi consentite in ChatErrors. |
ChatErrors |
Errori generati dalle chiamate API all'SDK chat. Ogni proprietà nell'oggetto archivia l'errore più recente per un determinato metodo API SDK. |
ChatHandlers |
Oggetto contenente tutti i gestori necessari per i componenti della chat. I componenti correlati alla chat di questo pacchetto sono in grado di selezionare gestori pertinenti da questo oggetto. Vedere <xref:useHandlers> e usarePropsFor. |
ChatMessageWithStatus |
Estensione che archivia <xref:%40azure%2Fcommunication-chat%23ChatMessage> metadati solo lato client per i messaggi di chat. TODO: il nome ha bitrotted. Rinominami. |
ChatParticipantListSelector |
Tipo di selettore per il componente ParticipantList . |
ChatReturnProps |
Tipo helper per usePropsFor. |
ChatThreadClientProviderProps |
Argomenti per inizializzare un chatThreadClientProvider. |
ChatThreadClientState |
Stato centralizzato per <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. |
ChatThreadProperties |
Proprietà di un thread di chat. Definiamo uno minimo che consente di nascondere i diversi tipi usati dall'API sottostante. |
ClientState |
Stato centralizzato per <xref:%40azure%2Fcommunication-calling%23CallClient> o <xref:%40azure%2Fcommunication-chat%23ChatClient>. Vedere anche: CallClientState, ChatClientState. |
Common |
Restituisce il tipo di intersect di 2 tipi |
CommonProperties |
Restituire proprietà intersect di 2 tipi |
CommunicationParticipant |
Stato di un partecipante chat o chiamante, come illustrato nell'interfaccia utente. |
ComponentIcons |
Icone usate dai componenti di React esportati da questa libreria. |
ComponentProps |
Tipo helper per usePropsFor. |
CompositeIcons |
Icone che possono essere sostituite in uno dei compositi esportati da questa libreria. Per altri tipi di destinazione, vedere ChatCompositeIcons, CallCompositeIcons e CallWithChatCompositeIcons . |
ControlBarButtonStyles |
Stili per tutte le implementazioni di ControlBarButton . |
ControlBarLayout |
Presentare layout per ControlBar. |
CreateViewResult |
Restituisce il risultato da createView. |
CustomAvatarOptions |
Opzioni che possono essere inserite nella |
DeviceManagerState |
Questo tipo è destinato a incapsulare tutto lo stato all'interno <xref:%40azure%2Fcommunication-calling%23DeviceManager>di . Per i parametri facoltativi, potrebbero non essere disponibili fino a quando l'autorizzazione non viene concessa dall'utente. Le fotocamere, i microfoni, gli altoparlanti e gli stati deviceAccess saranno vuoti fino a quando non vengono chiamate e completate le <xref:%40azure%2Fcommunication-calling%23DeviceManager>API getMicrophone, getMicrophones, getSpeakers e askDevicePermission. |
DevicesButtonSelector | |
DiagnosticChangedEventListner |
Callback per l'evento 'diagnosticChanged' di CallAdapterSubscriber . |
DisplayNameChangedListener |
Callback per l'evento 'displayNameChanged' di CallAdapterSubscriber . |
EmptySelector |
Tipo per i selettore semplici che non restituiscono dati. Usato come valore restituito predefinito se usePropsFor viene chiamato per un componente che non richiede dati. |
ErrorType |
Tutti gli errori che possono essere visualizzati nella Barra degli errori. |
GetCallingSelector |
Tipo specifico del selettore applicabile a un determinato componente. |
GetChatSelector |
Tipo specifico del selettore applicabile a un determinato componente. |
IsLocalScreenSharingActiveChangedListener |
Callback per CallAdapterSubscribers 'isLocalScreenSharingActiveChanged'. |
IsMutedChangedListener |
Callback per l'evento CallAdapterSubscribers 'isMuted'. |
IsSpeakingChangedListener |
Callback per l'evento CallAdapterSubscribers 'isSpeakingChanged'. |
LoadingState |
Indica se il flusso viene caricato o meno. |
LocalizationProviderProps |
Props per LocalizationProvider. |
MediaDiagnosticChangedEvent |
Payload per DiagnosticChangedEventListner in cui è presente una modifica in una diagnostica multimediale. |
Message |
Unione discriminata di tutti i messaggi. Il |
MessageAttachedStatus |
Indica se deve essere visualizzato un messaggio di chat con il messaggio prima/dopo di esso. Utile per unire molti messaggi dallo stesso mittente in una singola bolla di messaggio. |
MessageContentType |
Tipi supportati di contenuto dei messaggi di chat. |
MessageProps |
Props per eseguire il rendering di un singolo messaggio. Vedere MessageRenderer. |
MessageReadListener |
Callback per ChatAdapterSubscriber evento 'messageRead'. |
MessageReceivedListener |
Callback per l'evento 'messageReceived' di ChatAdapterSubscriber . |
MessageRenderer |
Componente per il rendering di un singolo messaggio. |
MessageSentListener |
Callback per ChatAdapterSubscribers 'messageSent ' event. |
MessageStatus |
Stato lato client di un messaggio inviato. Include gli stati di transizione che si verificano prima della conferma del recapito dei messaggi dal back-end. |
MessageThreadProps |
Props per MessageThread. |
MessageThreadSelector |
Tipo di selettore per il componente MessageThread . |
MicrophoneButtonSelector |
Tipo di selettore per il componente MicrophoneButton . |
NetworkDiagnosticChangedEvent |
Payload per DiagnosticChangedEventListner in cui è presente una modifica in una diagnostica di rete. |
OnRenderAvatarCallback |
Callback sottoposto a rendering personalizzato che consente agli utenti di personalizzare il rendering di un componente persona. |
ParticipantListParticipant |
Partecipanti visualizzati in un Oggetto ParticipantList. |
ParticipantListProps |
Proprietà per ParticipantList. |
ParticipantListSelector |
Tipo di selettore per il componente ParticipantList . |
ParticipantMenuItemsCallback |
Callback per fornire voci di menu personalizzate per ogni partecipante in ParticipantList. |
ParticipantState |
Stato di connessione di un partecipante alla chiamata. |
ParticipantsAddedListener |
Callback per l'evento ChatAdapterSubscribers 'participantsAdded'. |
ParticipantsButtonSelector |
Tipo di selettore per il componente ParticipantsButton . |
ParticipantsJoinedListener |
Callback per l'evento CallAdapterSubscribers 'participantsJoined'. |
ParticipantsLeftListener |
Callback per l'evento CallAdapterSubscribers 'participantsLeft'. |
ParticipantsRemovedListener |
Callback per l'evento ChatAdapterSubscribers 'participantsRemoved'. |
ReadReceiptsBySenderId |
Matrice di coppie chiave-valore che archivia il nome visualizzato di ogni mittente e l'ultimo messaggio di lettura |
ScreenShareButtonSelector |
Tipo di selettore per il componente ScreenShareButton . |
Selector |
Selettore ottimizzato che perfeziona gli aggiornamenti di ClientState in props per React Components in questa libreria. |
SendBoxSelector |
Tipo di selettore per il componente SendBox . |
StatefulCallClientArgs |
Argomenti per costruire StatefulCallClient. |
StatefulCallClientOptions |
Opzioni per costruire StatefulCallClient con. |
StatefulChatClientArgs |
Argomenti per costruire StatefulChatClient. |
StatefulChatClientOptions |
Opzioni per costruire StatefulChatClient. |
SystemMessage |
Unione discriminata di tutti i messaggi di sistema. Il |
TopicChangedListener |
Callback per l'evento ChatAdapterSubscribers 'topicChanged'. |
TypingIndicatorSelector |
Tipo di selettore per il componente TypingIndicator . |
UpdateMessageCallback |
La funzione di callback viene eseguita quando viene aggiornato un messaggio. |
VideoGalleryLayout | |
VideoGalleryLocalParticipant |
Stato del partecipante locale in VideoGallery. |
VideoGalleryParticipant |
Stato di un partecipante in VideoGallery. |
VideoGallerySelector |
Tipo di selettore per il componente VideoGallery . |
ViewScalingMode |
Modalità di ridimensionamento di un oggetto VideoGalleryStream. |
Funzioni
Call |
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-calling%23CallAgent>. La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con callAgentProvider. |
Call |
Oggetto <xref:React.Context> che archivia un oggetto StatefulCallClient. La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con un CallClientProvider. |
Call |
Interfaccia utente personalizzabile composita per l'esperienza di chiamata. |
Call |
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-calling%23Call>. La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con un CallProvider. |
Call |
CallWithChatComposite riunisce i componenti chiave per fornire una chiamata completa con esperienza di chat predefinita. |
Camera |
Pulsante per attivare/disattivare la fotocamera. Può essere utilizzato con ControlBar. |
Chat |
Oggetto <xref:React.Context> che archivia un oggetto StatefulChatClient. I componenti di chat di questo pacchetto devono essere inclusi in un oggetto ChatClientProvider. |
Chat |
Interfaccia utente personalizzabile composita per l'esperienza di chat. |
Chat |
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. I componenti di chat di questo pacchetto devono essere inclusi in un oggetto ChatThreadClientProvider. |
Control |
Contenitore per vari pulsanti per i controlli delle chiamate. Usare con vari pulsanti di controllo delle chiamate in questa libreria, ad esempio CameraButton o con le proprie istanze di ControlBarButton direttamente. |
Control |
Pulsante predefinito con stile per ControlBar. Usare questo componente per creare pulsanti personalizzati con stili uguali agli altri pulsanti forniti dalla libreria dell'interfaccia utente. |
Devices |
Pulsante per aprire un menu che controlla le opzioni del dispositivo. Può essere utilizzato con ControlBar. |
End |
Pulsante per terminare una chiamata in corso. Può essere utilizzato con ControlBar. |
Error |
Componente per visualizzare i messaggi di errore nell'interfaccia utente. Tutte le stringhe che possono essere visualizzate vengono accettate come stringhe in modo che possano essere localizzate. Gli errori attivi vengono selezionati da activeErrorMessages. Questo componente tiene traccia internamente dell'utente ignorato.
Usa l'elemento <xref:%40fluentui%2Freact%23MessageBar> dell'interfaccia utente. |
Fluent |
Provider per applicare un tema Fluent nei componenti react di questa libreria. |
Grid |
Componente per il layout dei riquadri audio/video dei partecipanti in una chiamata. |
Localization |
Provider per fornire stringhe localizzate per i componenti react di questa libreria. |
Message |
Componente per visualizzare lo stato di un messaggio inviato. Aggiunge un'icona e una descrizione comando corrispondente allo stato del messaggio. |
Message |
|
Microphone |
Pulsante per attivare/disattivare il microfono. Può essere utilizzato con ControlBar. |
Participant |
Componente per il rendering di un partecipante alla chiamata o alla chat. Visualizza l'avatar, displayName e lo stato del partecipante, nonché icone facoltative e menu di scelta rapida. |
Participant |
Componente per eseguire il rendering di tutti i partecipanti alla chiamata o alla chat. Per impostazione predefinita, viene eseguito il rendering di ogni partecipante con ParticipantItem. Vedere <xref:ParticipantListProps.onRenderParticipant> per eseguire l'override. |
Participants |
Pulsante per visualizzare un menu con chiamate o partecipanti alla chat. Può essere utilizzato con ControlBar. Questo pulsante contiene voci di menu a discesa definite tramite la relativa proprietà |
Screen |
Pulsante per avviare/arrestare la condivisione dello schermo. Può essere utilizzato con ControlBar. |
Send |
Componente per la digitazione e l'invio di messaggi. Supporta l'invio di notifiche di digitazione quando l'utente inizia a immettere testo. Supporta un messaggio facoltativo sotto il campo di input di testo. |
Stream |
Componente dell'utilità per convertire un htmlElement con un flusso video in un elemento JSX. Usare per convertire un HTMLElement restituito dall'API di chiamata headless in un componente di cui è possibile eseguire il rendering come VideoTile. |
Typing |
Componente per notificare all'utente locale quando uno o più partecipanti nel thread di chat digitano. |
Video |
VideoGallery rappresenta un layout di riquadri video per una chiamata specifica. Visualizza un oggetto VideoTile per l'utente locale e per ogni partecipante remoto che ha partecipato alla chiamata. |
Video |
Componente per il rendering del flusso video per un singolo partecipante alla chiamata. Usare con GridLayout in un videoGallery. |
create |
Creare un CallAdapter supportato da Servizi di comunicazione di Azure. Si tratta dell'implementazione predefinita di CallAdapter fornita da questa libreria. Nota: |
create |
Creare un CallAdapter usando statefulCallClient fornito. Utile se si vuole mantenere un riferimento a StatefulCallClient. È consigliabile usare createAzureCommunicationCallAdapter per un'API più semplice. |
create |
Creare un CallWithChatAdapter supportato dai servizi di comunicazione di Azure per collegarsi a CallWithChatComposite. |
create |
Creare un CallWithChatAdapter usando statefulChatClient e StatefulCallClient forniti. Utile se si vuole mantenere un riferimento a StatefulChatClient e StatefulCallClient. È consigliabile usare createAzureCommunicationCallWithChatAdapter per un'API più semplice. |
create |
Creare un ChatAdapter supportato da Servizi di comunicazione di Azure. Si tratta dell'implementazione predefinita di ChatAdapter fornita da questa libreria. |
create |
Creare un ChatAdapter usando statefulChatClient fornito. Utile se si vuole mantenere un riferimento a StatefulChatClient. È consigliabile usare createAzureCommunicationChatAdapter per un'API più semplice. |
create |
Creare l'implementazione predefinita di CallingHandlers per le chiamate dei team. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
create |
Creare l'implementazione predefinita di ChatHandlers. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. L'oggetto restituito viene memoizzato per evitare rerenders se usato come props per React Components. |
create |
Crea un oggetto StatefulCallClient StatefulCallClient tramite proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> con ProxyCallClient <xref:ProxyCallClient> , che consente quindi l'accesso allo stato in modo dichiarativo. È importante usare e <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (e così via) ottenuti da StatefulCallClient affinché le modifiche di stato vengano trasmesse correttamente. |
create |
Crea un oggetto ChatClient con statoFulChatClient eseguendo il proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> con ProxyChatClient <xref:ProxyChatClient> , che consente quindi l'accesso allo stato in modo dichiarativo. |
from |
Operazione inversa di toFlatCommunicationIdentifier. |
get |
Ottenere il selettore per un componente specificato. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
get |
Ottenere il selettore per un componente specificato. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
to |
Rappresentazione in forma di stringa di <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Questa rappresentazione di stringa di CommunicationIdentifier è sicuramente stabile per un utente di comunicazione univoco. Pertanto
|
use |
Hook personalizzato React per semplificare la creazione di CallAdapter. Analogamente a createAzureCommunicationCallAdapter, ma si occupa internamente della creazione asincrona dell'adapter. Consente l'annullamento dell'impostazione degli argomenti in modo da poter rispettare gli argomenti rule-of-hook e passare gli argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti. Si noti che è necessario annotare gli argomenti per evitare di ricreare l'adapter in ogni rendering. Per esempi di utilizzo tipici, vedere storybook. |
use |
Hook personalizzato React per semplificare la creazione di CallWithChatAdapter. Analogamente a createAzureCommunicationCallWithChatAdapter, ma si occupa internamente della creazione asincrona dell'adapter. Consente l'annullamento dell'impostazione degli argomenti in modo da poter rispettare gli argomenti rule-of-hook e passare gli argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti. Si noti che è necessario annotare gli argomenti per evitare di ricreare l'adapter in ogni rendering. Per esempi di utilizzo tipici, vedere storybook. |
use |
Hook personalizzato React per semplificare la creazione di ChatAdapter. Analogamente a createAzureCommunicationChatAdapter, ma si occupa internamente della creazione asincrona dell'adapter. Consente agli argomenti di non essere definiti in modo che sia possibile rispettare le regole di hook e passare argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti. Si noti che è necessario promemoria degli argomenti per evitare di ricreare l'adapter in ogni rendering. Vedere storybook per esempi di utilizzo tipici. |
use |
Hook per ottenere <xref:%40azure%2Fcommunication-calling%23Call> dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. è necessario aver usato in precedenza CallProvider con un oggetto Call per usare questo hook |
use |
Hook per ottenere <xref:%40azure%2Fcommunication-calling%23CallAgent> dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
Hook per ottenere StatefulCallClient dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
Hook per ottenere StatefulChatClient dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
Hook per ottenere <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
Hook per ottenere StatefulDeviceManager dal provider. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
Hook primario per ottenere tutti gli hook necessari per un componente React da questa libreria. Per chiamare questo hook, il componente deve essere sottoposto a wrapping in questi provider:
L'utilizzo più semplice di un componente è simile al seguente: Esempio
|
use |
Hook per ottenere un selettore per un componente specificato. Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria. |
use |
React hook per accedere al tema |
Dettagli funzione
CallAgentProvider(CallAgentProviderProps)
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-calling%23CallAgent>.
La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con callAgentProvider.
function CallAgentProvider(props: CallAgentProviderProps): Element
Parametri
- props
- CallAgentProviderProps
Restituisce
Element
CallClientProvider(CallClientProviderProps)
Oggetto <xref:React.Context> che archivia un oggetto StatefulCallClient.
La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con un CallClientProvider.
function CallClientProvider(props: CallClientProviderProps): Element
Parametri
- props
- CallClientProviderProps
Restituisce
Element
CallComposite(CallCompositeProps)
Interfaccia utente personalizzabile composita per l'esperienza di chiamata.
function CallComposite(props: CallCompositeProps): Element
Parametri
- props
- CallCompositeProps
Restituisce
Element
Commenti
Chiamare la larghezza/altezza minima composita sono le seguenti:
- mobile: 17,5rem x 21rem (280px x 336px, con rem predefinito a 16 pixel)
- desktop: 30rem x 22rem (480px x 352px, con rem predefinito a 16 pixel)
CallProvider(CallProviderProps)
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-calling%23Call>.
La chiamata di componenti da questo pacchetto deve essere sottoposta a wrapping con un CallProvider.
function CallProvider(props: CallProviderProps): Element
Parametri
- props
- CallProviderProps
Restituisce
Element
CallWithChatComposite(CallWithChatCompositeProps)
CallWithChatComposite riunisce i componenti chiave per fornire una chiamata completa con esperienza di chat predefinita.
function CallWithChatComposite(props: CallWithChatCompositeProps): Element
Parametri
Restituisce
Element
CameraButton(CameraButtonProps)
Pulsante per attivare/disattivare la fotocamera.
Può essere utilizzato con ControlBar.
function CameraButton(props: CameraButtonProps): Element
Parametri
- props
- CameraButtonProps
Restituisce
Element
ChatClientProvider(ChatClientProviderProps)
Oggetto <xref:React.Context> che archivia un oggetto StatefulChatClient.
I componenti di chat di questo pacchetto devono essere inclusi in un oggetto ChatClientProvider.
function ChatClientProvider(props: ChatClientProviderProps): Element
Parametri
- props
- ChatClientProviderProps
Restituisce
Element
ChatComposite(ChatCompositeProps)
Interfaccia utente personalizzabile composita per l'esperienza di chat.
function ChatComposite(props: ChatCompositeProps): Element
Parametri
- props
- ChatCompositeProps
Restituisce
Element
Commenti
La larghezza e l'altezza di chat composite sono rispettivamente 17,5rem e 20rem (280px e 320px, con rem predefinito a 16px)
ChatThreadClientProvider(ChatThreadClientProviderProps)
Oggetto <xref:React.Context> che archivia un oggetto <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
I componenti di chat di questo pacchetto devono essere inclusi in un oggetto ChatThreadClientProvider.
function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element
Parametri
Restituisce
Element
ControlBar(ControlBarProps)
Contenitore per vari pulsanti per i controlli delle chiamate.
Usare con vari pulsanti di controllo delle chiamate in questa libreria, ad esempio CameraButton o con le proprie istanze di ControlBarButton direttamente.
function ControlBar(props: ControlBarProps): Element
Parametri
- props
- ControlBarProps
Restituisce
Element
ControlBarButton(ControlBarButtonProps)
Pulsante predefinito con stile per ControlBar.
Usare questo componente per creare pulsanti personalizzati con stili uguali agli altri pulsanti forniti dalla libreria dell'interfaccia utente.
function ControlBarButton(props: ControlBarButtonProps): Element
Parametri
- props
- ControlBarButtonProps
Restituisce
Element
DevicesButton(DevicesButtonProps)
Pulsante per aprire un menu che controlla le opzioni del dispositivo.
Può essere utilizzato con ControlBar.
function DevicesButton(props: DevicesButtonProps): Element
Parametri
- props
- DevicesButtonProps
Restituisce
Element
EndCallButton(EndCallButtonProps)
Pulsante per terminare una chiamata in corso.
Può essere utilizzato con ControlBar.
function EndCallButton(props: EndCallButtonProps): Element
Parametri
- props
- EndCallButtonProps
Restituisce
Element
ErrorBar(ErrorBarProps)
Componente per visualizzare i messaggi di errore nell'interfaccia utente. Tutte le stringhe che possono essere visualizzate vengono accettate come stringhe in modo che possano essere localizzate. Gli errori attivi vengono selezionati da activeErrorMessages.
Questo componente tiene traccia internamente dell'utente ignorato.
- Errori con un timestamp associato: l'errore viene visualizzato di nuovo nell'interfaccia utente se si verifica dopo essere stato ignorato.
- Errori che non hanno un timestamp: l'errore viene ignorato fino a quando non scompare dalle proprietà. Se l'errore si ripete, viene visualizzato nell'interfaccia utente.
Usa l'elemento <xref:%40fluentui%2Freact%23MessageBar> dell'interfaccia utente.
function ErrorBar(props: ErrorBarProps): Element
Parametri
- props
- ErrorBarProps
Restituisce
Element
FluentThemeProvider(FluentThemeProviderProps)
Provider per applicare un tema Fluent nei componenti react di questa libreria.
function FluentThemeProvider(props: FluentThemeProviderProps): Element
Parametri
- props
- FluentThemeProviderProps
Restituisce
Element
Commenti
I componenti di questa libreria sono costituiti principalmente da interfaccia utente Fluent, controlli e anche da controlli Fluent React Northstar. Questo provider gestisce l'applicazione di qualsiasi tema fornito ai controlli dell'interfaccia utente Fluent sottostanti, nonché ai controlli Fluent React Northstar.
GridLayout(GridLayoutProps)
Componente per il layout dei riquadri audio/video dei partecipanti in una chiamata.
function GridLayout(props: GridLayoutProps): Element
Parametri
- props
- GridLayoutProps
Restituisce
Element
LocalizationProvider(LocalizationProviderProps)
Provider per fornire stringhe localizzate per i componenti react di questa libreria.
function LocalizationProvider(props: LocalizationProviderProps): Element
Parametri
Restituisce
Element
Commenti
I componenti verranno forniti stringhe localizzate in inglese (Stati Uniti) per impostazione predefinita se questo provider non viene usato.
MessageStatusIndicator(MessageStatusIndicatorProps)
Componente per visualizzare lo stato di un messaggio inviato.
Aggiunge un'icona e una descrizione comando corrispondente allo stato del messaggio.
function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element
Parametri
Restituisce
Element
MessageThread(MessageThreadProps)
MessageThread
consente di creare facilmente un componente per il rendering dei messaggi di chat, la gestione del comportamento di scorrimento dei messaggi nuovi/vecchi e la personalizzazione delle icone & controlli all'interno del thread di chat.
function MessageThread(props: MessageThreadProps): Element
Parametri
- props
- MessageThreadProps
di tipo MessageThreadProps
Gli utenti dovranno fornire almeno messaggi di chat e userId per eseguire il rendering del MessageThread
componente.
Gli utenti possono anche personalizzare MessageThread
passando il proprio Avatar, MessageStatusIndicator
l'icona, LoadPreviousMessagesButton
JumpToNewMessageButton
e il comportamento di questi controlli.
MessageThread
usa internamente il Chat
componente & Chat.Message
da @fluentui/react-northstar
. È possibile esaminare i dettagli su questi due componenti.
Restituisce
Element
MicrophoneButton(MicrophoneButtonProps)
Pulsante per attivare/disattivare il microfono.
Può essere utilizzato con ControlBar.
function MicrophoneButton(props: MicrophoneButtonProps): Element
Parametri
- props
- MicrophoneButtonProps
Restituisce
Element
ParticipantItem(ParticipantItemProps)
Componente per il rendering di un partecipante alla chiamata o alla chat.
Visualizza l'avatar, displayName e lo stato del partecipante, nonché icone facoltative e menu di scelta rapida.
function ParticipantItem(props: ParticipantItemProps): Element
Parametri
- props
- ParticipantItemProps
Restituisce
Element
ParticipantList(ParticipantListProps)
Componente per eseguire il rendering di tutti i partecipanti alla chiamata o alla chat.
Per impostazione predefinita, viene eseguito il rendering di ogni partecipante con ParticipantItem. Vedere <xref:ParticipantListProps.onRenderParticipant> per eseguire l'override.
function ParticipantList(props: ParticipantListProps): Element
Parametri
- props
- ParticipantListProps
Restituisce
Element
ParticipantsButton(ParticipantsButtonProps)
Pulsante per visualizzare un menu con chiamate o partecipanti alla chat.
Può essere utilizzato con ControlBar.
Questo pulsante contiene voci di menu a discesa definite tramite la relativa proprietà menuProps
. Per impostazione predefinita, può visualizzare il numero di partecipanti remoti con l'elenco completo come sottomenu e un'opzione per disattivare tutti i partecipanti, nonché un pulsante copia negli Appunti per copiare l'URL dell'invito alla chiamata.
Può menuProps
essere completamente ridefinito e la relativa proprietà è di tipo IContextualMenuProps.
function ParticipantsButton(props: ParticipantsButtonProps): Element
Parametri
- props
- ParticipantsButtonProps
Restituisce
Element
ScreenShareButton(ScreenShareButtonProps)
Pulsante per avviare/arrestare la condivisione dello schermo.
Può essere utilizzato con ControlBar.
function ScreenShareButton(props: ScreenShareButtonProps): Element
Parametri
- props
- ScreenShareButtonProps
Restituisce
Element
SendBox(SendBoxProps)
Componente per la digitazione e l'invio di messaggi.
Supporta l'invio di notifiche di digitazione quando l'utente inizia a immettere testo. Supporta un messaggio facoltativo sotto il campo di input di testo.
function SendBox(props: SendBoxProps): Element
Parametri
- props
- SendBoxProps
Restituisce
Element
StreamMedia(StreamMediaProps)
Componente dell'utilità per convertire un htmlElement con un flusso video in un elemento JSX.
Usare per convertire un HTMLElement restituito dall'API di chiamata headless in un componente di cui è possibile eseguire il rendering come VideoTile.
function StreamMedia(props: StreamMediaProps): Element
Parametri
- props
- StreamMediaProps
Restituisce
Element
TypingIndicator(TypingIndicatorProps)
Componente per notificare all'utente locale quando uno o più partecipanti nel thread di chat digitano.
function TypingIndicator(props: TypingIndicatorProps): Element
Parametri
- props
- TypingIndicatorProps
Restituisce
Element
VideoGallery(VideoGalleryProps)
VideoGallery rappresenta un layout di riquadri video per una chiamata specifica. Visualizza un oggetto VideoTile per l'utente locale e per ogni partecipante remoto che ha partecipato alla chiamata.
function VideoGallery(props: VideoGalleryProps): Element
Parametri
- props
- VideoGalleryProps
Restituisce
Element
VideoTile(VideoTileProps)
Componente per il rendering del flusso video per un singolo partecipante alla chiamata.
Usare con GridLayout in un videoGallery.
function VideoTile(props: VideoTileProps): Element
Parametri
- props
- VideoTileProps
Restituisce
Element
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)
Creare un CallAdapter supportato da Servizi di comunicazione di Azure.
Si tratta dell'implementazione predefinita di CallAdapter fornita da questa libreria.
Nota: displayName
può essere un massimo di 256 caratteri.
function createAzureCommunicationCallAdapter(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
Parametri
- __namedParameters
- AzureCommunicationCallAdapterArgs
Restituisce
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)
Creare un CallAdapter usando statefulCallClient fornito.
Utile se si vuole mantenere un riferimento a StatefulCallClient. È consigliabile usare createAzureCommunicationCallAdapter per un'API più semplice.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator): Promise<CallAdapter>
Parametri
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
Restituisce
Promise<CallAdapter>
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)
Creare un CallWithChatAdapter supportato dai servizi di comunicazione di Azure per collegarsi a CallWithChatComposite.
function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>
Parametri
- __namedParameters
- AzureCommunicationCallWithChatAdapterArgs
Restituisce
Promise<CallWithChatAdapter>
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)
Creare un CallWithChatAdapter usando statefulChatClient e StatefulCallClient forniti.
Utile se si vuole mantenere un riferimento a StatefulChatClient e StatefulCallClient. È consigliabile usare createAzureCommunicationCallWithChatAdapter per un'API più semplice.
function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>
Parametri
- __namedParameters
- AzureCommunicationCallWithChatAdapterFromClientArgs
Restituisce
Promise<CallWithChatAdapter>
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)
Creare un ChatAdapter supportato da Servizi di comunicazione di Azure.
Si tratta dell'implementazione predefinita di ChatAdapter fornita da questa libreria.
function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>
Parametri
- __namedParameters
- AzureCommunicationChatAdapterArgs
Restituisce
Promise<ChatAdapter>
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)
Creare un ChatAdapter usando statefulChatClient fornito.
Utile se si vuole mantenere un riferimento a StatefulChatClient. È consigliabile usare createAzureCommunicationChatAdapter per un'API più semplice.
function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>
Parametri
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Restituisce
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)
Creare l'implementazione predefinita di CallingHandlers per le chiamate dei team.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call): CallingHandlers
Parametri
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
Restituisce
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)
Creare l'implementazione predefinita di ChatHandlers.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
L'oggetto restituito viene memoizzato per evitare rerenders se usato come props per React Components.
function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers
Parametri
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Restituisce
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)
Crea un oggetto StatefulCallClient StatefulCallClient tramite proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> con ProxyCallClient <xref:ProxyCallClient> , che consente quindi l'accesso allo stato in modo dichiarativo.
È importante usare e <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (e così via) ottenuti da StatefulCallClient affinché le modifiche di stato vengano trasmesse correttamente.
function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient
Parametri
Restituisce
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)
Crea un oggetto ChatClient con statoFulChatClient eseguendo il proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> con ProxyChatClient <xref:ProxyChatClient> , che consente quindi l'accesso allo stato in modo dichiarativo.
function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient
Parametri
- options
- StatefulChatClientOptions
Restituisce
fromFlatCommunicationIdentifier(string)
Operazione inversa di toFlatCommunicationIdentifier.
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
Parametri
- id
-
string
Restituisce
getCallingSelector<Component>(Component)
Ottenere il selettore per un componente specificato.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function getCallingSelector<Component>(component: Component): GetCallingSelector<Component>
Parametri
- component
-
Component
Restituisce
GetCallingSelector<Component>
getChatSelector<Component>(Component)
Ottenere il selettore per un componente specificato.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function getChatSelector<Component>(component: Component): GetChatSelector<Component>
Parametri
- component
-
Component
Restituisce
GetChatSelector<Component>
toFlatCommunicationIdentifier(CommunicationIdentifier)
Rappresentazione in forma di stringa di <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.
Questa rappresentazione di stringa di CommunicationIdentifier è sicuramente stabile per un utente di comunicazione univoco. Pertanto
- può essere usato per rendere persistente l'identità di un utente in database esterni.
- può essere usato come chiavi in una mappa per archiviare i dati per l'utente.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string
Parametri
- identifier
- CommunicationIdentifier
Restituisce
string
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
Hook personalizzato React per semplificare la creazione di CallAdapter.
Analogamente a createAzureCommunicationCallAdapter, ma si occupa internamente della creazione asincrona dell'adapter.
Consente l'annullamento dell'impostazione degli argomenti in modo da poter rispettare gli argomenti rule-of-hook e passare gli argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti.
Si noti che è necessario annotare gli argomenti per evitare di ricreare l'adapter in ogni rendering. Per esempi di utilizzo tipici, vedere storybook.
function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
Parametri
- args
-
Partial<AzureCommunicationCallAdapterArgs>
- afterCreate
-
(adapter: CallAdapter) => Promise<CallAdapter>
- beforeDispose
-
(adapter: CallAdapter) => Promise<void>
Restituisce
undefined | CallAdapter
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)
Hook personalizzato React per semplificare la creazione di CallWithChatAdapter.
Analogamente a createAzureCommunicationCallWithChatAdapter, ma si occupa internamente della creazione asincrona dell'adapter.
Consente l'annullamento dell'impostazione degli argomenti in modo da poter rispettare gli argomenti rule-of-hook e passare gli argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti.
Si noti che è necessario annotare gli argomenti per evitare di ricreare l'adapter in ogni rendering. Per esempi di utilizzo tipici, vedere storybook.
function useAzureCommunicationCallWithChatAdapter(args: Partial<AzureCommunicationCallWithChatAdapterArgs>, afterCreate?: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, beforeDispose?: (adapter: CallWithChatAdapter) => Promise<void>): undefined | CallWithChatAdapter
Parametri
- args
- afterCreate
-
(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>
- beforeDispose
-
(adapter: CallWithChatAdapter) => Promise<void>
Restituisce
undefined | CallWithChatAdapter
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)
Hook personalizzato React per semplificare la creazione di ChatAdapter.
Analogamente a createAzureCommunicationChatAdapter, ma si occupa internamente della creazione asincrona dell'adapter.
Consente agli argomenti di non essere definiti in modo che sia possibile rispettare le regole di hook e passare argomenti durante la creazione. L'adapter viene creato solo quando vengono definiti tutti gli argomenti.
Si noti che è necessario promemoria degli argomenti per evitare di ricreare l'adapter in ogni rendering. Vedere storybook per esempi di utilizzo tipici.
function useAzureCommunicationChatAdapter(args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: (adapter: ChatAdapter) => Promise<ChatAdapter>, beforeDispose?: (adapter: ChatAdapter) => Promise<void>): undefined | ChatAdapter
Parametri
- args
-
Partial<AzureCommunicationChatAdapterArgs>
- afterCreate
-
(adapter: ChatAdapter) => Promise<ChatAdapter>
- beforeDispose
-
(adapter: ChatAdapter) => Promise<void>
Restituisce
undefined | ChatAdapter
useCall()
Hook per ottenere <xref:%40azure%2Fcommunication-calling%23Call> dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
è necessario aver usato in precedenza CallProvider con un oggetto Call per usare questo hook
function useCall(): undefined | Call
Restituisce
undefined | Call
useCallAgent()
Hook per ottenere <xref:%40azure%2Fcommunication-calling%23CallAgent> dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useCallAgent(): undefined | CallAgent
Restituisce
undefined | CallAgent
useCallClient()
Hook per ottenere StatefulCallClient dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useCallClient(): StatefulCallClient
Restituisce
useChatClient()
Hook per ottenere StatefulChatClient dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useChatClient(): StatefulChatClient
Restituisce
useChatThreadClient()
Hook per ottenere <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useChatThreadClient(): ChatThreadClient
Restituisce
useDeviceManager()
Hook per ottenere StatefulDeviceManager dal provider.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useDeviceManager(): undefined | StatefulDeviceManager
Restituisce
undefined | StatefulDeviceManager
usePropsFor<Component>(Component, "chat" | "calling")
Hook primario per ottenere tutti gli hook necessari per un componente React da questa libreria.
Per chiamare questo hook, il componente deve essere sottoposto a wrapping in questi provider:
Per i componenti della chat: ChatClientProvider e ChatThreadClientProvider.
Per chiamare componenti: CallClientProvider, CallAgentProvider e CallAgentProvider.
L'utilizzo più semplice di un componente è simile al seguente:
Esempio
import { ParticipantList, usePropsFor } from '@azure/communication-react';
const App = (): JSX.Element => {
// ... code to setup Providers ...
return <ParticipantList {...usePropsFor(ParticipantList)}/>
}
function usePropsFor<Component>(component: Component, type?: "chat" | "calling"): ComponentProps<Component>
Parametri
- component
-
Component
- type
-
"chat" | "calling"
Restituisce
ComponentProps<Component>
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")
Hook per ottenere un selettore per un componente specificato.
Utile quando si implementa un componente personalizzato che utilizza i provider esportati da questa libreria.
function useSelector<ParamT>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), type?: "chat" | "calling"): (ParamT extends Selector ? ReturnType<ParamT> : undefined)
Parametri
- selector
-
ParamT
- selectorProps
-
(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)
- type
-
"chat" | "calling"
Restituisce
(ParamT extends Selector ? ReturnType<ParamT> : undefined)
useTheme()
React hook per accedere al tema
function useTheme(): Theme
Restituisce
Theme