CallWithChatAdapter interface
CallWithChatComposite Интерфейс адаптера.
- Extends
Наследуемые методы
Сведения о наследуемом методе
askDevicePermission(PermissionConstraints)
Запрашивать разрешения устройств.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>Параметры
- constrain
- PermissionConstraints
Определение ограничений для доступа к локальным устройствам <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Возвращаемое значение
Promise<void>
Комментарии
Если разрешения еще не предоставлены, появится окно разрешений браузера.
Наследуется отCallWithChatAdapterManagement.askDevicePermission
createStreamView(string, VideoStreamOptions)
Создайте html-представление для потока.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Параметры
- remoteUserId
-
string
Идентификатор участника для отрисовки, оставьте его неопределенным, чтобы создать локальное представление камеры
- options
- VideoStreamOptions
Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void | CreateVideoStreamViewResult>
Комментарии
Этот метод реализуется для составных.
Наследуется отCallWithChatAdapterManagement.createStreamView
deleteMessage(string)
Удаление сообщения в потоке.
function deleteMessage(messageId: string): Promise<void>Параметры
- messageId
-
string
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.deleteMessage
dispose()
disposeStreamView(string, VideoStreamOptions)
Удалите представление HTML для потока.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Параметры
- remoteUserId
-
string
Идентификатор участника для отрисовки, оставьте его неопределенным, чтобы удалить представление локальной камеры
- options
- VideoStreamOptions
Параметры управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void>
Комментарии
Этот метод реализуется для составных.
Наследуется отCallWithChatAdapterManagement.disposeStreamView
fetchInitialData()
Получение начального состояния для адаптера чата.
Выполняет минимальную выборку, необходимую для методов ChatComposite и API.
function fetchInitialData(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.fetchInitialData
getState()
Получение текущего состояния
function getState(): CallWithChatAdapterStateВозвращаемое значение
Наследуется отAdapterState.getState
joinCall(boolean)
Присоединитесь к вызову с микрофоном, который изначально включен или выключен.
function joinCall(microphoneOn?: boolean): undefined | CallПараметры
- microphoneOn
-
boolean
Включен ли микрофон изначально
Возвращаемое значение
undefined | Call
Наследуется отCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Оставьте звонок.
function leaveCall(forEveryone?: boolean): Promise<void>Параметры
- forEveryone
-
boolean
Следует ли удалять всех участников при выходе
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Загрузите предыдущие сообщения в журнале потоков чата.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>Параметры
- messagesToLoad
-
number
Возвращаемое значение
Promise<boolean>
Комментарии
Этот метод обычно используется для управления добавочной выборкой или бесконечной прокруткой.
Наследуется отCallWithChatAdapterManagement.loadPreviousChatMessages
mute()
Отключите микрофон текущего пользователя во время вызова или отключите микрофон локально.
function mute(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.mute
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)Параметры
- event
-
"callEnded"
- listener
- CallEndedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)Параметры
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Наследуется отCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)Параметры
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)Параметры
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)Параметры
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)Параметры
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Наследуется отCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)Параметры
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)Параметры
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)Параметры
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Параметры
- event
-
"isLocalScreenSharingActiveChanged"
Наследуется отCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)Параметры
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Параметры
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)Параметры
- event
-
"messageRead"
- listener
- MessageReadListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)Параметры
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)Параметры
- event
-
"messageSent"
- listener
- MessageReceivedListener
Наследуется отCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Параметры
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Наследуется отCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Параметры
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Наследуется отCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Отменяет подписку обработчика на события stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)Параметры
- handler
-
(state: CallWithChatAdapterState) => void
Наследуется отAdapterState.offStateChange
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)Параметры
- event
-
"callEnded"
- listener
- CallEndedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)Параметры
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Наследуется отCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)Параметры
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)Параметры
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)Параметры
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)Параметры
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Наследуется отCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)Параметры
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)Параметры
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)Параметры
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Параметры
- event
-
"isLocalScreenSharingActiveChanged"
Наследуется отCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)Параметры
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Параметры
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)Параметры
- event
-
"messageRead"
- listener
- MessageReadListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)Параметры
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)Параметры
- event
-
"messageSent"
- listener
- MessageReceivedListener
Наследуется отCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Параметры
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Наследуется отCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Параметры
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Наследуется отCallWithChatAdapterSubscriptions.on
onStateChange((state: CallWithChatAdapterState) => void)
Подписывает обработчик на события stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)Параметры
- handler
-
(state: CallWithChatAdapterState) => void
Наследуется отAdapterState.onStateChange
queryCameras()
Запрос доступных устройств камеры.
function queryCameras(): Promise<VideoDeviceInfo[]>Возвращаемое значение
Promise<VideoDeviceInfo[]>
Массив сущностей сведений о видеоустройстве <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Комментарии
Этот метод должен вызываться после askDevicePermission()
Наследуется отCallWithChatAdapterManagement.queryCameras
queryMicrophones()
Запрос доступных устройств микрофона.
function queryMicrophones(): Promise<AudioDeviceInfo[]>Возвращаемое значение
Promise<AudioDeviceInfo[]>
Массив сущностей сведений о звуковых устройствах <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Комментарии
Этот метод должен вызываться после askDevicePermission()
Наследуется отCallWithChatAdapterManagement.queryMicrophones
querySpeakers()
Запрос доступных устройств микрофона.
function querySpeakers(): Promise<AudioDeviceInfo[]>Возвращаемое значение
Promise<AudioDeviceInfo[]>
Массив сущностей сведений о звуковых устройствах <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Комментарии
Этот метод должен вызываться после askDevicePermission()
Наследуется отCallWithChatAdapterManagement.querySpeakers
removeParticipant(string)
Удаление участника из вызова.
function removeParticipant(userId: string): Promise<void>Параметры
- userId
-
string
UserId удаляемого участника.
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.removeParticipant
sendMessage(string, SendMessageOptions)
Отправка сообщения в потоке.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>Параметры
- content
-
string
- options
- SendMessageOptions
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Отправка уведомления о прочтении сообщения.
function sendReadReceipt(chatMessageId: string): Promise<void>Параметры
- chatMessageId
-
string
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.sendReadReceipt
sendTypingIndicator()
Отправка индикатора ввода в потоке.
function sendTypingIndicator(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.sendTypingIndicator
setCamera(VideoDeviceInfo, VideoStreamOptions)
Настройте камеру для использования в вызове.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>Параметры
- sourceInfo
- VideoDeviceInfo
Выберите устройство камеры, возвращаемое запросомCameras
- options
- VideoStreamOptions
Параметры для управления отображением потока камеры <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.setCamera
setMicrophone(AudioDeviceInfo)
Задайте микрофон для использования в вызове.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>Параметры
- sourceInfo
- AudioDeviceInfo
Микрофон для выбора, выберите одно из них, возвращенное запросомMicrophones
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.setMicrophone
setSpeaker(AudioDeviceInfo)
Настройте динамик для использования в вызове.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>Параметры
- sourceInfo
- AudioDeviceInfo
Устройство динамиков для выбора, выберите одно из них, возвращенное запросомSpeakers
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.setSpeaker
startCall(string[], StartCallOptions)
Начните вызов.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallПараметры
- participants
-
string[]
Массив идентификаторов участников для присоединения
- options
- StartCallOptions
Возвращаемое значение
undefined | Call
Наследуется отCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Запустите камеру.
Этот метод начнет отрисовку представления локальной камеры, если вызов неактивен.
function startCamera(options?: VideoStreamOptions): Promise<void>Параметры
- options
- VideoStreamOptions
Параметры для управления отображением видеопотоков <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.startCamera
startScreenShare()
Начните делиться экраном во время звонка.
function startScreenShare(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.startScreenShare
stopCamera()
Остановите камеру.
Этот метод остановит отрисовку представления локальной камеры, если вызов неактивен.
function stopCamera(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.stopCamera
stopScreenShare()
Прекратите общий доступ к экрану.
function stopScreenShare(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.stopScreenShare
unmute()
Включите текущий пользователь во время вызова или включите микрофон локально.
function unmute(): Promise<void>Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Обновление содержимого сообщения.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>Параметры
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Возвращаемое значение
Promise<void>
Наследуется отCallWithChatAdapterManagement.updateMessage