Bagikan melalui

@azure/communication-react package

  • Referensi

Kelas

CallError

Kesalahan yang dilemparkan dari metode API stateful yang gagal.
ChatError

Kesalahan yang dilemparkan dari metode StatefulChatClient yang gagal.

Antarmuka

ActiveErrorMessage

Pesan kesalahan aktif yang akan ditampilkan melalui Bilah Kesalahan.
AdapterError

Kesalahan dilaporkan melalui peristiwa kesalahan dan disimpan dalam status adaptor.
AdapterState

Fungsionalitas untuk berinteraksi dengan status adaptor Komposit.
BaseCompositeProps

Properti umum untuk semua komposit yang diekspor dari pustaka ini.
BaseCustomStyles

Alat peraga gaya fasih dasar untuk semua komponen yang diekspor dari pustaka ini.
CallAdapter

Antarmuka Adapter khusus untuk identitas Azure Communication yang memperluas CommonCallAdapter.
CallAdapterCallManagement

Fungsionalitas untuk mengelola panggilan saat ini atau memulai panggilan baru
CallAdapterCallOperations

Fungsionalitas untuk mengelola panggilan saat ini.
CallAdapterDeviceManagement

Fungsionalitas untuk mengelola perangkat dalam panggilan.
CallAdapterSubscribers

Panggil peristiwa komposit yang dapat dilanggani.
CallAgentProviderProps

Argumen untuk menginisialisasi CallAgentProvider.
CallAgentState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23CallAgent> kecuali panggilan dipindahkan menjadi anak langsung dari CallClientState dan tidak disertakan di sini. Alasan untuk memiliki status CallAgent yang diproksi adalah untuk menyediakan akses ke displayName. Kami tidak meratakan CallAgent.displayName dan meletakkannya di CallClientState karena akan ambigu bahwa displayName sebenarnya bergantung pada pembuatan/keberadaan CallAgent untuk tersedia.
CallAndChatLocator

Argumen untuk digunakan dalam createAzureCommunicationCallWithChatAdapter untuk bergabung dengan Panggilan dengan utas Obrolan terkait.
CallClientProviderProps

Argumen untuk menginisialisasi CallClientProvider.
CallClientState

Kontainer untuk semua data status yang diproksikan oleh StatefulCallClient. Panggilan, callsEnded, incomingCalls, dan status incomingCallsEnded akan secara otomatis disediakan jika callAgent telah dibuat. DeviceManager awalnya akan kosong hingga diisi lihat DeviceManagerState. Status userId disediakan sebagai kenyamanan bagi pengembang dan sepenuhnya dikontrol dan ditetapkan oleh pengembang.
CallCompositeProps

Props untuk CallComposite.
CallCompositeStrings

String yang digunakan oleh CallComposite secara langsung.

String ini selain yang digunakan oleh komponen dari pustaka komponen.
CallProviderProps

Argumen untuk menginisialisasi CallProvider.
CallState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient akan secara otomatis mengambil status Panggilan dan menambahkannya ke status yang diekspos oleh StatefulCallClient.
CallWithChatAdapter

CallWithChatComposite Antarmuka adapter.
CallWithChatAdapterManagement

Fungsionalitas untuk mengelola panggilan saat ini dengan obrolan.
CallWithChatAdapterState

Status CallWithChat adalah kombinasi dari klien Stateful Chat dan Stateful Calling dengan beberapa status khusus untuk CallWithChat Composite saja.
CallWithChatAdapterSubscriptions

Peristiwa Panggilan dan Obrolan yang dapat berlangganan di CallWithChatAdapter.
CallWithChatAdapterUiState

Status UI yang berkaitan dengan CallWithChatComposite.
CallWithChatClientState

Status dari layanan backend yang mendorong CallWithChatComposite.
CallWithChatCompositeProps

Props diperlukan untuk CallWithChatComposite
CallWithChatCompositeStrings

String yang digunakan oleh CallWithChatComposite secara langsung.

String ini selain yang digunakan oleh komponen dari pustaka komponen.
CallWithChatControlOptions

CallWithChatComposite Kontrol panggilan untuk menampilkan atau menyembunyikan tombol pada bilah kontrol panggilan.
CallingHandlers

Objek yang berisi semua handler yang diperlukan untuk memanggil komponen.

Memanggil komponen terkait dari paket ini dapat memilih penangan yang relevan dari objek ini. Lihat <xref:useHandlers> dan gunakanPropsFor.
CallingTheme

Palet tema Fasih kustom yang digunakan dengan memanggil komponen terkait di pustaka ini.
CameraButtonContextualMenuStyles

Gaya untuk menu CameraButton .
CameraButtonProps

Props untuk komponen CameraButton .
CameraButtonStrings

String CameraButton yang dapat ditimpa.
CameraButtonStyles

Gaya untuk CameraButton
ChatAdapterSubscribers

Peristiwa komposit obrolan yang dapat dilanggani.
ChatAdapterThreadManagement

Fungsionalitas untuk mengelola utas obrolan saat ini.
ChatCompositeProps

Props untuk ChatComposite.
ChatCompositeStrings

String yang digunakan oleh ChatComposite secara langsung.

String ini selain yang digunakan oleh komponen dari pustaka komponen.
ChatMessage

Pesan obrolan.
CommonCallAdapter

CallComposite Antarmuka adapter.
CommonCallingHandlers

Objek yang berisi semua handler yang diperlukan untuk memanggil komponen.

Memanggil komponen terkait dari paket ini dapat memilih handler yang relevan dari objek ini. Lihat <xref:useHandlers> dan gunakanPropsFor.
ComponentLocale

Informasi lokal untuk semua komponen yang diekspor dari pustaka ini.
ComponentStrings

String yang digunakan oleh semua komponen yang diekspor dari pustaka ini.
CompositeLocale

Informasi lokal untuk semua komposit yang diekspor dari pustaka ini.
CompositeStrings

String yang digunakan dalam komposit secara langsung.

String ini digunakan oleh komposit secara langsung, bukan oleh komponen yang terkandung.
ContentSystemMessage

Pesan sistem dengan konten arbiter.
ControlBarButtonProps

Props untuk ControlBarButton.
ControlBarButtonStrings

String ControlBarButton yang dapat ditimpa.
ControlBarProps

Props untuk ControlBar.
CreateVideoStreamViewResult

Objek dikembalikan setelah membuat VideoStream lokal atau jarak jauh. Ini berisi fungsi pembantu untuk memanipulasi render aliran.
CustomMessage

Jenis pesan kustom.

Pesan kustom tidak dirender secara default, tetapi aplikasi dapat menyediakan perender kustom untuk mereka.
DevicesButtonContextualMenuStyles

Gaya untuk menu DevicesButton .
DevicesButtonProps

Props untuk DevicesButton.
DevicesButtonStrings

String DevicesButton yang dapat ditimpa.
DevicesButtonStyles

Gaya untuk item menu tombol Perangkat.
DiagnosticsCallFeatureState

Proksi status saja untuk <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable

Fungsionalitas untuk membuang Komposit dengan benar.
EndCallButtonProps

Props untuk EndCallButton.
EndCallButtonStrings

String EndCallButton yang dapat ditimpa.
ErrorBarProps

Props untuk ErrorBar.

Selain yang berikut ini, ErrorBar meneruskan semua <xref:%40fluentui%2Freact%23IMessageBarProps> ke yang mendasar <xref:%40fluentui%2Freact%23MessageBar>.
ErrorBarStrings

Semua string yang mungkin ditampilkan pada UI di ErrorBar.
FluentThemeProviderProps

Props untuk FluentThemeProvider.
GridLayoutProps

Alat peraga untuk GridLayout.
GridLayoutStyles

GridLayout Gaya Komponen.
HorizontalGalleryStyles

<xref:HorizontalGallery> Gaya Komponen.
IncomingCallState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient akan secara otomatis mendeteksi panggilan masuk dan menambahkan statusnya ke status yang diekspos oleh StatefulCallClient.
JumpToNewMessageButtonProps

Argumen untuk <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState

Proksi status saja untuk <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon

Properti umum dari semua jenis pesan.
MessageStatusIndicatorProps

Props untuk MessageStatusIndicator.
MessageStatusIndicatorStrings

String MessageStatusIndicator yang dapat ditimpa.
MessageThreadStrings

String MessageThread yang dapat ditimpa.
MessageThreadStyles

Gaya fasih untuk MessageThread.
MicrophoneButtonContextualMenuStyles

Gaya untuk menu MicrophoneButton .
MicrophoneButtonProps

Props untuk MicrophoneButton.
MicrophoneButtonStrings

String MicrophoneButton yang dapat ditimpa.
MicrophoneButtonStyles

Gaya untuk MicrophoneButton
NetworkDiagnosticsState

Proksi status saja untuk <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice

Perangkat, misalnya kamera, mikrofon, atau speaker, di flyout DevicesButton .
ParticipantAddedSystemMessage

Pesan sistem yang memberi tahu bahwa peserta ditambahkan ke utas obrolan.
ParticipantItemProps

Props untuk ParticipantItem.
ParticipantItemStrings

String ParticipantItem yang dapat ditimpa.
ParticipantItemStyles

Gaya fasih untuk ParticipantItem.
ParticipantListItemStyles

Gaya untuk ParticipantListParticipantItem.
ParticipantListStyles

Gaya untuk Daftar Peserta.
ParticipantRemovedSystemMessage

Pesan sistem yang memberi tahu bahwa peserta dihapus dari utas obrolan.
ParticipantsButtonContextualMenuStyles

Gaya untuk menu PesertaButton .
ParticipantsButtonProps

Props untuk ParticipantsButton.
ParticipantsButtonStrings

String PesertaButton yang dapat ditimpa.
ParticipantsButtonStyles

Gaya Props untuk PesertaButton.
RecordingCallFeature

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient akan secara otomatis mendengarkan status perekaman panggilan dan memperbarui status yang diekspos oleh StatefulCallClient yang sesuai.
RemoteParticipantState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient akan secara otomatis mengambil RemoteParticipants dan menambahkan statusnya ke status yang diekspos oleh StatefulCallClient.
RemoteVideoStreamState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps

Props untuk ScreenShareButton.
ScreenShareButtonStrings

String ScreenShareButton yang dapat ditimpa.
SendBoxProps

Props untuk SendBox.
SendBoxStrings

String SendBox yang dapat ditimpa.
SendBoxStylesProps

Gaya fasih untuk <xref:Sendbox>.
StatefulCallClient

Menentukan metode yang memungkinkan CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> digunakan secara stateful. Antarmuka menyediakan akses ke status diproksi dan juga memungkinkan mendaftarkan handler untuk peristiwa perubahan status. Untuk definisi status, lihat CallClientState.

Peristiwa perubahan status didorong oleh:

  • Mengembalikan data dari <xref:%40azure%2Fcommunication-calling%23DeviceManager> API.
  • Mengembalikan data dari <xref:%40azure%2Fcommunication-calling%23CallAgent> API.
  • Pendengar secara otomatis dilampirkan ke berbagai objek panggilan komunikasi azure:
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Panggil 'stateChanged'
    • Panggil 'idChanged'
    • Panggil 'isMutedChanged'
    • Panggil 'isScreenSharingOnChanged'
    • Panggil 'remoteParticipantsUpdated'
    • Panggil 'localVideoStreamsUpdated'
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

Menentukan metode yang memungkinkan {@Link @azure/communication-chat#ChatClient} digunakan dengan status terpusat yang dihasilkan.

Antarmuka menyediakan akses ke status diproksi dan juga memungkinkan mendaftarkan handler untuk peristiwa perubahan status.
StatefulDeviceManager

Menentukan metode tambahan yang ditambahkan oleh stateful di atas <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps

Props untuk StreamMedia.
SystemMessageCommon

Properti umum semua pesan sistem.
TopicUpdatedSystemMessage

Pesan sistem yang memberi tahu bahwa topik utas obrolan telah diperbarui.
TranscriptionCallFeature

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient akan secara otomatis mendengarkan status transkripsi panggilan dan memperbarui status yang diekspos oleh StatefulCallClient yang sesuai.
TypingIndicatorProps

Props untuk TypingIndicator.
TypingIndicatorStrings

String TypingIndicator yang dapat ditimpa.
TypingIndicatorStylesProps

Gaya fasih untuk TypingIndicator.
VideoGalleryProps

Alat peraga untuk VideoGallery.
VideoGalleryRemoteParticipant

Status peserta jarak jauh di VideoGallery.
VideoGalleryStream

Streaming video peserta di VideoGallery.
VideoGalleryStrings

Semua string yang mungkin ditampilkan pada UI di VideoGallery.
VideoGalleryStyles

VideoGallery Gaya Komponen.
VideoStreamOptions

Opsi untuk mengontrol cara streaming video dirender.
VideoStreamRendererViewState

Versi status saja dari <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Properti ini ditambahkan ke status yang diekspos oleh StatefulCallClient dengan createView dan dihapus oleh disposeView.
VideoTileProps

Alat peraga untuk VideoTile.
VideoTileStylesProps

Gaya fasih untuk VideoTile.

Alias Jenis

AdapterErrors

Adapter menyimpan kesalahan terbaru untuk setiap operasi dalam status .

target adalah string yang ditentukan adaptor untuk setiap operasi unik yang dilakukan oleh adaptor.
AreEqual

Bandingkan jika 2 komponen react sama persis, jenis hasil akan true/false
AreParamEqual

Bandingkan jika props dari 2 komponen react sama, jenis hasil akan true/false
AreTypeEqual

Bandingkan jika dua jenis sama, jenis hasil akan true/false
AvatarPersonaData

Atribut data kustom untuk menampilkan avatar untuk pengguna.
AvatarPersonaDataCallback

Fungsi panggilan balik yang digunakan untuk menyediakan data kustom untuk membangun avatar untuk pengguna.
AzureCommunicationCallAdapterArgs

Argumen untuk membuat implementasi callAdapter Azure Communication Services.

Catatan: displayName maksimal bisa 256 karakter.
AzureCommunicationCallWithChatAdapterArgs

Argumen untuk createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs

Argumen untuk <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs

Argumen untuk membuat implementasi Azure Communication Services ChatAdapter.
CallAdapterCallEndedEvent

Payload untuk CallEndedListener yang berisi detail pada panggilan berakhir.
CallAdapterClientState

Status CommonCallAdapter disimpulkan dari backend Azure Communication Services.
CallAdapterLocator

Pencari lokasi yang digunakan oleh createAzureCommunicationCallAdapter untuk menemukan panggilan untuk bergabung
CallAdapterState

Status CommonCallAdapter .
CallAdapterUiState

Status CommonCallAdapter untuk tujuan UI murni.
CallCompositeIcons

Ikon yang dapat diganti untuk CallComposite.
CallCompositeOptions

Fitur opsional CallComposite.
CallCompositePage

Layar UI utama ditampilkan di CallComposite.
CallControlDisplayType

Tipe tampilan bilah kontrol untuk CallComposite.
CallControlOptions

Opsi kustomisasi untuk bilah kontrol dalam pengalaman panggilan.
CallEndedListener

Panggilan balik untuk peristiwa 'callEnded' CallAdapterSubscriber .
CallErrorBarSelector

Jenis pemilih untuk komponen Bilah Kesalahan .
CallErrorTarget

Jenis harfiah string untuk semua kunci yang diizinkan di {@Link CallErrors}.
CallErrors

Kesalahan yang ditekan dari panggilan API ke SDK Panggilan.

Setiap properti dalam objek menyimpan kesalahan terbaru untuk metode API SDK tertentu.

Kesalahan dari objek ini dapat dibersihkan menggunakan <xref:newClearCallErrorsModifier>. Selain itu, kesalahan secara otomatis dihapus ketika:

  • Statusnya sudah dibersihkan.
  • Panggilan berikutnya ke metode API terkait berhasil. Lihat dokumentasi metode klien stateful individual untuk detail tentang kapan kesalahan dapat dihapus secara otomatis.
CallIdChangedListener

Panggilan balik untuk peristiwa CallAdapterSubscribers 'callIdChanged'.
CallParticipantListParticipant

Memanggil status peserta, seperti yang tercermin dalam komponen UI.
CallWithChatCompositeIcons

Ikon yang dapat ditimpa untuk CallWithChatComposite.
CallWithChatCompositeOptions

Fitur opsional CallWithChatComposite.
CallWithChatEvent

Peristiwa diaktifkan oleh CallWithChatAdapter.
CallingBaseSelectorProps

Alat peraga umum yang digunakan untuk mereferensikan panggilan status klien deklaratif.
CallingReturnProps

Jenis pembantu untuk usePropsFor.
CameraButtonSelector

Jenis pemilih untuk komponen CameraButton .
ChatAdapter

ChatComposite Antarmuka adapter.
ChatAdapterState

Status ChatAdapter .
ChatAdapterUiState

Status ChatAdapter untuk tujuan UI murni.
ChatBaseSelectorProps

Alat peraga umum untuk pemilih untuk ChatClientState.
ChatClientProviderProps

Argumen untuk menginisialisasi ChatClientProvider.
ChatClientState

Status terpusat untuk <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState

Status ChatAdapter disimpulkan dari backend Azure Communication Services.
ChatCompositeIcons

Ikon yang dapat ditimpa untuk ChatComposite.
ChatCompositeOptions

Fitur opsional ChatComposite.
ChatErrorBarSelector

Jenis pemilih untuk komponen ErrorBar .
ChatErrorTarget

Jenis literal string untuk semua kunci yang diizinkan di ChatErrors.
ChatErrors

Kesalahan yang ditekan dari panggilan API ke SDK Obrolan.

Setiap properti dalam objek menyimpan kesalahan terbaru untuk metode API SDK tertentu.
ChatHandlers

Objek yang berisi semua handler yang diperlukan untuk komponen obrolan.

Komponen terkait obrolan dari paket ini dapat memilih handler yang relevan dari objek ini. Lihat <xref:useHandlers> dan gunakanPropsFor.
ChatMessageWithStatus

Ekstensi untuk <xref:%40azure%2Fcommunication-chat%23ChatMessage> yang menyimpan metadata hanya sisi klien untuk pesan obrolan.

Nama telah di-bitrot. Ganti nama saya.
ChatParticipantListSelector

Jenis pemilih untuk komponen ParticipantList .
ChatReturnProps

Jenis pembantu untuk usePropsFor.
ChatThreadClientProviderProps

Argumen untuk menginisialisasi ChatThreadClientProvider.
ChatThreadClientState

Status terpusat untuk <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties

Properti utas obrolan.

Kami mendefinisikan yang minimal yang membantu kami menyembunyikan berbagai jenis yang digunakan oleh API yang mendasar.
ClientState

Status terpusat untuk <xref:%40azure%2Fcommunication-calling%23CallClient> atau <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Lihat juga: CallClientState, ChatClientState.
Common

Mengembalikan jenis intersect dari 2 jenis
CommonProperties

Mengembalikan properti irisan dari 2 jenis
CommunicationParticipant

Status peserta Obrolan atau Panggilan, seperti yang tercermin dalam UI.
ComponentIcons

Ikon yang digunakan oleh komponen React yang diekspor dari pustaka ini.
ComponentProps

Jenis pembantu untuk usePropsFor.
CompositeIcons

Ikon yang dapat ditimpa di salah satu komposit yang diekspor oleh pustaka ini.

Lihat ChatCompositeIcons, CallCompositeIcons , dan CallWithChatCompositeIcons untuk jenis yang lebih ditargetkan.
ControlBarButtonStyles

Gaya untuk semua implementasi ControlBarButton .
ControlBarLayout

Sajikan tata letak untuk ControlBar.
CreateViewResult

Mengembalikan hasil dari createView.
CustomAvatarOptions

Opsi yang dapat disuntikkan ke onRender dalam fungsi untuk menyesuaikan komponen Avatar (Persona).
DeviceManagerState

Jenis ini dimaksudkan untuk merangkum semua status di dalam <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Untuk parameter opsional, parameter mungkin tidak tersedia sampai izin diberikan oleh pengguna. Status kamera, mikrofon, speaker, dan deviceAccess akan kosong hingga GETCameras, getMicrophones, getSpeakers, dan ASKDevicePermission API yang sesuai <xref:%40azure%2Fcommunication-calling%23DeviceManager>dipanggil dan diselesaikan.
DevicesButtonSelector

Jenis pemilih untuk komponen DevicesButton .
DiagnosticChangedEventListner

Panggilan balik untuk peristiwa 'diagnosticChanged' CallAdapterSubscribers .
DisplayNameChangedListener

Panggilan balik untuk peristiwa 'displayNameChanged' CallAdapterSubscribers .
EmptySelector

Jenis untuk pemilih sepele yang tidak mengembalikan data.

Digunakan sebagai nilai pengembalian default jika usePropsFor dipanggil untuk komponen yang tidak memerlukan data.
ErrorType

Semua kesalahan yang dapat ditampilkan di Bilah Kesalahan.
GetCallingSelector

Jenis pemilih tertentu yang berlaku untuk Komponen tertentu.
GetChatSelector

Jenis pemilih tertentu yang berlaku untuk Komponen tertentu.
IsLocalScreenSharingActiveChangedListener

Panggilan balik untuk peristiwa CallAdapterSubscribers 'isLocalScreenSharingActiveChanged'.
IsMutedChangedListener

Panggilan balik untuk peristiwa 'isMuted' CallAdapterSubscribers .
IsSpeakingChangedListener

Callback untuk peristiwa CallAdapterSubscribers 'isSpeakingChanged'.
LoadingState

Apakah aliran sedang dimuat atau tidak.
LocalizationProviderProps

Alat peraga untuk LocalizationProvider.
MediaDiagnosticChangedEvent

Payload untuk DiagnosticChangedEventListner di mana ada perubahan dalam diagnostik media.
Message

Gabungan yang didiskriminasi dari semua pesan.

Bidang ini messageType mengkhususkan diri menjadi varian serikat.
MessageAttachedStatus

Tunjukkan apakah pesan obrolan harus ditampilkan digabungkan dengan pesan sebelum / setelahnya.

Berguna untuk menggabungkan banyak pesan dari pengirim yang sama ke dalam satu gelembung pesan.
MessageContentType

Jenis konten pesan obrolan yang didukung.
MessageProps

Alat peraga untuk merender satu pesan.

Lihat MessageRenderer.
MessageReadListener

Callback untuk peristiwa 'messageRead' ChatAdapterSubscribers .
MessageReceivedListener

Panggilan balik untuk peristiwa 'messageReceived' ChatAdapterSubscribers .
MessageRenderer

Komponen untuk merender satu pesan.
MessageSentListener

Panggilan balik untuk peristiwa 'messageSent' ChatAdapterSubscribers .
MessageStatus

Status sisi klien dari pesan terkirim.

Termasuk status transisi yang terjadi sebelum pengiriman pesan dikonfirmasi dari backend.
MessageThreadProps

Props untuk MessageThread.
MessageThreadSelector

Jenis pemilih untuk komponen MessageThread .
MicrophoneButtonSelector

Jenis pemilih untuk komponen MicrophoneButton .
NetworkDiagnosticChangedEvent

Payload untuk DiagnosticChangedEventListner di mana ada perubahan dalam diagnostik jaringan.
OnRenderAvatarCallback

Panggilan balik yang dirender kustom yang memungkinkan pengguna untuk menyesuaikan penyajian Komponen Persona.
ParticipantListParticipant

Peserta ditampilkan dalam Daftar Peserta.
ParticipantListProps

Props untuk ParticipantList.
ParticipantListSelector

Jenis pemilih untuk komponen ParticipantList .
ParticipantMenuItemsCallback

Panggilan balik untuk menyediakan item menu kustom untuk setiap peserta di ParticipantList.
ParticipantState

Status koneksi peserta panggilan.
ParticipantsAddedListener

Panggilan balik untuk acara 'pesertaTambahkan' ChatAdapterSubscribers .
ParticipantsButtonSelector

Jenis pemilih untuk komponen ParticipantsButton .
ParticipantsJoinedListener

Callback untuk acara CallAdapterSubscribers 'participantsJoined'.
ParticipantsLeftListener

Panggilan balik untuk acara 'participantsLeft' CallAdapterSubscribers .
ParticipantsRemovedListener

Callback untuk acara ChatAdapterSubscribers 'participantsRemoved'.
ReadReceiptsBySenderId

Array pasangan nilai kunci yang menyimpan nama tampilan setiap pengirim dan pesan baca terakhir
ScreenShareButtonSelector

Jenis pemilih untuk komponen ScreenShareButton .
Selector

Pemilih yang dioptimalkan yang menyempurnakan pembaruan ClientState menjadi alat peraga untuk Komponen React di pustaka ini.
SendBoxSelector

Jenis pemilih untuk komponen SendBox .
StatefulCallClientArgs

Argumen untuk membangun StatefulCallClient.
StatefulCallClientOptions

Opsi untuk membangun StatefulCallClient dengan.
StatefulChatClientArgs

Argumen untuk membangun StatefulChatClient.
StatefulChatClientOptions

Opsi untuk membangun StatefulChatClient.
SystemMessage

Penyatuan yang didiskriminasi dari semua pesan sistem.

Bidang ini systemMessageType mengkhususkan diri ke dalam varian serikat.
TopicChangedListener

Panggilan balik untuk peristiwa 'topicChanged' ChatAdapterSubscribers .
TypingIndicatorSelector

Jenis pemilih untuk komponen TypingIndicator .
UpdateMessageCallback

Fungsi panggilan balik berjalan saat pesan diperbarui.
VideoGalleryLayout
VideoGalleryLocalParticipant

Status peserta lokal di VideoGallery.
VideoGalleryParticipant

Status peserta di VideoGallery.
VideoGallerySelector

Jenis pemilih untuk komponen VideoGallery .
ViewScalingMode

Mode penskalaan VideoGalleryStream.

Fungsi

CallAgentProvider(CallAgentProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Komponen panggilan dari paket ini harus dibungkus dengan CallAgentProvider.
CallClientProvider(CallClientProviderProps)

Yang <xref:React.Context> menyimpan StatefulCallClient.

Komponen panggilan dari paket ini harus dibungkus dengan CallClientProvider.
CallComposite(CallCompositeProps)

Komposit UI yang dapat disesuaikan untuk pengalaman panggilan.
CallProvider(CallProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-calling%23Call>.

Komponen panggilan dari paket ini harus dibungkus dengan CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite menyatukan komponen utama untuk memberikan panggilan penuh dengan pengalaman obrolan di luar kotak.
CameraButton(CameraButtonProps)

Tombol untuk menyalakan/mematikan kamera.

Dapat digunakan dengan ControlBar.
ChatClientProvider(ChatClientProviderProps)

Yang <xref:React.Context> menyimpan StatefulChatClient.

Komponen obrolan dari paket ini harus dibungkus dengan ChatClientProvider.
ChatComposite(ChatCompositeProps)

Komposit UI yang dapat disesuaikan untuk pengalaman obrolan.
ChatThreadClientProvider(ChatThreadClientProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Komponen obrolan dari paket ini harus dibungkus dengan ChatThreadClientProvider.
ControlBar(ControlBarProps)

Kontainer untuk berbagai tombol untuk kontrol panggilan.

Gunakan dengan berbagai tombol kontrol panggilan di pustaka ini, misalnya, CameraButton, atau instans ControlBarButton Anda sendiri secara langsung.
ControlBarButton(ControlBarButtonProps)

Tombol default ditata untuk ControlBar.

Gunakan komponen ini membuat tombol kustom yang ditata sama dengan tombol lain yang disediakan oleh Pustaka UI.
DevicesButton(DevicesButtonProps)

Tombol untuk membuka menu yang mengontrol opsi perangkat.

Dapat digunakan dengan ControlBar.
EndCallButton(EndCallButtonProps)

Tombol untuk mengakhiri panggilan yang sedang berlangsung.

Dapat digunakan dengan ControlBar.
ErrorBar(ErrorBarProps)

Komponen untuk menampilkan pesan kesalahan pada UI. Semua string yang dapat ditampilkan diterima sebagai string sehingga dapat dilokalkan. Kesalahan aktif dipilih oleh activeErrorMessages.

Komponen ini secara internal melacak yang diberhentikan oleh pengguna.

  • Kesalahan yang memiliki tanda waktu terkait: Kesalahan ditampilkan pada UI lagi jika terjadi setelah ditutup.
  • Kesalahan yang tidak memiliki tanda waktu: Kesalahan dimatikan sampai hilang dari alat peraga. Jika kesalahan berulang, kesalahan akan ditampilkan di UI.

<xref:%40fluentui%2Freact%23MessageBar> Menggunakan elemen UI.
FluentThemeProvider(FluentThemeProviderProps)

Penyedia untuk menerapkan tema Fasih di seluruh komponen react pustaka ini.
GridLayout(GridLayoutProps)

Komponen untuk meletakkan petak peta peserta audio/video dalam panggilan.
LocalizationProvider(LocalizationProviderProps)

Penyedia untuk menyediakan string yang dilokalkan untuk komponen react pustaka ini.
MessageStatusIndicator(MessageStatusIndicatorProps)

Komponen untuk menampilkan status pesan terkirim.

Menambahkan ikon dan tipsalat yang sesuai dengan status pesan.
MessageThread(MessageThreadProps)

MessageThread memungkinkan Anda untuk dengan mudah membuat komponen untuk merender pesan obrolan, menangani perilaku pengguliran pesan baru/lama dan menyesuaikan ikon & kontrol di dalam utas obrolan.
MicrophoneButton(MicrophoneButtonProps)

Tombol untuk menyalakan/mematikan mikrofon.

Dapat digunakan dengan ControlBar.
ParticipantItem(ParticipantItemProps)

Komponen untuk merender peserta panggilan atau obrolan.

Menampilkan avatar, displayName dan status peserta serta ikon opsional dan menu konteks.
ParticipantList(ParticipantListProps)

Komponen untuk merender semua peserta panggilan atau obrolan.

Secara default, setiap peserta dirender dengan ParticipantItem. Lihat <xref:ParticipantListProps.onRenderParticipant> untuk mengambil alih.
ParticipantsButton(ParticipantsButtonProps)

Tombol untuk menampilkan menu dengan peserta panggilan atau obrolan.

Dapat digunakan dengan ControlBar.

Tombol ini berisi item menu dropdown yang ditentukan melalui propertinya menuProps. Secara default, ini dapat menampilkan jumlah peserta jarak jauh dengan daftar lengkap sebagai sub-menu dan opsi untuk mematikan suara semua peserta, serta tombol salin ke clipboard untuk menyalin URL undangan panggilan. Ini menuProps dapat sepenuhnya ditentukan ulang dan propertinya berjenis IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)

Tombol untuk memulai/menghentikan berbagi layar.

Dapat digunakan dengan ControlBar.
SendBox(SendBoxProps)

Komponen untuk mengetik dan mengirim pesan.

Mendukung pengiriman pemberitahuan pengetikan saat pengguna mulai memasukkan teks. Mendukung pesan opsional di bawah bidang input teks.
StreamMedia(StreamMediaProps)

Komponen utilitas untuk mengonversi HTMLElement dengan aliran video menjadi elemen JSX.

Gunakan untuk mengonversi HTMLElement yang dikembalikan oleh API panggilan headless menjadi komponen yang dapat dirender sebagai VideoTile.
TypingIndicator(TypingIndicatorProps)

Komponen untuk memberi tahu pengguna lokal saat satu atau beberapa peserta di utas obrolan sedang mengetik.
VideoGallery(VideoGalleryProps)

VideoGallery mewakili tata letak petak peta video untuk panggilan tertentu. Ini menampilkan VideoTile untuk pengguna lokal serta untuk setiap peserta jarak jauh yang telah bergabung dalam panggilan.
VideoTile(VideoTileProps)

Komponen untuk merender aliran video untuk satu peserta panggilan.

Gunakan dengan GridLayout di VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Buat CallAdapter yang didukung oleh Azure Communication Services.

Ini adalah implementasi default CallAdapter yang disediakan oleh pustaka ini.

Catatan: displayName maksimal 256 karakter.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Buat CallAdapter menggunakan StatefulCallClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulCallClient. Pertimbangkan untuk menggunakan createAzureCommunicationCallAdapter untuk API yang lebih sederhana.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Buat CallWithChatAdapter yang didukung oleh layanan Azure Communication untuk menyambungkan ke CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Buat CallWithChatAdapter menggunakan StatefulChatClient dan StatefulCallClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulChatClient dan StatefulCallClient. Pertimbangkan untuk menggunakan createAzureCommunicationCallWithChatAdapter untuk API yang lebih sederhana.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Buat ChatAdapter yang didukung oleh Azure Communication Services.

Ini adalah implementasi default ChatAdapter yang disediakan oleh pustaka ini.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Buat ChatAdapter menggunakan StatefulChatClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulChatClient. Pertimbangkan untuk menggunakan createAzureCommunicationChatAdapter untuk API yang lebih sederhana.
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Buat implementasi default CallingHandlers untuk panggilan tim.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Buat implementasi default ChatHandlers.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

Objek yang dikembalikan dimoisasi untuk menghindari rerender saat digunakan sebagai alat peraga untuk Komponen React.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Membuat StatefulCallClient StatefulCallClient dengan mem-proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> dengan ProxyCallClient <xref:ProxyCallClient> yang kemudian memungkinkan akses ke status dengan cara deklaratif.

Penting untuk menggunakan <xref:%40azure%2Fcommunication-calling%23DeviceManager> dan <xref:%40azure%2Fcommunication-calling%23CallAgent> dan <xref:%40azure%2Fcommunication-calling%23Call> (dan dll.) yang diperoleh dari StatefulCallClient agar perubahan status mereka diproksi dengan benar.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Membuat ChatClient StatefulChatClient yang stateful dengan memproksi ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> dengan ProxyChatClient <xref:ProxyChatClient> yang kemudian memungkinkan akses ke status dengan cara deklaratif.
fromFlatCommunicationIdentifier(string)

Operasi terbalik dari toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)

Dapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
getChatSelector<Component>(Component)

Dapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
toFlatCommunicationIdentifier(CommunicationIdentifier)

Representasi string dari <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Representasi string CommunicationIdentifier ini dijamin stabil untuk pengguna Komunikasi yang unik. Dengan demikian,

  • ini dapat digunakan untuk mempertahankan identitas pengguna di database eksternal.
  • dapat digunakan sebagai kunci ke dalam Peta untuk menyimpan data bagi pengguna.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Kait React kustom untuk menyederhanakan pembuatan CallAdapter.

Mirip dengan createAzureCommunicationCallAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen didefinisikan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

Kait React kustom untuk menyederhanakan pembuatan CallWithChatAdapter.

Mirip dengan createAzureCommunicationCallWithChatAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen didefinisikan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

Kait React kustom untuk menyederhanakan pembuatan ChatAdapter.

Mirip dengan createAzureCommunicationChatAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen ditentukan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.
useCall()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-calling%23Call> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

Anda sebelumnya harus menggunakan CallProvider dengan objek Panggilan untuk menggunakan hook ini
useCallAgent()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-calling%23CallAgent> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
useCallClient()

Hook untuk mendapatkan StatefulCallClient dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
useChatClient()

Hook untuk mendapatkan StatefulChatClient dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
useChatThreadClient()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
useDeviceManager()

Hook untuk mendapatkan StatefulDeviceManager dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
usePropsFor<Component>(Component, "chat" | "calling")

Hook utama untuk mendapatkan semua kait yang diperlukan untuk Komponen React dari pustaka ini.

Untuk memanggil kait ini, komponen harus dibungkus di bawah penyedia ini:

  1. Untuk komponen obrolan: ChatClientProvider dan ChatThreadClientProvider.

  2. Untuk komponen panggilan: CallClientProvider, CallAgentProvider , dan CallAgentProvider.

Penggunaan komponen yang paling mudah terlihat seperti:

Contoh

    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")

Kaitkan untuk mendapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.
useTheme()

React hook untuk mengakses tema

Detail Fungsi

CallAgentProvider(CallAgentProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Komponen panggilan dari paket ini harus dibungkus dengan CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parameter

props
CallAgentProviderProps

Mengembalikan

Element

CallClientProvider(CallClientProviderProps)

Yang <xref:React.Context> menyimpan StatefulCallClient.

Komponen panggilan dari paket ini harus dibungkus dengan CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parameter

props
CallClientProviderProps

Mengembalikan

Element

CallComposite(CallCompositeProps)

Komposit UI yang dapat disesuaikan untuk pengalaman panggilan.

function CallComposite(props: CallCompositeProps): Element

Parameter

props
CallCompositeProps

Mengembalikan

Element

Keterangan

Memanggil lebar/tinggi min komposit adalah sebagai berikut:

  • mobile: 17.5rem x 21rem (280px x 336px, dengan rem default pada 16px)
  • desktop: 30rem x 22rem (480px x 352px, dengan rem default pada 16px)

CallProvider(CallProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-calling%23Call>.

Komponen panggilan dari paket ini harus dibungkus dengan CallProvider.

function CallProvider(props: CallProviderProps): Element

Parameter

props
CallProviderProps

Mengembalikan

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite menyatukan komponen utama untuk memberikan panggilan penuh dengan pengalaman obrolan di luar kotak.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parameter

props
CallWithChatCompositeProps

Mengembalikan

Element

CameraButton(CameraButtonProps)

Tombol untuk menyalakan/mematikan kamera.

Dapat digunakan dengan ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parameter

props
CameraButtonProps

Mengembalikan

Element

ChatClientProvider(ChatClientProviderProps)

Yang <xref:React.Context> menyimpan StatefulChatClient.

Komponen obrolan dari paket ini harus dibungkus dengan ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parameter

props
ChatClientProviderProps

Mengembalikan

Element

ChatComposite(ChatCompositeProps)

Komposit UI yang dapat disesuaikan untuk pengalaman obrolan.

function ChatComposite(props: ChatCompositeProps): Element

Parameter

props
ChatCompositeProps

Mengembalikan

Element

Keterangan

Lebar dan tinggi min komposit obrolan masing-masing 17,5rem dan 20rem (280px dan 320px, dengan rem default pada 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

Yang <xref:React.Context> menyimpan <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Komponen obrolan dari paket ini harus dibungkus dengan ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parameter

props
ChatThreadClientProviderProps

Mengembalikan

Element

ControlBar(ControlBarProps)

Kontainer untuk berbagai tombol untuk kontrol panggilan.

Gunakan dengan berbagai tombol kontrol panggilan di pustaka ini, misalnya, CameraButton, atau instans ControlBarButton Anda sendiri secara langsung.

function ControlBar(props: ControlBarProps): Element

Parameter

props
ControlBarProps

Mengembalikan

Element

ControlBarButton(ControlBarButtonProps)

Tombol default ditata untuk ControlBar.

Gunakan komponen ini membuat tombol kustom yang ditata sama dengan tombol lain yang disediakan oleh Pustaka UI.

function ControlBarButton(props: ControlBarButtonProps): Element

Parameter

props
ControlBarButtonProps

Mengembalikan

Element

DevicesButton(DevicesButtonProps)

Tombol untuk membuka menu yang mengontrol opsi perangkat.

Dapat digunakan dengan ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parameter

props
DevicesButtonProps

Mengembalikan

Element

EndCallButton(EndCallButtonProps)

Tombol untuk mengakhiri panggilan yang sedang berlangsung.

Dapat digunakan dengan ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parameter

props
EndCallButtonProps

Mengembalikan

Element

ErrorBar(ErrorBarProps)

Komponen untuk menampilkan pesan kesalahan pada UI. Semua string yang dapat ditampilkan diterima sebagai string sehingga dapat dilokalkan. Kesalahan aktif dipilih oleh activeErrorMessages.

Komponen ini secara internal melacak yang diberhentikan oleh pengguna.

  • Kesalahan yang memiliki tanda waktu terkait: Kesalahan ditampilkan pada UI lagi jika terjadi setelah ditutup.
  • Kesalahan yang tidak memiliki tanda waktu: Kesalahan dimatikan sampai hilang dari alat peraga. Jika kesalahan berulang, kesalahan akan ditampilkan di UI.

<xref:%40fluentui%2Freact%23MessageBar> Menggunakan elemen UI.

function ErrorBar(props: ErrorBarProps): Element

Parameter

props
ErrorBarProps

Mengembalikan

Element

FluentThemeProvider(FluentThemeProviderProps)

Penyedia untuk menerapkan tema Fasih di seluruh komponen react pustaka ini.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parameter

props
FluentThemeProviderProps

Mengembalikan

Element

Keterangan

Komponen dalam pustaka ini terdiri terutama dari UI Fasih, kontrol, dan juga dari kontrol Fluent React Northstar. Penyedia ini menangani penerapan tema apa pun yang disediakan untuk kontrol UI Fasih yang mendasar, serta kontrol Fasih React Northstar.

GridLayout(GridLayoutProps)

Komponen untuk meletakkan petak peta peserta audio/video dalam panggilan.

function GridLayout(props: GridLayoutProps): Element

Parameter

props
GridLayoutProps

Mengembalikan

Element

LocalizationProvider(LocalizationProviderProps)

Penyedia untuk menyediakan string yang dilokalkan untuk komponen react pustaka ini.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parameter

props
LocalizationProviderProps

Mengembalikan

Element

Keterangan

Komponen akan diberikan string yang dilokalkan dalam bahasa Inggris (AS) secara default jika penyedia ini tidak digunakan.

MessageStatusIndicator(MessageStatusIndicatorProps)

Komponen untuk menampilkan status pesan terkirim.

Menambahkan ikon dan tipsalat yang sesuai dengan status pesan.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parameter

props
MessageStatusIndicatorProps

Mengembalikan

Element

MessageThread(MessageThreadProps)

MessageThread memungkinkan Anda untuk dengan mudah membuat komponen untuk merender pesan obrolan, menangani perilaku pengguliran pesan baru/lama dan menyesuaikan ikon & kontrol di dalam utas obrolan.

function MessageThread(props: MessageThreadProps): Element

Parameter

props
MessageThreadProps

jenis MessageThreadProps

Pengguna harus menyediakan setidaknya pesan obrolan dan userId untuk merender MessageThread komponen. Pengguna juga dapat menyesuaikan MessageThread dengan melewati Avatar, ikon, MessageStatusIndicatorJumpToNewMessageButton, LoadPreviousMessagesButton dan perilaku kontrol ini sendiri.

MessageThread secara internal menggunakan Chat komponen & Chat.Message dari @fluentui/react-northstar. Anda dapat memeriksa detail tentang kedua komponen ini.

Mengembalikan

Element

MicrophoneButton(MicrophoneButtonProps)

Tombol untuk menyalakan/mematikan mikrofon.

Dapat digunakan dengan ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parameter

props
MicrophoneButtonProps

Mengembalikan

Element

ParticipantItem(ParticipantItemProps)

Komponen untuk merender peserta panggilan atau obrolan.

Menampilkan avatar, displayName dan status peserta serta ikon opsional dan menu konteks.

function ParticipantItem(props: ParticipantItemProps): Element

Parameter

props
ParticipantItemProps

Mengembalikan

Element

ParticipantList(ParticipantListProps)

Komponen untuk merender semua peserta panggilan atau obrolan.

Secara default, setiap peserta dirender dengan ParticipantItem. Lihat <xref:ParticipantListProps.onRenderParticipant> untuk mengambil alih.

function ParticipantList(props: ParticipantListProps): Element

Parameter

props
ParticipantListProps

Mengembalikan

Element

ParticipantsButton(ParticipantsButtonProps)

Tombol untuk menampilkan menu dengan peserta panggilan atau obrolan.

Dapat digunakan dengan ControlBar.

Tombol ini berisi item menu dropdown yang ditentukan melalui propertinya menuProps. Secara default, ini dapat menampilkan jumlah peserta jarak jauh dengan daftar lengkap sebagai sub-menu dan opsi untuk mematikan suara semua peserta, serta tombol salin ke clipboard untuk menyalin URL undangan panggilan. Ini menuProps dapat sepenuhnya ditentukan ulang dan propertinya berjenis IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parameter

props
ParticipantsButtonProps

Mengembalikan

Element

ScreenShareButton(ScreenShareButtonProps)

Tombol untuk memulai/menghentikan berbagi layar.

Dapat digunakan dengan ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parameter

props
ScreenShareButtonProps

Mengembalikan

Element

SendBox(SendBoxProps)

Komponen untuk mengetik dan mengirim pesan.

Mendukung pengiriman pemberitahuan pengetikan saat pengguna mulai memasukkan teks. Mendukung pesan opsional di bawah bidang input teks.

function SendBox(props: SendBoxProps): Element

Parameter

props
SendBoxProps

Mengembalikan

Element

StreamMedia(StreamMediaProps)

Komponen utilitas untuk mengonversi HTMLElement dengan aliran video menjadi elemen JSX.

Gunakan untuk mengonversi HTMLElement yang dikembalikan oleh API panggilan headless menjadi komponen yang dapat dirender sebagai VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Parameter

props
StreamMediaProps

Mengembalikan

Element

TypingIndicator(TypingIndicatorProps)

Komponen untuk memberi tahu pengguna lokal saat satu atau beberapa peserta di utas obrolan sedang mengetik.

function TypingIndicator(props: TypingIndicatorProps): Element

Parameter

props
TypingIndicatorProps

Mengembalikan

Element

VideoGallery(VideoGalleryProps)

VideoGallery mewakili tata letak petak peta video untuk panggilan tertentu. Ini menampilkan VideoTile untuk pengguna lokal serta untuk setiap peserta jarak jauh yang telah bergabung dalam panggilan.

function VideoGallery(props: VideoGalleryProps): Element

Parameter

props
VideoGalleryProps

Mengembalikan

Element

VideoTile(VideoTileProps)

Komponen untuk merender aliran video untuk satu peserta panggilan.

Gunakan dengan GridLayout di VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parameter

props
VideoTileProps

Mengembalikan

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Buat CallAdapter yang didukung oleh Azure Communication Services.

Ini adalah implementasi default CallAdapter yang disediakan oleh pustaka ini.

Catatan: displayName maksimal 256 karakter.

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

Parameter

__namedParameters
AzureCommunicationCallAdapterArgs

Mengembalikan

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Buat CallAdapter menggunakan StatefulCallClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulCallClient. Pertimbangkan untuk menggunakan createAzureCommunicationCallAdapter untuk API yang lebih sederhana.

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

Parameter

callClient
StatefulCallClient
callAgent
CallAgent
locator
CallAdapterLocator

Mengembalikan

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Buat CallWithChatAdapter yang didukung oleh layanan Azure Communication untuk menyambungkan ke CallWithChatComposite.

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

Parameter

__namedParameters
AzureCommunicationCallWithChatAdapterArgs

Mengembalikan

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Buat CallWithChatAdapter menggunakan StatefulChatClient dan StatefulCallClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulChatClient dan StatefulCallClient. Pertimbangkan untuk menggunakan createAzureCommunicationCallWithChatAdapter untuk API yang lebih sederhana.

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

Parameter

__namedParameters
AzureCommunicationCallWithChatAdapterFromClientArgs

Mengembalikan

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Buat ChatAdapter yang didukung oleh Azure Communication Services.

Ini adalah implementasi default ChatAdapter yang disediakan oleh pustaka ini.

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

Parameter

__namedParameters
AzureCommunicationChatAdapterArgs

Mengembalikan

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Buat ChatAdapter menggunakan StatefulChatClient yang disediakan.

Berguna jika Anda ingin menyimpan referensi ke StatefulChatClient. Pertimbangkan untuk menggunakan createAzureCommunicationChatAdapter untuk API yang lebih sederhana.

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

Parameter

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Mengembalikan

Promise<ChatAdapter>

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

Buat implementasi default CallingHandlers untuk panggilan tim.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

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

Parameter

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Mengembalikan

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Buat implementasi default ChatHandlers.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

Objek yang dikembalikan dimoisasi untuk menghindari rerender saat digunakan sebagai alat peraga untuk Komponen React.

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

Parameter

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Mengembalikan

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Membuat StatefulCallClient StatefulCallClient dengan mem-proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> dengan ProxyCallClient <xref:ProxyCallClient> yang kemudian memungkinkan akses ke status dengan cara deklaratif.

Penting untuk menggunakan <xref:%40azure%2Fcommunication-calling%23DeviceManager> dan <xref:%40azure%2Fcommunication-calling%23CallAgent> dan <xref:%40azure%2Fcommunication-calling%23Call> (dan dll.) yang diperoleh dari StatefulCallClient agar perubahan status mereka diproksi dengan benar.

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

Parameter

args
StatefulCallClientArgs

StatefulCallClientArgs

options
StatefulCallClientOptions

StatefulCallClientOptions

Mengembalikan

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Membuat ChatClient StatefulChatClient yang stateful dengan memproksi ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> dengan ProxyChatClient <xref:ProxyChatClient> yang kemudian memungkinkan akses ke status dengan cara deklaratif.

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

Parameter

args
StatefulChatClientArgs
options
StatefulChatClientOptions

Mengembalikan

StatefulChatClient

fromFlatCommunicationIdentifier(string)

Operasi terbalik dari toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parameter

id

string

Mengembalikan

CommunicationIdentifier

getCallingSelector<Component>(Component)

Dapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

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

Parameter

component

Component

Mengembalikan

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Dapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

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

Parameter

component

Component

Mengembalikan

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Representasi string dari <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Representasi string CommunicationIdentifier ini dijamin stabil untuk pengguna Komunikasi yang unik. Dengan demikian,

  • ini dapat digunakan untuk mempertahankan identitas pengguna di database eksternal.
  • dapat digunakan sebagai kunci ke dalam Peta untuk menyimpan data bagi pengguna.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parameter

identifier
CommunicationIdentifier

Mengembalikan

string

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

Kait React kustom untuk menyederhanakan pembuatan CallAdapter.

Mirip dengan createAzureCommunicationCallAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen didefinisikan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.

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

Parameter

args

Partial<AzureCommunicationCallAdapterArgs>

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

Mengembalikan

undefined | CallAdapter

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

Kait React kustom untuk menyederhanakan pembuatan CallWithChatAdapter.

Mirip dengan createAzureCommunicationCallWithChatAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen didefinisikan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.

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

Parameter

args

Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

Mengembalikan

undefined | CallWithChatAdapter

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

Kait React kustom untuk menyederhanakan pembuatan ChatAdapter.

Mirip dengan createAzureCommunicationChatAdapter, tetapi mengurus pembuatan adaptor secara asinkron secara internal.

Memungkinkan argumen tidak terdefinisi sehingga Anda dapat menghormati aturan kait dan meneruskan argumen saat dibuat. Adaptor hanya dibuat ketika semua argumen ditentukan.

Perhatikan bahwa Anda harus memoisasi argumen untuk menghindari pembuatan ulang adaptor pada setiap render. Lihat buku cerita untuk contoh penggunaan umum.

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

Parameter

args

Partial<AzureCommunicationChatAdapterArgs>

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Mengembalikan

undefined | ChatAdapter

useCall()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-calling%23Call> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

Anda sebelumnya harus menggunakan CallProvider dengan objek Panggilan untuk menggunakan hook ini

function useCall(): undefined | Call

Mengembalikan

undefined | Call

useCallAgent()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-calling%23CallAgent> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

function useCallAgent(): undefined | CallAgent

Mengembalikan

undefined | CallAgent

useCallClient()

Hook untuk mendapatkan StatefulCallClient dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

function useCallClient(): StatefulCallClient

Mengembalikan

StatefulCallClient

useChatClient()

Hook untuk mendapatkan StatefulChatClient dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

function useChatClient(): StatefulChatClient

Mengembalikan

StatefulChatClient

useChatThreadClient()

Hook untuk mendapatkan <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

function useChatThreadClient(): ChatThreadClient

Mengembalikan

ChatThreadClient

useDeviceManager()

Hook untuk mendapatkan StatefulDeviceManager dari penyedia.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

function useDeviceManager(): undefined | StatefulDeviceManager

Mengembalikan

undefined | StatefulDeviceManager

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

Hook utama untuk mendapatkan semua kait yang diperlukan untuk Komponen React dari pustaka ini.

Untuk memanggil kait ini, komponen harus dibungkus di bawah penyedia ini:

  1. Untuk komponen obrolan: ChatClientProvider dan ChatThreadClientProvider.

  2. Untuk komponen panggilan: CallClientProvider, CallAgentProvider , dan CallAgentProvider.

Penggunaan komponen yang paling mudah terlihat seperti:

Contoh

    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>

Parameter

component

Component

type

"chat" | "calling"

Mengembalikan

ComponentProps<Component>

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

Kaitkan untuk mendapatkan pemilih untuk komponen tertentu.

Berguna saat menerapkan komponen kustom yang menggunakan penyedia yang diekspor dari pustaka ini.

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

Parameter

selector

ParamT

selectorProps

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

type

"chat" | "calling"

Mengembalikan

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

useTheme()

React hook untuk mengakses tema

function useTheme(): Theme

Mengembalikan

Theme