CallWithChatAdapter interface
- Rozszerzenie
Metody dziedziczone
Szczegóły metody dziedziczonej
askDevicePermission(PermissionConstraints)
Poproś o uprawnienia urządzeń.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>Parametry
- constrain
- PermissionConstraints
Definiowanie ograniczeń dotyczących uzyskiwania dostępu do urządzeń lokalnych <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Zwraca
Promise<void>
Uwagi
Jeśli uprawnienia nie zostały jeszcze przyznane, zostanie wyświetlone okno uprawnień przeglądarki.
dziedziczone zCallWithChatAdapterManagement.askDevicePermission
createStreamView(string, VideoStreamOptions)
Utwórz widok HTML dla strumienia.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Parametry
- remoteUserId
-
string
Identyfikator uczestnika do renderowania, pozostaw go niezdefiniowany, aby utworzyć lokalny widok aparatu
- options
- VideoStreamOptions
Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Zwraca
Promise<void | CreateVideoStreamViewResult>
Uwagi
Ta metoda jest implementowana dla złożonego.
dziedziczone zCallWithChatAdapterManagement.createStreamView
deleteMessage(string)
Usuń komunikat w wątku.
function deleteMessage(messageId: string): Promise<void>Parametry
- messageId
-
string
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.deleteMessage
dispose()
disposeStreamView(string, VideoStreamOptions)
Usuwanie widoku HTML dla strumienia.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Parametry
- remoteUserId
-
string
Identyfikator uczestnika do renderowania, pozostaw niezdefiniowany, aby usunąć widok aparatu lokalnego
- options
- VideoStreamOptions
Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Zwraca
Promise<void>
Uwagi
Ta metoda jest implementowana dla złożonego.
dziedziczone zCallWithChatAdapterManagement.disposeStreamView
fetchInitialData()
Pobierz stan początkowy dla karty czatu.
Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.
function fetchInitialData(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.fetchInitialData
getState()
Pobieranie bieżącego stanu
function getState(): CallWithChatAdapterStateZwraca
dziedziczone zAdapterState.getState
joinCall(boolean)
Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.
function joinCall(microphoneOn?: boolean): undefined | CallParametry
- microphoneOn
-
boolean
Czy mikrofon jest początkowo włączony
Zwraca
undefined | Call
dziedziczone zCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Pozostaw połączenie.
function leaveCall(forEveryone?: boolean): Promise<void>Parametry
- forEveryone
-
boolean
Czy usunąć wszystkich uczestników podczas opuszczania
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Załaduj więcej poprzednich wiadomości w historii wątku czatu.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>Parametry
- messagesToLoad
-
number
Zwraca
Promise<boolean>
Uwagi
Ta metoda jest zwykle używana do kontrolowania przyrostowego pobierania/nieskończonego przewijania.
dziedziczone zCallWithChatAdapterManagement.loadPreviousChatMessages
mute()
Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie.
function mute(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.mute
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)Parametry
- event
-
"callEnded"
- listener
- CallEndedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)Parametry
- event
-
"callError"
- listener
-
(e: AdapterError) => void
dziedziczone zCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)Parametry
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)Parametry
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)Parametry
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)Parametry
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
dziedziczone zCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)Parametry
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)Parametry
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)Parametry
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parametry
- event
-
"isLocalScreenSharingActiveChanged"
dziedziczone zCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)Parametry
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Parametry
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)Parametry
- event
-
"messageRead"
- listener
- MessageReadListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)Parametry
- event
-
"messageReceived"
- listener
- MessageReceivedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)Parametry
- event
-
"messageSent"
- listener
- MessageReceivedListener
dziedziczone zCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Parametry
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
dziedziczone zCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Parametry
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
dziedziczone zCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)Parametry
- handler
-
(state: CallWithChatAdapterState) => void
dziedziczone zAdapterState.offStateChange
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)Parametry
- event
-
"callEnded"
- listener
- CallEndedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)Parametry
- event
-
"callError"
- listener
-
(e: AdapterError) => void
dziedziczone zCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)Parametry
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)Parametry
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)Parametry
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)Parametry
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
dziedziczone zCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)Parametry
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)Parametry
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)Parametry
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parametry
- event
-
"isLocalScreenSharingActiveChanged"
dziedziczone zCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)Parametry
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Parametry
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)Parametry
- event
-
"messageRead"
- listener
- MessageReadListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)Parametry
- event
-
"messageReceived"
- listener
- MessageReceivedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)Parametry
- event
-
"messageSent"
- listener
- MessageReceivedListener
dziedziczone zCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Parametry
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
dziedziczone zCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Parametry
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
dziedziczone zCallWithChatAdapterSubscriptions.on
onStateChange((state: CallWithChatAdapterState) => void)
Subskrybuje program obsługi do zdarzeń stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)Parametry
- handler
-
(state: CallWithChatAdapterState) => void
dziedziczone zAdapterState.onStateChange
queryCameras()
Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.
function queryCameras(): Promise<VideoDeviceInfo[]>Zwraca
Promise<VideoDeviceInfo[]>
Tablica jednostek informacji o urządzeniu wideo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Uwagi
Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()
dziedziczone zCallWithChatAdapterManagement.queryCameras
queryMicrophones()
Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
function queryMicrophones(): Promise<AudioDeviceInfo[]>Zwraca
Promise<AudioDeviceInfo[]>
Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Uwagi
Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()
dziedziczone zCallWithChatAdapterManagement.queryMicrophones
querySpeakers()
Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
function querySpeakers(): Promise<AudioDeviceInfo[]>Zwraca
Promise<AudioDeviceInfo[]>
Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Uwagi
Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()
dziedziczone zCallWithChatAdapterManagement.querySpeakers
removeParticipant(string)
Usuń uczestnika z połączenia.
function removeParticipant(userId: string): Promise<void>Parametry
- userId
-
string
UserId uczestnika do usunięcia.
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.removeParticipant
sendMessage(string, SendMessageOptions)
Wyślij wiadomość w wątku.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>Parametry
- content
-
string
- options
- SendMessageOptions
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Wyślij potwierdzenie odczytu dla wiadomości.
function sendReadReceipt(chatMessageId: string): Promise<void>Parametry
- chatMessageId
-
string
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.sendReadReceipt
sendTypingIndicator()
Wyślij wskaźnik wpisywania w wątku.
function sendTypingIndicator(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.sendTypingIndicator
setCamera(VideoDeviceInfo, VideoStreamOptions)
Ustaw aparat do użycia w wywołaniu.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>Parametry
- sourceInfo
- VideoDeviceInfo
Urządzenie aparatu do wyboru, wybierz jedno zwrócone przez queryCameras
- options
- VideoStreamOptions
Opcje kontrolowania sposobu renderowania strumienia aparatu <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.setCamera
setMicrophone(AudioDeviceInfo)
Ustaw mikrofon do użycia w wywołaniu.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>Parametry
- sourceInfo
- AudioDeviceInfo
Urządzenie mikrofonu do wyboru, wybierz jedno zwrócone przez zapytanieMicrophones
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.setMicrophone
setSpeaker(AudioDeviceInfo)
Ustaw głośnik do użycia w wywołaniu.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>Parametry
- sourceInfo
- AudioDeviceInfo
Urządzenie mówiące do wyboru, wybierz jedno zwrócone przez querySpeakers
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.setSpeaker
startCall(string[], StartCallOptions)
Uruchom wywołanie.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallParametry
- participants
-
string[]
Tablica identyfikatorów uczestników do przyłączenia
- options
- StartCallOptions
Zwraca
undefined | Call
dziedziczone zCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Uruchom aparat.
Ta metoda rozpocznie renderowanie lokalnego widoku aparatu, gdy wywołanie nie jest aktywne.
function startCamera(options?: VideoStreamOptions): Promise<void>Parametry
- options
- VideoStreamOptions
Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.startCamera
startScreenShare()
Rozpocznij udostępnianie ekranu podczas połączenia.
function startScreenShare(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.startScreenShare
stopCamera()
Zatrzymaj aparat.
Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne.
function stopCamera(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.stopCamera
stopScreenShare()
Zatrzymaj udostępnianie ekranu.
function stopScreenShare(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.stopScreenShare
unmute()
Anuluj wyciszenie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie.
function unmute(): Promise<void>Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Aktualizowanie zawartości wiadomości.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>Parametry
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Zwraca
Promise<void>
dziedziczone zCallWithChatAdapterManagement.updateMessage