共用方式為

@azure/communication-react package

  • 參考

類別

CallError

從失敗的具狀態 API 方法擲回的錯誤。
ChatError

從 StatefulChatClient 方法擲回失敗 錯誤。

介面

ActiveErrorMessage

透過 ErrorBar顯示的作用中錯誤訊息。
AdapterError

透過錯誤事件報告並儲存在配接器狀態的錯誤。
AdapterState

與複合配接器狀態互動的功能。
BaseCompositeProps

從這個連結庫導出之所有複合的通用屬性。
BaseCustomStyles

從這個連結庫導出之所有元件的基本 Fluent 樣式屬性。
CallAdapter

Azure 通訊識別的特定配接器介面，可擴充 commonCallAdapter。
CallAdapterCallManagement

管理目前通話或啟動新通話的功能
CallAdapterCallOperations

管理目前呼叫的功能。
CallAdapterDeviceManagement

在通話中管理裝置的功能。
CallAdapterSubscribers

呼叫可訂閱的複合事件。
CallAgentProviderProps

初始化 CallAgentProvider的自變數。
CallAgentState

只有狀態版本的 <xref:%40azure%2Fcommunication-calling%23CallAgent>，但呼叫會直接移至 CallClientState 的子系，但不包含在這裡。 讓 CallAgent 的狀態 Proxy 化的原因是提供 displayName 的存取權。 我們不會扁平化 CallAgent.displayName，並將它放在 CallClientState 中，因為 displayName 實際上取決於 CallAgent 的建立/存在而模棱兩可。
CallAndChatLocator

用於 建立AzureCommunicationCallWithChatAdapter 的自變數，以聯結與相關聯的聊天對話通話。
CallClientProviderProps

初始化 CallClientProvider的自變數。
CallClientState

StatefulCallClient 所代表之所有狀態數據的容器。 如果已建立 callAgent，就會自動提供呼叫、callEnded、incomingCalls 和 incomingCallsEnded 狀態。 deviceManager 一開始會是空的，直到填入 DeviceManagerState為止。 userId 狀態可供開發人員使用，並由開發人員完全控制及設定。
CallCompositeProps

CallComposite的 Props。
CallCompositeStrings

CallComposite 直接使用的字串。

除了元件連結庫的元件所使用的字串之外，此字串也一並列出。
CallProviderProps

初始化 CallProvider的自變數。
CallState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23Call>。 StatefulCallClient 會自動擷取呼叫的狀態，並將它新增至 statefulCallClient 所公開的狀態。
CallWithChatAdapter

CallWithChatComposite Adapter 介面。
CallWithChatAdapterManagement

使用聊天管理目前通話的功能。
CallWithChatAdapterState

CallWithChat State 是具狀態聊天和具狀態通話客戶端的組合，只有 CallWithChat 複合的特定狀態。
CallWithChatAdapterSubscriptions

可在 CallWithChatAdapter中訂閱的通話和聊天事件。
CallWithChatAdapterUiState

與 CallWithChatComposite相關的 UI 狀態。
CallWithChatClientState

來自驅動 CallWithChatComposite的後端服務的狀態。
CallWithChatCompositeProps

CallWithChatComposite 所需的屬性
CallWithChatCompositeStrings

CallWithChatComposite 所使用的字串。

除了元件連結庫的元件所使用的字串之外，此字串也一並列出。
CallWithChatControlOptions

CallWithChatComposite 通話控件，以顯示或隱藏通話控制列上的按鈕。
CallingHandlers

物件，包含呼叫元件所需的所有處理程式。

從這個封裝呼叫相關的元件，可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。
CallingTheme

在此連結庫中呼叫相關元件所使用的自定義 Fluent 主題板。
CameraButtonContextualMenuStyles

CameraButton 功能表的樣式。
CameraButtonProps

CameraButton 元件的 Props。
CameraButtonStrings

可以覆寫的 CameraButton 字串。
CameraButtonStyles

CameraButton 的樣式
ChatAdapterSubscribers

可訂閱的聊天複合事件。
ChatAdapterThreadManagement

管理目前聊天對話的功能。
ChatCompositeProps

ChatComposite的 Props。
ChatCompositeStrings

ChatComposite 所使用的字串。

除了元件連結庫的元件所使用的字串之外，此字串也一並列出。
ChatMessage

聊天訊息。
CommonCallAdapter

CallComposite Adapter 介面。
CommonCallingHandlers

物件，包含呼叫元件所需的所有處理程式。

從這個封裝呼叫相關的元件，可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。
ComponentLocale

從這個連結庫導出之所有元件的地區設定資訊。
ComponentStrings

從這個連結庫導出的所有元件所使用的字串。
CompositeLocale

從這個連結庫導出之所有複合的地區設定資訊。
CompositeStrings

直接在複合中使用的字串。

這些字串會由複合直接使用，而不是由包含的元件使用。
ContentSystemMessage

具有仲裁內容的系統訊息。
ControlBarButtonProps

ControlBarButton的 Props。
ControlBarButtonStrings

可覆寫 ControlBarButton 字串。
ControlBarProps

ControlBar的 Props。
CreateVideoStreamViewResult

建立本機或遠端 VideoStream 之後傳回的物件。 這包含可操作數據流轉譯的協助程式函式。
CustomMessage

自訂訊息類型。

自定義訊息預設不會轉譯，但應用程式可以提供自定義轉譯器。
DevicesButtonContextualMenuStyles

DevicesButton 功能表的樣式。
DevicesButtonProps

DevicesButton的 Props。
DevicesButtonStrings

可覆寫的 DevicesButton 字串。
DevicesButtonStyles

[裝置] 按鈕功能表項的樣式。
DiagnosticsCallFeatureState

僅限 <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>的 Proxy 狀態。
Disposable

正確處置複合的功能。
EndCallButtonProps

EndCallButton的 Props。
EndCallButtonStrings

可覆寫的 endCallButton 字串。
ErrorBarProps

ErrorBar的 Props。

除了下列專案之外，ErrorBar 會將所有 <xref:%40fluentui%2Freact%23IMessageBarProps> 轉送至基礎 <xref:%40fluentui%2Freact%23MessageBar>。
ErrorBarStrings

在 ErrorBar中 UI 上顯示的所有字串。
FluentThemeProviderProps

FluentThemeProvider的 Props。
GridLayoutProps

GridLayout的 Props。
GridLayoutStyles

GridLayout 元件樣式。
HorizontalGalleryStyles

<xref:HorizontalGallery> 元件樣式。
IncomingCallState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23IncomingCall>。 StatefulCallClient 會自動偵測來電，並將其狀態新增至 statefulCallClient 所公開的狀態。
JumpToNewMessageButtonProps

<xref:MessageThreadProps.onRenderJumpToNewMessageButton>的自變數。
LocalVideoCameraCycleButtonProps
LocalVideoStreamState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>。
MediaDiagnosticsState

僅限 <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>的 Proxy 狀態。
MessageCommon

所有訊息類型的通用屬性。
MessageStatusIndicatorProps

MessageStatusIndicator的 Props。
MessageStatusIndicatorStrings

可覆寫的 MessageStatusIndicator 字串。
MessageThreadStrings

可覆寫的 messageThread 字串。
MessageThreadStyles

MessageThread的 Fluent 樣式。
MicrophoneButtonContextualMenuStyles

MicrophoneButton 功能表的樣式。
MicrophoneButtonProps

MicrophoneButton的 Props。
MicrophoneButtonStrings

可以覆寫的 MicrophoneButton 字串。
MicrophoneButtonStyles

MicrophoneButton 的樣式
NetworkDiagnosticsState

僅限 <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>的 Proxy 狀態。
OptionsDevice

裝置，例如相機、麥克風或喇叭，位於 DevicesButton 飛出視窗。
ParticipantAddedSystemMessage

系統訊息，通知參與者已新增至聊天對話。
ParticipantItemProps

ParticipantItem的 Props。
ParticipantItemStrings

可覆寫 ParticipantItem 字串。
ParticipantItemStyles

ParticipantItem的 Fluent 樣式。
ParticipantListItemStyles

ParticipantListParticipantItem的樣式。
ParticipantListStyles

ParticipantList的樣式。
ParticipantRemovedSystemMessage

系統訊息，通知參與者已從聊天對話中移除。
ParticipantsButtonContextualMenuStyles

ParticipantsButton 功能表的樣式。
ParticipantsButtonProps

ParticipantsButton的 Props。
ParticipantsButtonStrings

可覆寫的 ParticipantsButton 字串。
ParticipantsButtonStyles

ParticipantsButton的樣式屬性。
RecordingCallFeature

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>。 StatefulCallClient 會自動接聽通話的錄製狀態，並據以更新 statefulCallClient 所公開的狀態。
RemoteParticipantState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>。 StatefulCallClient 會自動擷取 RemoteParticipants，並將其狀態新增至 statefulCallClient 所公開的狀態。
RemoteVideoStreamState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>。
ScreenShareButtonProps

ScreenShareButton的 Props。
ScreenShareButtonStrings

可覆寫的 ScreenShareButton 字串。
SendBoxProps

SendBox的 Props。
SendBoxStrings

可覆寫之 SendBox 字串。
SendBoxStylesProps

<xref:Sendbox>的 Fluent 樣式。
StatefulCallClient

定義可讓 CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> 具狀態使用的方法。 介面提供對 Proxy 狀態的存取權，也允許註冊狀態變更事件的處理程式。 如需狀態定義，請參閱 CallClientState。

狀態變更事件是由：

  • 從 <xref:%40azure%2Fcommunication-calling%23DeviceManager> API 傳回的數據。
  • 從 <xref:%40azure%2Fcommunication-calling%23CallAgent> API 傳回的數據。
  • 自動附加至各種 Azure 通訊呼叫物件的接聽程式：
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • 呼叫 'stateChanged'
    • 呼叫 'idChanged'
    • 呼叫 'isMutedChanged'
    • 呼叫 'isScreenSharingOnChanged'
    • 呼叫 'remoteParticipantsUpdated'
    • 呼叫 'localVideoStreamsUpdated'
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

定義方法，允許 {@Link @azure/communication-chat#ChatClient}与集中式产生状态搭配使用。

介面提供對 Proxy 狀態的存取權，也允許註冊狀態變更事件的處理程式。
StatefulDeviceManager

定義由具狀態在 <xref:%40azure%2Fcommunication-calling%23DeviceManager>上新增的其他方法。
StreamMediaProps

StreamMedia的 Props。
SystemMessageCommon

所有系統訊息的通用屬性。
TopicUpdatedSystemMessage

通知聊天對話主題已更新的系統訊息。
TranscriptionCallFeature

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>。 StatefulCallClient 會自動接聽呼叫的轉譯狀態，並據以更新 statefulCallClient 所公開的狀態。
TypingIndicatorProps

TypingIndicator的 Props。
TypingIndicatorStrings

可以覆寫的 TypingIndicator 字串。
TypingIndicatorStylesProps

TypingIndicator的 Fluent 樣式。
VideoGalleryProps

VideoGallery的道具。
VideoGalleryRemoteParticipant

VideoGallery中遠端參與者的狀態。
VideoGalleryStream

VideoGallery中參與者的視訊串流。
VideoGalleryStrings

VideoGallery中 UI 上可能顯示的所有字串。
VideoGalleryStyles

VideoGallery 元件樣式。
VideoStreamOptions

控制影片串流呈現方式的選項。
VideoStreamRendererViewState

只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>。 此屬性會新增至由 createView createViewStatefulCallClient 公開的狀態，disposeView移除。
VideoTileProps

VideoTile的 Props。
VideoTileStylesProps

VideoTile的 Fluent 樣式。

類型別名

AdapterErrors

配接器會儲存狀態中每個作業的最新錯誤。

target 是配接器所執行之每個唯一作業的配接器定義字串。
AreEqual

比較 2 個 react 元件是否完全相等，結果類型會是 true/false
AreParamEqual

比較 2 react 元件的 props 是否相等，結果類型會是 true/false
AreTypeEqual

比較兩個類型是否相等，結果類型會是 true/false
AvatarPersonaData

用於顯示使用者虛擬人偶的自定義資料屬性。
AvatarPersonaDataCallback

回呼函式，用來提供自定義數據來為使用者建置虛擬人偶。
AzureCommunicationCallAdapterArgs

建立 CallAdapter之 Azure 通訊服務實作的自變數。

注意：displayName 最多可以有 256 個字元。
AzureCommunicationCallWithChatAdapterArgs

createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs

<xref:createAzureCommunicationCallWithChatAdapterFromClient> 的自變數
AzureCommunicationChatAdapterArgs

建立 ChatAdapter之 Azure 通訊服務實作的自變數。
CallAdapterCallEndedEvent

CallEndedListener 的承載 包含結束呼叫的詳細數據。
CallAdapterClientState

CommonCallAdapter 從 Azure 通訊服務後端推斷的狀態。
CallAdapterLocator

createAzureCommunicationCallAdapter 用來尋找加入呼叫的定位器
CallAdapterState

CommonCallAdapter 狀態。
CallAdapterUiState

CommonCallAdapter 純 UI 用途的狀態。
CallCompositeIcons

可覆寫 CallComposite的圖示。
CallCompositeOptions

CallComposite的選擇性功能。
CallCompositePage

CallComposite中顯示的主要 UI 畫面。
CallControlDisplayType

CallComposite的控制列顯示類型。
CallControlOptions

呼叫體驗中控件列的自定義選項。
CallEndedListener

CallAdapterSubscribers 'callEnded' 事件的回呼。
CallErrorBarSelector

ErrorBar 元件的選取器類型。
CallErrorTarget

{@Link CallErrors} 中所有允許索引鍵的字串常值類型。
CallErrors

從 API 呼叫至呼叫 SDK 時發生錯誤。

物件中的每個屬性都會儲存特定 SDK API 方法的最新錯誤。

您可以使用 <xref:newClearCallErrorsModifier>清除這個物件的錯誤。 此外，錯誤會在下列情況下自動清除：

  • 已清除狀態。
  • 後續對相關 API 方法的呼叫會成功。 如需何時可能會自動清除錯誤的詳細數據，請參閱個別具狀態用戶端方法的檔。
CallIdChangedListener

CallAdapterSubscribers 'callIdChanged' 事件的回呼。
CallParticipantListParticipant

呼叫參與者的狀態，如UI元件中所反映。
CallWithChatCompositeIcons

可覆寫 CallWithChatComposite的圖示。
CallWithChatCompositeOptions

CallWithChatComposite的選擇性功能。
CallWithChatEvent

CallWithChatAdapter引發的事件。
CallingBaseSelectorProps

用來參考呼叫宣告式客戶端狀態的常見屬性。
CallingReturnProps

的協助程式類型 usePropsFor。
CameraButtonSelector

CameraButton 元件的選取器類型。
ChatAdapter

ChatComposite 配接器介面。
ChatAdapterState

ChatAdapter 狀態。
ChatAdapterUiState

ChatAdapter 純 UI 用途的狀態。
ChatBaseSelectorProps

ChatClientState的選取器通用屬性。
ChatClientProviderProps

初始化 ChatClientProvider的自變數。
ChatClientState

<xref:%40azure%2Fcommunication-chat%23ChatClient>的集中式狀態。
ChatCompositeClientState

ChatAdapter 從 Azure 通訊服務後端推斷的狀態。
ChatCompositeIcons

可以覆寫 ChatComposite的圖示。
ChatCompositeOptions

ChatComposite的選擇性功能。
ChatErrorBarSelector

ErrorBar 元件的選取器類型。
ChatErrorTarget

ChatErrors 中所有允許索引鍵的字串常值類型。
ChatErrors

從 API 呼叫聊天 SDK 所發生的錯誤。

物件中的每個屬性都會儲存特定 SDK API 方法的最新錯誤。
ChatHandlers

物件，包含聊天元件所需的所有處理程式。

此套件中的聊天相關元件能夠從這個物件中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。
ChatMessageWithStatus

<xref:%40azure%2Fcommunication-chat%23ChatMessage> 的擴充功能，可儲存聊天訊息的用戶端專用元數據。

TODO：名稱已位。 重新命名我。
ChatParticipantListSelector

ParticipantList 元件的選取器類型。
ChatReturnProps

的協助程式類型 usePropsFor。
ChatThreadClientProviderProps

初始化 ChatThreadClientProvider的自變數。
ChatThreadClientState

<xref:%40azure%2Fcommunication-chat%23ChatThreadClient>的集中式狀態。
ChatThreadProperties

聊天對話的屬性。

我們會定義最少的 ，以協助我們隱藏基礎 API 所使用的不同類型。
ClientState

<xref:%40azure%2Fcommunication-calling%23CallClient> 或 <xref:%40azure%2Fcommunication-chat%23ChatClient>的集中式狀態。

另請參閱：CallClientStateChatClientState。
Common

傳回 2 型別的交集類型
CommonProperties

傳回 2 種型別的交集屬性
CommunicationParticipant

聊天或通話參與者的狀態，如UI中所反映。
ComponentIcons

從這個連結庫導出的 React 元件所使用的圖示。
ComponentProps

的協助程式類型 usePropsFor。
CompositeIcons

可以在這個連結庫所導出的其中一個複合中覆寫的圖示。

如需更多目標類型，請參閱 ChatCompositeIcons、CallCompositeIcons 和 CallWithChatCompositeIcons。
ControlBarButtonStyles

所有 ControlBarButton 實作的樣式。
ControlBarLayout

ControlBar呈現版面配置。
CreateViewResult

從 createView傳回結果。
CustomAvatarOptions

可插入至 onRender 函式的選項，以自定義虛擬人偶 （Persona） 元件。
DeviceManagerState

此類型旨在封裝 <xref:%40azure%2Fcommunication-calling%23DeviceManager>中的所有狀態。 針對選擇性參數，在使用者授與許可權之前，他們可能無法使用。 相機、麥克風、喇叭和 deviceAccess 狀態會是空的，直到對應的 <xref:%40azure%2Fcommunication-calling%23DeviceManager>getCameras、getMicrophones、getSpeakers 和 askDevicePermission API 呼叫並完成為止。
DevicesButtonSelector

DevicesButton 元件的選取器類型。
DiagnosticChangedEventListner

CallAdapterSubscribers 'diagnosticChanged' 事件的回呼。
DisplayNameChangedListener

CallAdapterSubscribers 'displayNameChanged' 事件的回呼。
EmptySelector

傳回無數據之簡單選取器的型別。

如果 使用PropsFor，則會針對不需要任何數據的元件呼叫做為預設傳回值。
ErrorType

所有可在 ErrorBar 中顯示的錯誤，。
GetCallingSelector

適用於指定元件的特定選取器類型。
GetChatSelector

適用於指定元件的特定選取器類型。
IsLocalScreenSharingActiveChangedListener

CallAdapterSubscribers 'isLocalScreenSharingActiveChanged' 事件的回呼。
IsMutedChangedListener

CallAdapterSubscribers 'isMuted' 事件的回呼。
IsSpeakingChangedListener

CallAdapterSubscribers 'isSpeakingChanged' 事件的回呼。
LoadingState

數據流是否正在載入。
LocalizationProviderProps

LocalizationProvider的 Props。
MediaDiagnosticChangedEvent

DiagnosticChangedEventListner 的承載 媒體診斷中有變更。
Message

所有訊息的歧視聯集。

messageType 欄位專門研究聯集變體。
MessageAttachedStatus

指出聊天訊息是否應該在 /之後與訊息合併。

將來自相同寄件人的許多訊息合併成單一訊息泡泡很有用。
MessageContentType

支援的聊天訊息內容類型。
MessageProps

呈現單一訊息的 Props。

請參閱 MessageRenderer。
MessageReadListener

ChatAdapterSubscribers 'messageRead' 事件的回呼。
MessageReceivedListener

ChatAdapterSubscribers 'messageReceived' 事件的回呼。
MessageRenderer

要轉譯單一訊息的元件。
MessageSentListener

ChatAdapterSubscribers 'messageSent' 事件的回呼。
MessageStatus

已傳送訊息的客戶端狀態。

包含從後端確認訊息傳遞之前發生的過渡狀態。
MessageThreadProps

MessageThread的 Props。
MessageThreadSelector

MessageThread 元件的選取器類型。
MicrophoneButtonSelector

MicrophoneButton 元件的選取器類型。
NetworkDiagnosticChangedEvent

DiagnosticChangedEventListner 網路診斷中有變更的承載。
OnRenderAvatarCallback

自定義轉譯回呼，可讓使用者自定義 Persona 元件的轉譯。
ParticipantListParticipant

ParticipantList中顯示的參與者。
ParticipantListProps

ParticipantList的 Props。
ParticipantListSelector

ParticipantList 元件的選取器類型。
ParticipantMenuItemsCallback

回呼，用於為 ParticipantList中的每個參與者提供自定義功能表項。
ParticipantState

呼叫參與者的連接狀態。
ParticipantsAddedListener

ChatAdapterSubscribers 'participantsAdded' 事件的回呼。
ParticipantsButtonSelector

ParticipantsButton 元件的選取器類型。
ParticipantsJoinedListener

CallAdapterSubscribers 'participantsJoined' 事件的回呼。
ParticipantsLeftListener

CallAdapterSubscribers 'participantsLeft' 事件的回呼。
ParticipantsRemovedListener

ChatAdapterSubscribers 'participantsRemoved' 事件的回呼。
ReadReceiptsBySenderId

索引鍵值組的數位，儲存每個寄件人的顯示名稱和上次讀取訊息
ScreenShareButtonSelector

ScreenShareButton 元件的選取器類型。
Selector

優化選取器，可將 ClientState 更新精簡為此連結庫中 React 元件的屬性。
SendBoxSelector

SendBox 元件的選取器類型。
StatefulCallClientArgs

建構 StatefulCallClient 的自變數。
StatefulCallClientOptions

使用 建構 StatefulCallClient 的選項。
StatefulChatClientArgs

建構 StatefulChatClient的自變數。
StatefulChatClientOptions

建構 StatefulChatClient的選項。
SystemMessage

所有系統訊息的差別聯集。

systemMessageType 欄位專門研究聯集變體。
TopicChangedListener

ChatAdapterSubscribers 'topicChanged' 事件的回呼。
TypingIndicatorSelector

TypeIndicator 元件的選取器類型。
UpdateMessageCallback

回呼函式會在訊息更新時執行。
VideoGalleryLayout
VideoGalleryLocalParticipant

VideoGallery 中的本機參與者狀態。
VideoGalleryParticipant

VideoGallery 中參與者的狀態。
VideoGallerySelector

VideoGallery 元件的選取器類型。
ViewScalingMode

VideoGalleryStream的縮放模式。

函式

CallAgentProvider(CallAgentProviderProps)

儲存 <xref:%40azure%2Fcommunication-calling%23CallAgent>的 <xref:React.Context>。

從此封裝呼叫元件時，必須包裝 CallAgentProvider。
CallClientProvider(CallClientProviderProps)

儲存 StatefulCallClient的 <xref:React.Context>。

從此封裝呼叫元件時，必須使用 CallClientProvider包裝。
CallComposite(CallCompositeProps)

通話體驗的可自定義UI複合。
CallProvider(CallProviderProps)

儲存 <xref:%40azure%2Fcommunication-calling%23Call>的 <xref:React.Context>。

從此封裝呼叫元件時，必須使用 CallProvider包裝。
CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite 將重要元件結合在一起，以提供現成聊天體驗的完整通話。
CameraButton(CameraButtonProps)

開啟/關閉相機的按鈕。

可以搭配 ControlBar使用。
ChatClientProvider(ChatClientProviderProps)

儲存 StatefulChatClient的 <xref:React.Context>。

此套件中的聊天元件必須包裝 ChatClientProvider。
ChatComposite(ChatCompositeProps)

聊天體驗的可自定義UI複合。
ChatThreadClientProvider(ChatThreadClientProviderProps)

儲存 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>的 <xref:React.Context>。

此套件中的聊天元件必須包裝 ChatThreadClientProvider。
ControlBar(ControlBarProps)

呼叫控件之各種按鈕的容器。

請搭配此連結庫中的各種呼叫控件按鈕使用，例如，CameraButton，或直接 ControlBarButton 的實例。
ControlBarButton(ControlBarButtonProps)

ControlBar的預設按鈕樣式。

使用此元件建立自定義按鈕，其樣式與UI連結庫所提供的其他按鈕相同。
DevicesButton(DevicesButtonProps)

開啟控制裝置選項之功能表的按鈕。

可以搭配 ControlBar使用。
EndCallButton(EndCallButtonProps)

結束進行中呼叫的按鈕。

可以搭配 ControlBar使用。
ErrorBar(ErrorBarProps)

在UI上顯示錯誤訊息的元件。 所有可以顯示的字串都會接受為 字串，以便進行當地語系化。 activeErrorMessages選取使用中的錯誤。

此元件會在內部追蹤使用者關閉的追蹤。

  • 具有相關聯時間戳的錯誤：如果在關閉之後發生錯誤，UI 上會再次顯示錯誤。
  • 沒有時間戳的錯誤：錯誤會關閉，直到它從 props 消失為止。 如果錯誤遞歸，則會顯示在UI中。

使用 <xref:%40fluentui%2Freact%23MessageBar> UI 元素。
FluentThemeProvider(FluentThemeProviderProps)

提供者，將 Fluent 主題套用至此連結庫的 react 元件。
GridLayout(GridLayoutProps)

在通話中配置音訊/視訊參與者磚的元件。
LocalizationProvider(LocalizationProviderProps)

提供此連結庫 react 元件的當地語系化字串提供者。
MessageStatusIndicator(MessageStatusIndicatorProps)

顯示已傳送訊息狀態的元件。

新增對應至訊息狀態的圖示和工具提示。
MessageThread(MessageThreadProps)

MessageThread 可讓您輕鬆地建立元件來轉譯聊天訊息、處理新/舊訊息的捲動行為，以及自定義聊天對話內控件 & 圖示。
MicrophoneButton(MicrophoneButtonProps)

開啟/關閉麥克風的按鈕。

可以搭配 ControlBar使用。
ParticipantItem(ParticipantItemProps)

用來轉譯通話或聊天參與者的元件。

顯示參與者的虛擬人偶、displayName 和狀態，以及選用的圖示和操作功能表。
ParticipantList(ParticipantListProps)

用來轉譯所有通話或聊天參與者的元件。

根據預設，每個參與者都會以 ParticipantItem轉譯。 請參閱要覆寫的 <xref:ParticipantListProps.onRenderParticipant>。
ParticipantsButton(ParticipantsButtonProps)

顯示具有通話或聊天參與者之功能表的按鈕。

可以搭配 ControlBar使用。

此按鈕包含透過其屬性 menuProps定義的下拉功能表專案。 根據預設，它可以將完整清單顯示為子功能表的遠端參與者數目，以及將所有參與者設為靜音的選項，以及複製到剪貼簿按鈕來複製通話邀請 URL。 此 menuProps 可以完全重新定義，而且其 屬性的類型為 IContextualMenuProps。
ScreenShareButton(ScreenShareButtonProps)

啟動/停止螢幕共用的按鈕。

可以搭配 ControlBar使用。
SendBox(SendBoxProps)

輸入和傳送訊息的元件。

支持當用戶開始輸入文字時傳送輸入通知。 支援文字輸入欄位下方的選擇性訊息。
StreamMedia(StreamMediaProps)

公用程式元件，可將具有視訊數據流的 HTMLElement 轉換成 JSX 元素。

使用 將無外設呼叫 API 傳回的 HTMLElement 轉換成可轉譯為 VideoTile的元件。
TypingIndicator(TypingIndicatorProps)

元件，以在聊天對話中的一或多個參與者輸入時通知本機使用者。
VideoGallery(VideoGalleryProps)

VideoGallery 代表特定通話的視訊磚配置。 它會顯示本機使用者的 VideoTile，以及已加入通話的每個遠端參與者。
VideoTile(VideoTileProps)

要轉譯單一通話參與者視訊數據流的元件。

在 VideoGallery中搭配 GridLayout 使用。
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

建立 Azure 通訊服務支援的 CallAdapter。

這是此連結庫提供 CallAdapter 的預設實作。

注意：displayName 最多可以有 256 個字元。
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

使用提供的 StatefulCallClient建立 CallAdapter。

如果您想要保留 StatefulCallClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallAdapter。
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

建立 Azure 通訊服務支援的 CallWithChatAdapter，以插入 CallWithChatComposite。
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

使用提供的 StatefulChatClient 和 StatefulCallClient建立 CallWithChatAdapter。

如果您想要保留 StatefulChatClient 和 StatefulCallClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallWithChatAdapter。
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

建立由 Azure 通訊服務支援的 ChatAdapter。

這是此連結庫提供 ChatAdapter 的預設實作。
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

使用提供的 StatefulChatClient建立 ChatAdapter。

如果您想要保留 StatefulChatClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationChatAdapter。
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

為小組通話建立 CallHandlers 的預設實作。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

建立 ChatHandlers的預設實作。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

傳回的物件已備忘，以避免在做為 React 元件之 props 時重新調整。
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

使用 ProxyCallClient <xref:ProxyCallClient> ProxyClient <xref:%40azure%2Fcommunication-calling%23CallClient> ProxyCallClient <xref:ProxyCallClient>，以宣告方式建立 StatefulCallClient StatefulCallClient。

請務必使用從 StatefulCallClient 取得的 <xref:%40azure%2Fcommunication-calling%23DeviceManager> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 <xref:%40azure%2Fcommunication-calling%23Call>（等），以便正確處理其狀態變更。
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

使用 ProxyChatClient <xref:ProxyChatClient> ProxyClient <xref:%40azure%2Fcommunication-chat%23ChatClient> proxyChatClient <xref:ProxyChatClient> 建立具狀態的 ChatClient StatefulChatClient，然後允許以宣告式方式存取狀態。
fromFlatCommunicationIdentifier(string)

至FlatCommunicationIdentifier的反向作業。
getCallingSelector<Component>(Component)

取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
getChatSelector<Component>(Component)

取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
toFlatCommunicationIdentifier(CommunicationIdentifier)

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>的字串表示。

此 CommunicationIdentifier 的字串表示法保證對唯一的通訊使用者而言是穩定的。 因此

  • 它可用來將使用者的身分識別保存在外部資料庫中。
  • 它可以當做對應中的索引鍵來儲存用戶的數據。
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

自定義 React 攔截，可簡化 CallAdapter的建立。

類似於 createAzureCommunicationCallAdapter，但會負責在內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

自定義 React 攔截，可簡化 CallWithChatAdapter的建立。

類似於 createAzureCommunicationCallWithChatAdapter，但會負責在內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

自定義 React 攔截，可簡化 ChatAdapter的建立。

類似於 createAzureCommunicationChatAdapter，但會負責內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。
useCall()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23Call>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

您先前必須已搭配 Call 物件使用 CallProvider，才能使用此攔截
useCallAgent()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23CallAgent>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
useCallClient()

攔截 以從提供者取得 StatefulCallClient。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
useChatClient()

Hook 以從提供者取得 StatefulChatClient。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
useChatThreadClient()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
useDeviceManager()

Hook 以從提供者取得 StatefulDeviceManager。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
usePropsFor<Component>(Component, "chat" | "calling")

從這個連結庫取得 React 元件所需的所有連結的主要勾點。

若要呼叫此攔截，元件必須包裝在這些提供者下：

  1. 針對聊天元件：ChatClientProvider 和 ChatThreadClientProvider。

  2. 針對呼叫元件：CallClientProvider、CallAgentProvider 和 CallAgentProvider。

元件最直接的使用方式如下所示：

範例

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

勾點以取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。
useTheme()

回應連結以存取主題

函式詳細資料

CallAgentProvider(CallAgentProviderProps)

儲存 <xref:%40azure%2Fcommunication-calling%23CallAgent>的 <xref:React.Context>。

從此封裝呼叫元件時，必須包裝 CallAgentProvider。

function CallAgentProvider(props: CallAgentProviderProps): Element

參數

props
CallAgentProviderProps

傳回

Element

CallClientProvider(CallClientProviderProps)

儲存 StatefulCallClient的 <xref:React.Context>。

從此封裝呼叫元件時，必須使用 CallClientProvider包裝。

function CallClientProvider(props: CallClientProviderProps): Element

參數

props
CallClientProviderProps

傳回

Element

CallComposite(CallCompositeProps)

通話體驗的可自定義UI複合。

function CallComposite(props: CallCompositeProps): Element

參數

props
CallCompositeProps

傳回

Element

備註

呼叫複合最小寬度/高度如下：

  • mobile：17.5rem x 21rem（280px x 336px，預設 rem 為 16px）
  • desktop：30rem x 22rem （480px x 352px，預設 rem 為 16px）

CallProvider(CallProviderProps)

儲存 <xref:%40azure%2Fcommunication-calling%23Call>的 <xref:React.Context>。

從此封裝呼叫元件時，必須使用 CallProvider包裝。

function CallProvider(props: CallProviderProps): Element

參數

props
CallProviderProps

傳回

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite 將重要元件結合在一起，以提供現成聊天體驗的完整通話。

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

參數

props
CallWithChatCompositeProps

傳回

Element

CameraButton(CameraButtonProps)

開啟/關閉相機的按鈕。

可以搭配 ControlBar使用。

function CameraButton(props: CameraButtonProps): Element

參數

props
CameraButtonProps

傳回

Element

ChatClientProvider(ChatClientProviderProps)

儲存 StatefulChatClient的 <xref:React.Context>。

此套件中的聊天元件必須包裝 ChatClientProvider。

function ChatClientProvider(props: ChatClientProviderProps): Element

參數

props
ChatClientProviderProps

傳回

Element

ChatComposite(ChatCompositeProps)

聊天體驗的可自定義UI複合。

function ChatComposite(props: ChatCompositeProps): Element

參數

props
ChatCompositeProps

傳回

Element

備註

聊天複合最小寬度和高度分別為 17.5rem 和 20rem（280px 和 320px，預設 rem 為 16px）

ChatThreadClientProvider(ChatThreadClientProviderProps)

儲存 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>的 <xref:React.Context>。

此套件中的聊天元件必須包裝 ChatThreadClientProvider。

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

參數

props
ChatThreadClientProviderProps

傳回

Element

ControlBar(ControlBarProps)

呼叫控件之各種按鈕的容器。

請搭配此連結庫中的各種呼叫控件按鈕使用，例如，CameraButton，或直接 ControlBarButton 的實例。

function ControlBar(props: ControlBarProps): Element

參數

props
ControlBarProps

傳回

Element

ControlBarButton(ControlBarButtonProps)

ControlBar的預設按鈕樣式。

使用此元件建立自定義按鈕，其樣式與UI連結庫所提供的其他按鈕相同。

function ControlBarButton(props: ControlBarButtonProps): Element

參數

props
ControlBarButtonProps

傳回

Element

DevicesButton(DevicesButtonProps)

開啟控制裝置選項之功能表的按鈕。

可以搭配 ControlBar使用。

function DevicesButton(props: DevicesButtonProps): Element

參數

props
DevicesButtonProps

傳回

Element

EndCallButton(EndCallButtonProps)

結束進行中呼叫的按鈕。

可以搭配 ControlBar使用。

function EndCallButton(props: EndCallButtonProps): Element

參數

props
EndCallButtonProps

傳回

Element

ErrorBar(ErrorBarProps)

在UI上顯示錯誤訊息的元件。 所有可以顯示的字串都會接受為 字串，以便進行當地語系化。 activeErrorMessages選取使用中的錯誤。

此元件會在內部追蹤使用者關閉的追蹤。

  • 具有相關聯時間戳的錯誤：如果在關閉之後發生錯誤，UI 上會再次顯示錯誤。
  • 沒有時間戳的錯誤：錯誤會關閉，直到它從 props 消失為止。 如果錯誤遞歸，則會顯示在UI中。

使用 <xref:%40fluentui%2Freact%23MessageBar> UI 元素。

function ErrorBar(props: ErrorBarProps): Element

參數

props
ErrorBarProps

傳回

Element

FluentThemeProvider(FluentThemeProviderProps)

提供者，將 Fluent 主題套用至此連結庫的 react 元件。

function FluentThemeProvider(props: FluentThemeProviderProps): Element

參數

props
FluentThemeProviderProps

傳回

Element

備註

此連結庫中的元件主要來自 Fluent UI、控件，以及來自 Fluent React Northstar 控件 。 此提供者會處理將任何提供的主題套用至基礎 Fluent UI 控件，以及 Fluent React Northstar 控件。

GridLayout(GridLayoutProps)

在通話中配置音訊/視訊參與者磚的元件。

function GridLayout(props: GridLayoutProps): Element

參數

props
GridLayoutProps

傳回

Element

LocalizationProvider(LocalizationProviderProps)

提供此連結庫 react 元件的當地語系化字串提供者。

function LocalizationProvider(props: LocalizationProviderProps): Element

參數

props
LocalizationProviderProps

傳回

Element

備註

如果未使用此提供者，預設會以英文 （US） 提供元件本地化字串。

MessageStatusIndicator(MessageStatusIndicatorProps)

顯示已傳送訊息狀態的元件。

新增對應至訊息狀態的圖示和工具提示。

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

參數

props
MessageStatusIndicatorProps

傳回

Element

MessageThread(MessageThreadProps)

MessageThread 可讓您輕鬆地建立元件來轉譯聊天訊息、處理新/舊訊息的捲動行為，以及自定義聊天對話內控件 & 圖示。

function MessageThread(props: MessageThreadProps): Element

參數

props
MessageThreadProps

類型為 MessageThreadProps

使用者至少必須提供聊天訊息和userId，才能轉譯 MessageThread 元件。 使用者也可以藉由傳入自己的虛擬人偶、MessageStatusIndicator 圖示、JumpToNewMessageButton、LoadPreviousMessagesButton 和這些控件的行為，來自定義 MessageThread。

MessageThread 在內部使用來自 @fluentui/react-northstar的 Chat & Chat.Message 元件。 您可以簽出這兩個元件 的詳細資料，。

傳回

Element

MicrophoneButton(MicrophoneButtonProps)

開啟/關閉麥克風的按鈕。

可以搭配 ControlBar使用。

function MicrophoneButton(props: MicrophoneButtonProps): Element

參數

props
MicrophoneButtonProps

傳回

Element

ParticipantItem(ParticipantItemProps)

用來轉譯通話或聊天參與者的元件。

顯示參與者的虛擬人偶、displayName 和狀態，以及選用的圖示和操作功能表。

function ParticipantItem(props: ParticipantItemProps): Element

參數

props
ParticipantItemProps

傳回

Element

ParticipantList(ParticipantListProps)

用來轉譯所有通話或聊天參與者的元件。

根據預設，每個參與者都會以 ParticipantItem轉譯。 請參閱要覆寫的 <xref:ParticipantListProps.onRenderParticipant>。

function ParticipantList(props: ParticipantListProps): Element

參數

props
ParticipantListProps

傳回

Element

ParticipantsButton(ParticipantsButtonProps)

顯示具有通話或聊天參與者之功能表的按鈕。

可以搭配 ControlBar使用。

此按鈕包含透過其屬性 menuProps定義的下拉功能表專案。 根據預設，它可以將完整清單顯示為子功能表的遠端參與者數目，以及將所有參與者設為靜音的選項，以及複製到剪貼簿按鈕來複製通話邀請 URL。 此 menuProps 可以完全重新定義，而且其 屬性的類型為 IContextualMenuProps。

function ParticipantsButton(props: ParticipantsButtonProps): Element

參數

props
ParticipantsButtonProps

傳回

Element

ScreenShareButton(ScreenShareButtonProps)

啟動/停止螢幕共用的按鈕。

可以搭配 ControlBar使用。

function ScreenShareButton(props: ScreenShareButtonProps): Element

參數

props
ScreenShareButtonProps

傳回

Element

SendBox(SendBoxProps)

輸入和傳送訊息的元件。

支持當用戶開始輸入文字時傳送輸入通知。 支援文字輸入欄位下方的選擇性訊息。

function SendBox(props: SendBoxProps): Element

參數

props
SendBoxProps

傳回

Element

StreamMedia(StreamMediaProps)

公用程式元件，可將具有視訊數據流的 HTMLElement 轉換成 JSX 元素。

使用 將無外設呼叫 API 傳回的 HTMLElement 轉換成可轉譯為 VideoTile的元件。

function StreamMedia(props: StreamMediaProps): Element

參數

props
StreamMediaProps

傳回

Element

TypingIndicator(TypingIndicatorProps)

元件，以在聊天對話中的一或多個參與者輸入時通知本機使用者。

function TypingIndicator(props: TypingIndicatorProps): Element

參數

props
TypingIndicatorProps

傳回

Element

VideoGallery(VideoGalleryProps)

VideoGallery 代表特定通話的視訊磚配置。 它會顯示本機使用者的 VideoTile，以及已加入通話的每個遠端參與者。

function VideoGallery(props: VideoGalleryProps): Element

參數

props
VideoGalleryProps

傳回

Element

VideoTile(VideoTileProps)

要轉譯單一通話參與者視訊數據流的元件。

在 VideoGallery中搭配 GridLayout 使用。

function VideoTile(props: VideoTileProps): Element

參數

props
VideoTileProps

傳回

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

建立 Azure 通訊服務支援的 CallAdapter。

這是此連結庫提供 CallAdapter 的預設實作。

注意：displayName 最多可以有 256 個字元。

function createAzureCommunicationCallAdapter(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>

參數

__namedParameters
AzureCommunicationCallAdapterArgs

傳回

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

使用提供的 StatefulCallClient建立 CallAdapter。

如果您想要保留 StatefulCallClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallAdapter。

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator): Promise<CallAdapter>

參數

callClient
StatefulCallClient
callAgent
CallAgent
locator
CallAdapterLocator

傳回

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

建立 Azure 通訊服務支援的 CallWithChatAdapter，以插入 CallWithChatComposite。

function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>

參數

__namedParameters
AzureCommunicationCallWithChatAdapterArgs

傳回

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

使用提供的 StatefulChatClient 和 StatefulCallClient建立 CallWithChatAdapter。

如果您想要保留 StatefulChatClient 和 StatefulCallClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallWithChatAdapter。

function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>

參數

__namedParameters
AzureCommunicationCallWithChatAdapterFromClientArgs

傳回

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

建立由 Azure 通訊服務支援的 ChatAdapter。

這是此連結庫提供 ChatAdapter 的預設實作。

function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>

參數

__namedParameters
AzureCommunicationChatAdapterArgs

傳回

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

使用提供的 StatefulChatClient建立 ChatAdapter。

如果您想要保留 StatefulChatClient的參考，則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationChatAdapter。

function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>

參數

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

傳回

Promise<ChatAdapter>

createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

為小組通話建立 CallHandlers 的預設實作。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call): CallingHandlers

參數

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

傳回

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

建立 ChatHandlers的預設實作。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

傳回的物件已備忘，以避免在做為 React 元件之 props 時重新調整。

function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers

參數

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

傳回

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

使用 ProxyCallClient <xref:ProxyCallClient> ProxyClient <xref:%40azure%2Fcommunication-calling%23CallClient> ProxyCallClient <xref:ProxyCallClient>，以宣告方式建立 StatefulCallClient StatefulCallClient。

請務必使用從 StatefulCallClient 取得的 <xref:%40azure%2Fcommunication-calling%23DeviceManager> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 <xref:%40azure%2Fcommunication-calling%23Call>（等），以便正確處理其狀態變更。

function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient

參數

args
StatefulCallClientArgs

StatefulCallClientArgs

options
StatefulCallClientOptions

StatefulCallClientOptions

傳回

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

使用 ProxyChatClient <xref:ProxyChatClient> ProxyClient <xref:%40azure%2Fcommunication-chat%23ChatClient> proxyChatClient <xref:ProxyChatClient> 建立具狀態的 ChatClient StatefulChatClient，然後允許以宣告式方式存取狀態。

function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient

參數

args
StatefulChatClientArgs
options
StatefulChatClientOptions

傳回

StatefulChatClient

fromFlatCommunicationIdentifier(string)

至FlatCommunicationIdentifier的反向作業。

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

參數

id

string

傳回

CommunicationIdentifier

getCallingSelector<Component>(Component)

取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function getCallingSelector<Component>(component: Component): GetCallingSelector<Component>

參數

component

Component

傳回

GetCallingSelector<Component>

getChatSelector<Component>(Component)

取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function getChatSelector<Component>(component: Component): GetChatSelector<Component>

參數

component

Component

傳回

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>的字串表示。

此 CommunicationIdentifier 的字串表示法保證對唯一的通訊使用者而言是穩定的。 因此

  • 它可用來將使用者的身分識別保存在外部資料庫中。
  • 它可以當做對應中的索引鍵來儲存用戶的數據。
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

參數

identifier
CommunicationIdentifier

傳回

string

useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

自定義 React 攔截，可簡化 CallAdapter的建立。

類似於 createAzureCommunicationCallAdapter，但會負責在內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。

function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter

參數

args

Partial<AzureCommunicationCallAdapterArgs>

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

傳回

undefined | CallAdapter

useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

自定義 React 攔截，可簡化 CallWithChatAdapter的建立。

類似於 createAzureCommunicationCallWithChatAdapter，但會負責在內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。

function useAzureCommunicationCallWithChatAdapter(args: Partial<AzureCommunicationCallWithChatAdapterArgs>, afterCreate?: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, beforeDispose?: (adapter: CallWithChatAdapter) => Promise<void>): undefined | CallWithChatAdapter

參數

args

Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

傳回

undefined | CallWithChatAdapter

useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

自定義 React 攔截，可簡化 ChatAdapter的建立。

類似於 createAzureCommunicationChatAdapter，但會負責內部異步建立配接器。

允許未定義自變數，讓您可以遵守連結規則，並在建立自變數時傳入自變數。 只有在定義所有自變數時，才會建立配接器。

請注意，您必須備忘自變數，以避免在每個轉譯上重新建立配接器。 如需一般使用範例，請參閱劇本。

function useAzureCommunicationChatAdapter(args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: (adapter: ChatAdapter) => Promise<ChatAdapter>, beforeDispose?: (adapter: ChatAdapter) => Promise<void>): undefined | ChatAdapter

參數

args

Partial<AzureCommunicationChatAdapterArgs>

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

傳回

undefined | ChatAdapter

useCall()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23Call>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

您先前必須已搭配 Call 物件使用 CallProvider，才能使用此攔截

function useCall(): undefined | Call

傳回

undefined | Call

useCallAgent()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23CallAgent>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useCallAgent(): undefined | CallAgent

傳回

undefined | CallAgent

useCallClient()

攔截 以從提供者取得 StatefulCallClient。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useCallClient(): StatefulCallClient

傳回

StatefulCallClient

useChatClient()

Hook 以從提供者取得 StatefulChatClient。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useChatClient(): StatefulChatClient

傳回

StatefulChatClient

useChatThreadClient()

攔截以從提供者取得 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useChatThreadClient(): ChatThreadClient

傳回

ChatThreadClient

useDeviceManager()

Hook 以從提供者取得 StatefulDeviceManager。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useDeviceManager(): undefined | StatefulDeviceManager

傳回

undefined | StatefulDeviceManager

usePropsFor<Component>(Component, "chat" | "calling")

從這個連結庫取得 React 元件所需的所有連結的主要勾點。

若要呼叫此攔截，元件必須包裝在這些提供者下：

  1. 針對聊天元件：ChatClientProvider 和 ChatThreadClientProvider。

  2. 針對呼叫元件：CallClientProvider、CallAgentProvider 和 CallAgentProvider。

元件最直接的使用方式如下所示：

範例

    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>

參數

component

Component

type

"chat" | "calling"

傳回

ComponentProps<Component>

useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

勾點以取得指定元件的選取器。

實作利用從此連結庫導出之提供者的自定義元件時很有用。

function useSelector<ParamT>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), type?: "chat" | "calling"): (ParamT extends Selector ? ReturnType<ParamT> : undefined)

參數

selector

ParamT

selectorProps

(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)

type

"chat" | "calling"

傳回

(ParamT extends Selector ? ReturnType<ParamT> : undefined)

useTheme()

回應連結以存取主題

function useTheme(): Theme

傳回

Theme