@azure/communication-react package
介面
| AcceptedTransfer |
傳輸功能狀態 |
| ActiveErrorMessage |
透過 ErrorBar顯示的作用中錯誤訊息。 |
| ActiveNotification |
將通過 NotificationStack 顯示的活動通知。 |
| AdapterError |
透過錯誤事件報告並儲存在配接器狀態的錯誤。 |
| AdapterNotification |
來自調用客戶端狀態的通知存儲在適配器狀態中。 |
| AdapterState |
與複合配接器狀態互動的功能。 |
| AttachmentMetadata |
表示聊天消息附件的數據模型,其中包含用於唯一標識附件的ID、表示檔名的名稱以及用於下載附件的URL。 |
| BaseCompositeProps |
從這個連結庫導出之所有複合的通用屬性。 |
| BaseCustomStyles |
從這個連結庫導出之所有元件的基本 Fluent 樣式屬性。 |
| BreakoutRoomsState |
分組討論室狀態 |
| CallAdapter | |
| 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 狀態可供開發人員使用,並由開發人員完全控制及設定。 |
| CallCompositeLoaderProps |
Props 的 Props 中,您可以在應用程式中使用的 OutboundCallComposite 的 Props 中實現。 包含兩個可選袋: |
| CallCompositeProps |
CallComposite的 Props。 |
| CallCompositeStrings |
除了元件連結庫的元件所使用的字串之外,此字串也一並列出。 |
| CallFeatureStreamState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>。 表示呼叫特徵流狀態。 |
| CallInfoState |
State 來跟蹤類型和<xref:CallInfo><xref:TeamsCallInfo> |
| CallNotification | |
| CallProviderProps |
初始化 CallProvider的自變數。 |
| CallState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23Call>。 StatefulCallClient 會自動擷取呼叫的狀態,並將它新增至 statefulCallClient 所公開的狀態。 |
| CallSurveyImprovementSuggestions |
表示呼叫調查的改進建議部分 |
| CallWithChatAdapter |
CallWithChatComposite Adapter 介面。 |
| CallWithChatAdapterManagement |
使用聊天管理目前通話的功能。 |
| CallWithChatAdapterState |
CallWithChat State 是具狀態聊天和具狀態通話客戶端的組合,只有 CallWithChat 複合的特定狀態。 |
| CallWithChatAdapterSubscriptions |
可在 CallWithChatAdapter中訂閱的通話和聊天事件。 |
| CallWithChatAdapterUiState |
與 CallWithChatComposite相關的 UI 狀態。 |
| CallWithChatClientState |
來自驅動 CallWithChatComposite的後端服務的狀態。 |
| CallWithChatCompositeLoaderProps |
可在應用程式中使用的 CallWithChatComposite 的 props。 包含兩個可選袋:
|
| CallWithChatCompositeProps |
CallWithChatComposite 所需的屬性 |
| CallWithChatCompositeStrings |
CallWithChatComposite 所使用的字串。 除了元件連結庫的元件所使用的字串之外,此字串也一並列出。 |
| CallWithChatControlOptions |
使用聊天體驗進行呼叫時控件欄的自定義選項。 |
| CallingHandlers |
物件,包含呼叫元件所需的所有處理程式。 從這個封裝呼叫相關的元件,可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。 |
| CallingTheme |
通過調用此庫中的相關元件使用的自定義 Fluent 主題調色板。 |
| CameraButtonContextualMenuStyles |
CameraButton 功能表的樣式。 |
| CameraButtonProps |
CameraButton 元件的 Props。 |
| CameraButtonStrings |
可以覆寫的 CameraButton 字串。 |
| CameraButtonStyles |
CameraButton 的樣式 |
| CapabilitiesFeatureState |
的 僅限狀態版本 <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature> |
| CapabilityChangedNotificationStrings |
功能更改通知的字串 |
| CaptionLanguageStrings |
captions 設置模式的 caption language strings for captions setting |
| CaptionsBannerProps |
CaptionsBanner 元件 props。 |
| CaptionsBannerStrings |
標題橫幅的字串 |
| CaptionsCallFeatureState | |
| CaptionsInfo | |
| CaptionsSettingsModalProps |
CaptionsSettingsModal 元件道具。 |
| CaptionsSettingsModalStrings |
Strings for captions 設置 modal |
| ChatAdapterSubscribers |
可訂閱的聊天複合事件。 |
| ChatAdapterThreadManagement |
管理目前聊天對話的功能。 |
| ChatCompositeLoaderProps |
可在應用程式中使用的 ChatComposite 的 props。 包含 ChatCompositeChatCompositeOptions 的選項。 |
| ChatCompositeProps |
ChatComposite的 Props。 |
| ChatCompositeStrings |
ChatComposite 所使用的字串。 除了元件連結庫的元件所使用的字串之外,此字串也一並列出。 |
| ChatMessage |
聊天訊息。 |
| CommonCallAdapter |
CallComposite Adapter 介面。 |
| CommonCallingHandlers |
物件,包含呼叫元件所需的所有處理程式。 從這個封裝呼叫相關的元件,可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。 |
| ComponentLocale |
從這個連結庫導出之所有元件的地區設定資訊。 |
| ComponentStrings |
從這個連結庫導出的所有元件所使用的字串。 |
| CompositeLocale |
從這個連結庫導出之所有複合的地區設定資訊。 |
| CompositeStrings |
直接在複合中使用的字串。 這些字串會由複合直接使用,而不是由包含的元件使用。 |
| ConferencePhoneInfo |
會議電話資訊資訊 |
| ContentSystemMessage |
具有仲裁內容的系統訊息。 |
| ControlBarButtonProps |
ControlBarButton的 Props。 |
| ControlBarButtonStrings |
可覆寫 ControlBarButton 字串。 |
| ControlBarProps |
ControlBar的 Props。 |
| CreateVideoStreamViewResult |
建立本機或遠端 VideoStream 之後傳回的物件。 這包含可操作數據流轉譯的協助程式函式。 |
| CustomCallControlButtonCallbackArgs | |
| CustomCallControlButtonProps |
來自 CustomCallControlButtonCallback 的回應。 包括渲染 ControlBarButton 或 <xref:DrawerMenuItem>. |
| CustomCallControlButtonStrings |
CustomCallControlButtons 的字串 |
| CustomMessage |
自訂訊息類型。 自定義訊息預設不會轉譯,但應用程式可以提供自定義轉譯器。 |
| DevicesButtonContextualMenuStyles |
DevicesButton 功能表的樣式。 |
| DevicesButtonProps |
DevicesButton的 Props。 |
| DevicesButtonStrings |
可覆寫的 DevicesButton 字串。 |
| DevicesButtonStyles |
[裝置] 按鈕功能表項的樣式。 |
| DiagnosticsCallFeatureState |
僅限 <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>的 Proxy 狀態。 |
| DialpadProps |
Dialpad 元件的 props。 |
| DialpadStrings |
可以覆蓋的 Dialpad 字串。 |
| DialpadStyles |
Dialpad 元件的樣式。 |
| Disposable |
正確處置複合的功能。 |
| DtmfDialPadOptions |
用於確定 CallComposite 中 dtmfDialer 的呈現行為的選項 |
| 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 元件樣式。 |
| HoldButtonProps | |
| HoldButtonStrings |
用於保持按鈕標籤的字串 |
| HorizontalGalleryStyles |
<xref:HorizontalGallery> 元件樣式。 |
| ImageOverlayProps |
ImageOverlay 的 props 中。 |
| ImageOverlayStrings |
可以重寫的 ImageOverlay 字串。 |
| IncomingCallNotificationProps |
來電通知元件的屬性。 |
| IncomingCallNotificationStrings |
來電通知元件的字串。 |
| IncomingCallNotificationStyles |
來電通知元件的樣式。 |
| IncomingCallStackCall |
表示活動的來電。 |
| IncomingCallStackProps |
IncomingCallManager 元件的 props。 |
| IncomingCallState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23IncomingCall>。 StatefulCallClient 會自動偵測來電,並將其狀態新增至 statefulCallClient 所公開的狀態。 |
| InlineImage |
InlineImage 的狀態,如 UI 中所示。 |
| InlineImageOptions |
用於在內嵌圖像場景中顯示內嵌圖像的選項。 |
| JoinCallOptions |
加入通話時設置麥克風和攝像頭狀態的選項 true = 加入通話時打開設備 false = 加入通話時關閉設備 'keep'/undefined = 保留設備的呼叫前狀態 |
| JumpToNewMessageButtonProps |
<xref:MessageThreadProps.onRenderJumpToNewMessageButton>的自變數。 |
| LocalVideoCameraCycleButtonProps | |
| LocalVideoStreamState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>。 |
| LocalVideoStreamVideoEffectsState |
LocalVideoStream 的 <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>. |
| LocalVideoTileOptions |
Call composite(通話合成)中本地視頻磁貼的選項。 |
| MediaAccessState |
媒體訪問狀態 |
| MediaDiagnosticsState |
僅限 <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>的 Proxy 狀態。 |
| MeetingConferencePhoneInfoModalStrings |
Phone Info 模式的字串 |
| 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 狀態。 |
| NotificationOptions |
用於控制複合中通知的選項。 |
| NotificationProps |
通知的 props 中。 |
| NotificationStackProps |
NotificationStack 的 props 來獲取。 |
| NotificationStackStrings |
可能在 NotificationStack 的 UI 上顯示的所有字串。 |
| NotificationStrings |
通知的 UI 上可能顯示的所有字串。 |
| NotificationStyles |
通知元件的樣式。 |
| OptimalVideoCountFeatureState |
最佳視訊計數功能 <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>的僅限狀態版本 。 |
| OptionsDevice |
裝置,例如相機、麥克風或喇叭,位於 DevicesButton 飛出視窗。 |
| OutboundCallCompositeLoaderProps |
Props 的 Props 中,您可以在應用程式中使用的 OutboundCallComposite 的 Props 中實現。 包含兩個可選袋: |
| PPTLiveCallFeatureState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>。 StatefulCallClient 會自動監聽通話中的 pptLive,並相應地更新 StatefulCallClient 暴露的狀態。 |
| ParticipantAddedSystemMessage |
系統訊息,通知參與者已新增至聊天對話。 |
| ParticipantItemProps |
ParticipantItem的 Props。 |
| ParticipantItemStrings |
可覆寫 ParticipantItem 字串。 |
| ParticipantItemStyles |
ParticipantItem的 Fluent 樣式。 |
| ParticipantListItemStyles | |
| ParticipantListStyles |
ParticipantList的樣式。 |
| ParticipantRemovedSystemMessage |
系統訊息,通知參與者已從聊天對話中移除。 |
| ParticipantsButtonContextualMenuStyles |
ParticipantsButton 功能表的樣式。 |
| ParticipantsButtonProps |
ParticipantsButton的 Props。 |
| ParticipantsButtonStrings |
可覆寫的 ParticipantsButton 字串。 |
| ParticipantsButtonStyles |
ParticipantsButton的樣式屬性。 |
| RaiseHandButtonProps |
RaiseHandButton 的 props 中。 |
| RaiseHandButtonStrings |
可以重寫的 RaiseHandButton 字串。 |
| RaiseHandCallFeature |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>。 StatefulCallClient 將自動監聽調用中的舉手,並相應地更新 StatefulCallClient 公開的狀態。 |
| ReactionButtonProps |
ReactionButton 的 props 中。 |
| ReactionButtonStrings |
可以重寫的 ReactionButton 字串。 |
| ReactionResources |
動畫 Sprite 圖像和相關元數據的介面 |
| RealTimeTextCallFeatureState | |
| RealTimeTextInfo | |
| RealTimeTextModalProps |
RealTimeTextModal 元件屬性。 |
| RealTimeTextModalStrings |
realTimeText 模態框的字串 |
| RealTimeTextProps |
Props 的命令。 |
| RealTimeTextStrings |
RTT 字串 |
| RecordingCallFeature |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>。 StatefulCallClient 會自動接聽通話的錄製狀態,並據以更新 statefulCallClient 所公開的狀態。 |
| RemoteParticipantState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>。 StatefulCallClient 會自動擷取 RemoteParticipants,並將其狀態新增至 statefulCallClient 所公開的狀態。 |
| RemoteVideoStreamState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>。 |
| RemoteVideoTileMenuOptions |
VideoGallery 中遠端視頻拼貼的功能表選項。 |
| ScreenShareButtonProps |
ScreenShareButton的 Props。 |
| ScreenShareButtonStrings |
可覆寫的 ScreenShareButton 字串。 |
| SendBoxProps |
SendBox的 Props。 |
| SendBoxStrings | |
| SendBoxStylesProps |
<xref:Sendbox>的 Fluent 樣式。 |
| SpokenLanguageStrings |
字幕設置的口語字串 modal |
| SpotlightCallFeatureState |
的 僅限狀態版本 <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature> |
| SpotlightPromptStrings |
與spotlight相關的提示中使用的字串 |
| SpotlightState |
帶順序的Spotlight狀態 |
| StartCaptionsAdapterOptions |
傳遞給 adapter.startCaptions 的選項 |
| StartCaptionsButtonProps | |
| StartCaptionsButtonStrings |
用於保持按鈕標籤的字串 |
| StartRealTimeTextButtonProps |
StartRealTimeTextButton 元件的 props |
| StartRealTimeTextButtonStrings |
用於保持按鈕標籤的字串 |
| StatefulCallClient |
定義可讓 CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> 具狀態使用的方法。 介面提供對 Proxy 狀態的存取權,也允許註冊狀態變更事件的處理程式。 如需狀態定義,請參閱 CallClientState。 狀態變更事件是由:
|
| StatefulChatClient |
定義方法,允許 {@Link @azure/communication-chat#ChatClient}与集中式产生状态搭配使用。 介面提供對 Proxy 狀態的存取權,也允許註冊狀態變更事件的處理程式。 |
| StatefulDeviceManager |
定義由具狀態在 <xref:%40azure%2Fcommunication-calling%23DeviceManager>上新增的其他方法。 |
| StopCaptionsAdapterOptions |
傳遞給 adapter.stopCaptions 的選項 |
| StreamMediaProps |
StreamMedia的 Props。 |
| SurveyIssues |
每個呼叫問題的相應文本 |
| SurveyIssuesHeadingStrings |
每個呼叫問題類別對應的文字 |
| SystemMessageCommon |
所有系統訊息的通用屬性。 |
| TeamsCallAdapter |
特定於 Teams 標識的 Adapter 介面,用於擴展 CommonCallAdapter。 |
| TeamsCallingHandlers |
包含調用元件所需的所有 teams 調用處理程式的物件。 從這個封裝呼叫相關的元件,可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor。 |
| TeamsIncomingCallState |
的 僅限狀態版本 <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> |
| TogetherModeCallFeatureState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>。 StatefulCallClient 的 表示 Together Mode (一起模式) 功能的狀態。 |
| TogetherModeSeatingPositionState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>。 表示參與者在TogetherMode中的就座位置。 |
| TogetherModeStreamOptions |
表示 Together Mode 流檢視結果的介面。 |
| TogetherModeStreamViewResult |
表示 Together Mode 流檢視結果的介面。 |
| TogetherModeStreamsState |
表示 Together Mode 中的流。 |
| TopicUpdatedSystemMessage |
通知聊天對話主題已更新的系統訊息。 |
| TranscriptionCallFeature |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>。 StatefulCallClient 會自動接聽呼叫的轉譯狀態,並據以更新 statefulCallClient 所公開的狀態。 |
| TransferFeature |
傳輸功能狀態 |
| TypingIndicatorProps |
TypingIndicator的 Props。 |
| TypingIndicatorStrings |
可以覆寫的 TypingIndicator 字串。 |
| TypingIndicatorStylesProps |
TypingIndicator的 Fluent 樣式。 |
| VerticalGalleryControlBarStyles |
VerticalGallery 元件內控件欄的樣式 |
| VerticalGalleryStrings |
用於垂直庫本地化的字串。 |
| VerticalGalleryStyles |
VerticalGallery 元件的樣式 |
| VideoBackgroundBlurEffect |
包含模糊視頻背景效果的屬性 |
| VideoBackgroundImage |
包含背景圖像的屬性,如url、name等。 |
| VideoBackgroundNoEffect |
包含刪除視頻背景效果的屬性 |
| VideoBackgroundReplacementEffect |
包含所選取影片背景效果的屬性 |
| VideoGalleryLocalParticipant | |
| VideoGalleryProps |
VideoGallery的道具。 |
| VideoGalleryRemoteParticipant |
VideoGallery中遠端參與者的狀態。 |
| VideoGalleryStream |
VideoGallery中參與者的視訊串流。 |
| VideoGalleryStrings |
VideoGallery中 UI 上可能顯示的所有字串。 |
| VideoGalleryStyles |
VideoGallery 元件樣式。 |
| VideoGalleryTogetherModeSeatingInfo |
表示 Together Mode 中的座位資訊的介面。 |
| VideoGalleryTogetherModeStreams |
表示 Together Mode 中的流的介面。 |
| VideoStreamOptions |
控制影片串流呈現方式的選項。 |
| VideoStreamRendererViewState |
只限狀態版本的 <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>。 此屬性會新增至由 createView createViewStatefulCallClient 公開的狀態,disposeView移除。 |
| VideoTileContextualMenuProps |
用於在 VideoGallery 中顯示遠端 VideoTile 元件的上下文選單的屬性。 |
| VideoTileDrawerMenuProps |
在 VideoGallery 中長按遠端 VideoTile 上顯示抽屜功能表的屬性。 |
| VideoTileProps |
VideoTile的 Props。 |
| VideoTileStrings |
可以重寫的 VideoTile 字串。 |
| VideoTileStylesProps |
VideoTile的 Fluent 樣式。 |
| VideoTilesOptions |
適用於 VideoGallery 中所有視頻圖塊的選項 |
類型別名
函式
函式詳細資料
CallAgentProvider(CallAgentProviderProps)
儲存 <xref:React.Context>的 <xref:%40azure%2Fcommunication-calling%23CallAgent>。
從此封裝呼叫元件時,必須包裝 CallAgentProvider。
function CallAgentProvider(props: CallAgentProviderProps): Element
參數
- props
- CallAgentProviderProps
傳回
Element
CallClientProvider(CallClientProviderProps)
從此封裝呼叫元件時,必須使用 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:React.Context>的 <xref:%40azure%2Fcommunication-calling%23Call>。
從此封裝呼叫元件時,必須使用 CallProvider包裝。
function CallProvider(props: CallProviderProps): Element
參數
- props
- CallProviderProps
傳回
Element
CallWithChatComposite(CallWithChatCompositeProps)
CallWithChatComposite 將重要元件結合在一起,以提供現成聊天體驗的完整通話。
function CallWithChatComposite(props: CallWithChatCompositeProps): Element
參數
傳回
Element
CameraButton(CameraButtonProps)
開啟/關閉相機的按鈕。
可以搭配 ControlBar使用。
function CameraButton(props: CameraButtonProps): Element
參數
- props
- CameraButtonProps
傳回
Element
CaptionsBanner(CaptionsBannerProps)
一個元件,用於顯示帶有用戶圖示、displayName 和字幕文本的 CaptionsBanner。
function CaptionsBanner(props: CaptionsBannerProps): Element
參數
- props
- CaptionsBannerProps
傳回
Element
CaptionsSettingsModal(CaptionsSettingsModalProps)
用於設置口語的元件
function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element
參數
傳回
Element
ChatClientProvider(ChatClientProviderProps)
此套件中的聊天元件必須包裝 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:React.Context>的 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>。
此套件中的聊天元件必須包裝 ChatThreadClientProvider。
function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element
參數
傳回
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
Dialpad(DialpadProps)
允許使用者通過按下撥號盤/使用鍵盤輸入電話號碼的元件它將返回空元件以進行穩定構建
function Dialpad(props: DialpadProps): Element
參數
- props
- DialpadProps
傳回
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、控件、混合 v8 和 v9 控件組成。 此提供程式處理應用提供給基礎 Fluent UI 控制件的任何主題。 *
GridLayout(GridLayoutProps)
在通話中配置音訊/視訊參與者磚的元件。
function GridLayout(props: GridLayoutProps): Element
參數
- props
- GridLayoutProps
傳回
Element
HoldButton(HoldButtonProps)
用於保持或恢復正在進行的呼叫的按鈕。
可與 ControlBar 一起使用
function HoldButton(props: HoldButtonProps): Element
參數
- props
- HoldButtonProps
hold (保持) 按鈕的屬性。
傳回
Element
ImageOverlay(ImageOverlayProps)
元件,用於渲染選定圖像的全屏模式。
function ImageOverlay(props: ImageOverlayProps): Element
參數
- props
- ImageOverlayProps
傳回
Element
IncomingCallNotification(IncomingCallNotificationProps)
一個 Notification 元件,用於表示對最終使用者的傳入調用。 允許使用者接受或拒絕來電。
function IncomingCallNotification(props: IncomingCallNotificationProps): Element
參數
傳回
Element
IncomingCallStack(IncomingCallStackProps)
用於管理多個傳入呼叫的包裝器
function IncomingCallStack(props: IncomingCallStackProps): Element
參數
- props
- IncomingCallStackProps
<xref:IncomingCallManagerProps>
傳回
Element
LocalizationProvider(LocalizationProviderProps)
提供此連結庫 react 元件的當地語系化字串提供者。
function LocalizationProvider(props: LocalizationProviderProps): Element
參數
傳回
Element
備註
如果未使用此提供者,預設會以英文 (US) 提供元件本地化字串。
MessageStatusIndicator(MessageStatusIndicatorProps)
顯示已傳送訊息狀態的元件。
新增對應至訊息狀態的圖示和工具提示。
function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element
參數
傳回
Element
MessageThread(MessageThreadProps)
MessageThread 可讓您輕鬆地建立元件來轉譯聊天訊息、處理新/舊訊息的捲動行為,以及自定義聊天對話內控件 & 圖示。
function MessageThread(props: MessageThreadProps): Element
參數
- props
- MessageThreadProps
類型為 MessageThreadProps
使用者至少必須提供聊天訊息和userId,才能轉譯 MessageThread 元件。
使用者也可以藉由傳入自己的虛擬人偶、MessageThread 圖示、MessageStatusIndicator、JumpToNewMessageButton 和這些控件的行為,來自定義 LoadPreviousMessagesButton。
MessageThread 內部使用 Chat 來自 @fluentui-contrib/chat的元件。 您可以 在此處查看有關這些元件的詳細資訊。
傳回
Element
MicrophoneButton(MicrophoneButtonProps)
開啟/關閉麥克風的按鈕。
可以搭配 ControlBar使用。
function MicrophoneButton(props: MicrophoneButtonProps): Element
參數
- props
- MicrophoneButtonProps
傳回
Element
Notification(NotificationProps)
用於在UI上顯示通知消息的元件。
function Notification(props: NotificationProps): Element
參數
- props
- NotificationProps
傳回
Element
NotificationStack(NotificationStackProps)
用於在 UI 上顯示通知的元件。 所有可以顯示的字串都會接受為 字串,以便進行當地語系化。 活動通知由 activeNotifications 選擇。
此元件會在內部追蹤使用者關閉的追蹤。
- 具有關聯時間戳的通知:如果在關閉后發生通知,則會再次顯示在UI上。
- 沒有時間戳的通知:通知將被關閉,直到它從 prop 中消失。 如果通知再次出現,則會顯示在UI中。
function NotificationStack(props: NotificationStackProps): Element
參數
- props
- NotificationStackProps
傳回
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
RaiseHandButton(RaiseHandButtonProps)
啟動/停止螢幕共用的按鈕。
可以搭配 ControlBar使用。
function RaiseHandButton(props: RaiseHandButtonProps): Element
參數
- props
- RaiseHandButtonProps
傳回
Element
ReactionButton(ReactionButtonProps)
用於發送回應的按鈕。
可以搭配 ControlBar使用。
function ReactionButton(props: ReactionButtonProps): Element
參數
- props
- ReactionButtonProps
傳回
Element
RealTimeText(RealTimeTextProps)
用於顯示單行 RealTimeText 的元件
function RealTimeText(props: RealTimeTextProps): Element
參數
- props
- RealTimeTextProps
傳回
Element
RealTimeTextModal(RealTimeTextModalProps)
realTimeText 模態框的元件
function RealTimeTextModal(props: RealTimeTextModalProps): Element
參數
- props
- RealTimeTextModalProps
傳回
Element
ScreenShareButton(ScreenShareButtonProps)
啟動/停止螢幕共用的按鈕。
可以搭配 ControlBar使用。
function ScreenShareButton(props: ScreenShareButtonProps): Element
參數
- props
- ScreenShareButtonProps
傳回
Element
SendBox(SendBoxProps)
輸入和傳送訊息的元件。
支持當用戶開始輸入文字時傳送輸入通知。 支援文字輸入欄位下方的選擇性訊息。
function SendBox(props: SendBoxProps): Element
參數
- props
- SendBoxProps
傳回
Element
StartCaptionsButton(StartCaptionsButtonProps)
用於開始或停止字幕的按鈕
可與 ControlBar 一起使用
function StartCaptionsButton(props: StartCaptionsButtonProps): Element
參數
- props
- StartCaptionsButtonProps
屬性。
傳回
Element
StartRealTimeTextButton(StartRealTimeTextButtonProps)
一個按鈕,用於根據輔助功能要求啟動 RealTimeText,即時文本一旦打開就無法關閉
可與 ControlBar 一起使用
function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element
參數
啟動 RealTimeText 按鈕的屬性。
傳回
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(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
參數
傳回
Promise<CallAdapter>
createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)
建立 Azure 通訊服務支援的 CallAdapter。
這是此連結庫提供 CallAdapter 的預設實作。
注意:displayName 最多可以有 256 個字元。
function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>
參數
傳回
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)
使用提供的 StatefulCallClient建立 CallAdapter。
如果您想要保留 StatefulCallClient的參考,則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallAdapter。
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>
參數
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- targetCallees
- options
- CommonCallAdapterOptions
傳回
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)
使用提供的 StatefulCallClient建立 CallAdapter。
如果您想要保留 StatefulCallClient的參考,則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallAdapter。
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<CallAdapter>
參數
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
傳回
Promise<CallAdapter>
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)
建立 Azure 通訊服務支援的 CallWithChatAdapter,以插入 CallWithChatComposite。
function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>
參數
- __namedParameters
- AzureCommunicationCallWithChatAdapterArgs
傳回
Promise<CallWithChatAdapter>
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)
使用提供的 StatefulChatClient 和 StatefulCallClient建立 CallWithChatAdapter。
如果您想要保留 StatefulChatClient 和 StatefulCallClient的參考,則很有用。 請注意,chatThreadClient 必須由 StatefulChatClient 通過 chatClient.getChatThreadClient(chatThreadId) API 創建。 請考慮針對更簡單的 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, ChatAdapterOptions)
使用提供的 StatefulChatClient建立 ChatAdapter。
如果您想要保留 StatefulChatClient的參考,則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationChatAdapter。
function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>
參數
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
- chatAdapterOptions
- ChatAdapterOptions
傳回
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call, CallingHandlersOptions)
為小組通話建立 CallHandlers 的預設實作。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call, options?: CallingHandlersOptions): CallingHandlers
參數
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
- options
- CallingHandlersOptions
傳回
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)
建立 ChatHandlers的預設實作。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
傳回的物件已備忘,以避免在做為 React 元件之 props 時重新調整。
function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers
參數
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
傳回
createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })
為 teams 呼叫創建 TeamsCallingHandlers 的預設實現。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers
參數
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- deviceManager
- StatefulDeviceManager
- call
- TeamsCall
- options
-
{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }
傳回
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)
使用 ProxyCallClient ProxyClient <xref:%40azure%2Fcommunication-calling%23CallClient> ProxyCallClient ,以宣告方式建立 StatefulCallClient StatefulCallClient。
請務必使用從 StatefulCallClient 取得的 <xref:%40azure%2Fcommunication-calling%23DeviceManager> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 <xref:%40azure%2Fcommunication-calling%23CallAgent> 和 (等),以便正確處理其狀態變更。
function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient
參數
傳回
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)
使用 ProxyChatClient ProxyClient <xref:%40azure%2Fcommunication-chat%23ChatClient> proxyChatClient 建立具狀態的 ChatClient StatefulChatClient,然後允許以宣告式方式存取狀態。
function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient
參數
- options
- StatefulChatClientOptions
傳回
createTeamsCallAdapter(TeamsCallAdapterArgs)
function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>
參數
- args
- TeamsCallAdapterArgs
傳回
Promise<TeamsCallAdapter>
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)
使用提供的 StatefulCallClient 創建 TeamsCallAdapter。
如果您想要保留 StatefulCallClient的參考,則很有用。 請考慮針對更簡單的 API 使用 createAzureCommunicationCallAdapter。
function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>
參數
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
傳回
Promise<TeamsCallAdapter>
fromFlatCommunicationIdentifier(string)
至FlatCommunicationIdentifier的反向作業。
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
參數
- id
-
string
傳回
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>
loadCallComposite(CallCompositeLoaderProps, HTMLElement)
Loader 函數,用於可在應用程式中使用的 CallComposite。 此函數會將 CallComposite 載入到提供的 HTML 元素中。 最好的用例是在不是基於 React 的 Node UI 框架中。
function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
參數
- loaderArgs
- CallCompositeLoaderProps
- htmlElement
-
HTMLElement
傳回
Promise<undefined | CallAdapter>
loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)
可在應用程式中使用的 CallWithChatComposite 的 props。 此函數會將 CallWithChatComposite 載入到提供的 HTML 元素中。 最好的用例是在不是基於 React 的 Node UI 框架中。
function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>
參數
- loaderArgs
- CallWithChatCompositeLoaderProps
- htmlElement
-
HTMLElement
傳回
Promise<undefined | CallWithChatAdapter>
loadChatComposite(ChatCompositeLoaderProps, HTMLElement)
Loader 函數。 此函數會將 ChatComposite 載入到提供的 HTML 元素中。 最好的用例是在不是基於 React 的 Node UI 框架中。
function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>
參數
- loaderArgs
- ChatCompositeLoaderProps
- htmlElement
-
HTMLElement
傳回
Promise<undefined | ChatAdapter>
loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)
Loader 函數。 此函數會將 CallComposite 載入到提供的 HTML 元素中以進行出站調用。 最好的用例是在不是基於 React 的 Node UI 框架中。
function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
參數
- loaderArgs
- OutboundCallCompositeLoaderProps
- htmlElement
-
HTMLElement
傳回
Promise<undefined | CallAdapter>
onResolveDeepNoiseSuppressionDependency()
使用延遲載入的視頻背景效果的依賴項解析。
function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>
傳回
Promise<DeepNoiseSuppressionEffectDependency>
onResolveDeepNoiseSuppressionDependencyLazy()
使用延遲載入的視頻背景效果的依賴項解析。
function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>
傳回
Promise<DeepNoiseSuppressionEffectDependency>
onResolveVideoEffectDependency()
視頻背景效果的依賴項解析。
function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>
傳回
Promise<VideoBackgroundEffectsDependency>
onResolveVideoEffectDependencyLazy()
使用延遲載入的視頻背景效果的依賴項解析。
function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>
傳回
Promise<VideoBackgroundEffectsDependency>
toFlatCommunicationIdentifier(CommunicationIdentifier)
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>的字串表示。
此 CommunicationIdentifier 的字串表示法保證對唯一的通訊使用者而言是穩定的。 因此
- 它可用來將使用者的身分識別保存在外部資料庫中。
- 它可以當做對應中的索引鍵來儲存用戶的數據。
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string
參數
- identifier
- CommunicationIdentifier
傳回
string
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
自定義 React 攔截,可簡化 CallAdapter的建立。
類似於 createAzureCommunicationCallAdapter,但會負責在內部異步建立配接器。
允許未定義自變數,讓您可以遵守連結規則,並在建立自變數時傳入自變數。 只有在定義所有自變數時,才會建立配接器。
請注意,您必須備忘自變數,以避免在每個轉譯上重新建立配接器。 如需一般使用範例,請參閱劇本。
function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
參數
- 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
- 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
傳回
useChatClient()
Hook 以從提供者取得 StatefulChatClient。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function useChatClient(): StatefulChatClient
傳回
useChatThreadClient()
攔截以從提供者取得 <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function useChatThreadClient(): ChatThreadClient
傳回
useDeviceManager()
Hook 以從提供者取得 StatefulDeviceManager。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function useDeviceManager(): undefined | StatefulDeviceManager
傳回
undefined | StatefulDeviceManager
usePropsFor<Component>(Component, "chat" | "calling")
從這個連結庫取得 React 元件所需的所有連結的主要勾點。
若要呼叫此攔截,元件必須包裝在這些提供者下:
針對聊天元件:ChatClientProvider 和 ChatThreadClientProvider。
針對呼叫元件: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)
useTeamsCall()
攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23TeamsCall>。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
您必須之前將 CallProvider 與 TeamsCall 物件一起使用才能使用此挂鉤
function useTeamsCall(): undefined | TeamsCall
傳回
undefined | TeamsCall
useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)
自定義 React 挂鉤,用於簡化 TeamsCallAdapter 的創建。
與 <xref:createTeamsAzureCommunicationCallAdapter>類似,但負責在內部異步創建適配器。
允許未定義自變數,讓您可以遵守連結規則,並在建立自變數時傳入自變數。 只有在定義所有自變數時,才會建立配接器。
請注意,您必須備忘自變數,以避免在每個轉譯上重新建立配接器。 如需一般使用範例,請參閱劇本。
function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter
參數
- args
-
Partial<TeamsCallAdapterArgs>
- afterCreate
-
(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>
- beforeDispose
-
(adapter: TeamsCallAdapter) => Promise<void>
傳回
undefined | TeamsCallAdapter
useTeamsCallAgent()
攔截以從提供者取得 <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>。
實作利用從此連結庫導出之提供者的自定義元件時很有用。
function useTeamsCallAgent(): undefined | TeamsCallAgent
傳回
undefined | TeamsCallAgent
useTheme()
回應連結以存取主題
function useTheme(): Theme
傳回
Theme