TeamsCallingHandlers interface
Объект, содержащий все обработчики вызовов teams, необходимые для вызова компонентов.
Вызов связанных компонентов из этого пакета может выбрать соответствующие обработчики из этого объекта. См. <xref:useHandlers> и usePropsFor.
- Extends
Свойства
| on |
Унаследованные свойства
Наследуемые методы
Сведения о свойстве
onStartCall
onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall
Значение свойства
(participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall
Сведения об унаследованном свойстве
onAcceptCall
onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>
Значение свойства
(incomingCallId: string, useVideo?: boolean) => Promise<void>
Наследуется отCommonCallingHandlers.onAcceptCall
onBlurVideoBackground
onBlurVideoBackground: (backgroundBlurConfig?: VideoEffectConfig) => Promise<void>
Значение свойства
(backgroundBlurConfig?: VideoEffectConfig) => Promise<void>
Наследуется отCommonCallingHandlers.onBlurVideoBackground
onCreateLocalStreamView
onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
Значение свойства
(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
наследуется отCommonCallingHandlers.onCreateLocalStreamView
onCreateRemoteStreamView
onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
Значение свойства
(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
унаследован отCommonCallingHandlers.onCreateRemoteStreamView
onCreateTogetherModeStreamView
Обратный звонок для создания представления для режима «вместе»
onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
Значение свойства
(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
наследуется отCommonCallingHandlers.onCreateTogetherModeStreamView
onDisposeLocalScreenShareStreamView
onDisposeLocalScreenShareStreamView: () => Promise<void>
Значение свойства
() => Promise<void>
наследуется отCommonCallingHandlers.onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeLocalStreamView: () => Promise<void>
Значение свойства
() => Promise<void>
унаследовано отCommonCallingHandlers.onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteScreenShareStreamView: (userId: string) => Promise<void>
Значение свойства
(userId: string) => Promise<void>
Наследуется отCommonCallingHandlers.onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
Предупреждение
Теперь этот API является нерекомендуемым.
use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.
onDisposeRemoteStreamView: (userId: string) => Promise<void>
Значение свойства
(userId: string) => Promise<void>
унаследован отCommonCallingHandlers.onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeRemoteVideoStreamView: (userId: string) => Promise<void>
Значение свойства
(userId: string) => Promise<void>
наследуется отCommonCallingHandlers.onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView
Обратный вызов для совместной работы в режиме просмотра
onDisposeTogetherModeStreamView: () => Promise<void>
Значение свойства
() => Promise<void>
наследуется отCommonCallingHandlers.onDisposeTogetherModeStreamView
onForbidAudio
Запрет удаленным участникам отправлять аудио
onForbidAudio?: (userIds: string[]) => Promise<void>
Значение свойства
(userIds: string[]) => Promise<void>
Наследуется отCommonCallingHandlers.onForbidAudio
onForbidOthersAudio
Изменение параметра собрания запрещает удаленным участникам отправлять аудио
onForbidOthersAudio?: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onForbidOthersAudio
onForbidOthersVideo
Изменение параметра собрания запрещает удаленным участникам отправлять видео
onForbidOthersVideo?: () => Promise<void>
Значение свойства
() => Promise<void>
Унаследовано отCommonCallingHandlers.onForbidOthersVideo
onForbidVideo
Запрет удаленным участникам отправлять видео
onForbidVideo?: (userIds: string[]) => Promise<void>
Значение свойства
(userIds: string[]) => Promise<void>
Унаследовано отCommonCallingHandlers.onForbidVideo
onHangUp
onHangUp: (forEveryone?: boolean) => Promise<void>
Значение свойства
(forEveryone?: boolean) => Promise<void>
унаследован отCommonCallingHandlers.onHangUp
onLowerHand
onLowerHand: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onLowerHand
onMuteAllRemoteParticipants
onMuteAllRemoteParticipants: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onMuteAllRemoteParticipants
onMuteParticipant
onMuteParticipant: (userId: string) => Promise<void>
Значение свойства
(userId: string) => Promise<void>
Наследуется отCommonCallingHandlers.onMuteParticipant
onPermitAudio
Разрешение удаленным участникам отправлять аудио
onPermitAudio?: (userIds: string[]) => Promise<void>
Значение свойства
(userIds: string[]) => Promise<void>
Наследуется отCommonCallingHandlers.onPermitAudio
onPermitOthersAudio
Изменить параметр собрания позволяет удаленным участникам отправлять аудио
onPermitOthersAudio?: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onPermitOthersAudio
onPermitOthersVideo
Изменить параметр собрания позволяет удаленным участникам отправлять видео
onPermitOthersVideo?: () => Promise<void>
Значение свойства
() => Promise<void>
Унаследовано отCommonCallingHandlers.onPermitOthersVideo
onPermitVideo
Разрешение удаленным участникам отправлять видео
onPermitVideo?: (userIds: string[]) => Promise<void>
Значение свойства
(userIds: string[]) => Promise<void>
Наследуется отCommonCallingHandlers.onPermitVideo
onRaiseHand
onRaiseHand: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onRaiseHand
onReactionClick
onReactionClick: (reaction: Reaction) => Promise<void>
Значение свойства
(reaction: Reaction) => Promise<void>
Наследуется отCommonCallingHandlers.onReactionClick
onRejectCall
onRejectCall: (incomingCallId: string) => Promise<void>
Значение свойства
(incomingCallId: string) => Promise<void>
Наследуется отCommonCallingHandlers.onRejectCall
onRemoveVideoBackgroundEffects
onRemoveVideoBackgroundEffects: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>
Значение свойства
(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>
Наследуется отCommonCallingHandlers.onReplaceVideoBackground
onSelectCamera
onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>
Значение свойства
(device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>
унаследован отCommonCallingHandlers.onSelectCamera
onSelectMicrophone
onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>
Значение свойства
(device: AudioDeviceInfo) => Promise<void>
унаследовано отCommonCallingHandlers.onSelectMicrophone
onSelectSpeaker
onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>
Значение свойства
(device: AudioDeviceInfo) => Promise<void>
унаследован отCommonCallingHandlers.onSelectSpeaker
onSendDtmfTone
onSendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Значение свойства
(dtmfTone: DtmfTone) => Promise<void>
наследуется отCommonCallingHandlers.onSendDtmfTone
onSendRealTimeText
onSendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Значение свойства
(text: string, isFinalized: boolean) => Promise<void>
наследуется отCommonCallingHandlers.onSendRealTimeText
onSetCaptionLanguage
onSetCaptionLanguage: (language: string) => Promise<void>
Значение свойства
(language: string) => Promise<void>
Наследуется отCommonCallingHandlers.onSetCaptionLanguage
onSetSpokenLanguage
onSetSpokenLanguage: (language: string) => Promise<void>
Значение свойства
(language: string) => Promise<void>
Наследуется отCommonCallingHandlers.onSetSpokenLanguage
onSetTogetherModeSceneSize
Режим Call set together размер сцены
onSetTogetherModeSceneSize: (width: number, height: number) => void
Значение свойства
(width: number, height: number) => void
Наследуется отCommonCallingHandlers.onSetTogetherModeSceneSize
onStartCaptions
onStartCaptions: (options?: CaptionsOptions) => Promise<void>
Значение свойства
(options?: CaptionsOptions) => Promise<void>
Наследуется отCommonCallingHandlers.onStartCaptions
onStartLocalVideo
onStartLocalVideo: () => Promise<void>
Значение свойства
() => Promise<void>
наследуется отCommonCallingHandlers.onStartLocalVideo
onStartNoiseSuppressionEffect
onStartNoiseSuppressionEffect: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onStartNoiseSuppressionEffect
onStartScreenShare
onStartScreenShare: () => Promise<void>
Значение свойства
() => Promise<void>
унаследован отCommonCallingHandlers.onStartScreenShare
onStartSpotlight
onStartSpotlight: (userIds?: string[]) => Promise<void>
Значение свойства
(userIds?: string[]) => Promise<void>
Наследуется отCommonCallingHandlers.onStartSpotlight
onStartTogetherMode
Обратный звонок для создания представления для режима «вместе»
onStartTogetherMode: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onStartTogetherMode
onStopAllSpotlight
onStopAllSpotlight: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onStopAllSpotlight
onStopCaptions
onStopCaptions: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onStopCaptions
onStopNoiseSuppressionEffect
onStopNoiseSuppressionEffect: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onStopNoiseSuppressionEffect
onStopScreenShare
onStopScreenShare: () => Promise<void>
Значение свойства
() => Promise<void>
унаследовано отCommonCallingHandlers.onStopScreenShare
onStopSpotlight
onStopSpotlight: (userIds?: string[]) => Promise<void>
Значение свойства
(userIds?: string[]) => Promise<void>
Унаследовано отCommonCallingHandlers.onStopSpotlight
onToggleCamera
onToggleCamera: (options?: VideoStreamOptions) => Promise<void>
Значение свойства
(options?: VideoStreamOptions) => Promise<void>
унаследован отCommonCallingHandlers.onToggleCamera
onToggleHold
onToggleHold: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onToggleHold
onToggleMicrophone
onToggleMicrophone: () => Promise<void>
Значение свойства
() => Promise<void>
унаследован отCommonCallingHandlers.onToggleMicrophone
onToggleRaiseHand
onToggleRaiseHand: () => Promise<void>
Значение свойства
() => Promise<void>
Наследуется отCommonCallingHandlers.onToggleRaiseHand
onToggleScreenShare
onToggleScreenShare: () => Promise<void>
Значение свойства
() => Promise<void>
наследуется отCommonCallingHandlers.onToggleScreenShare
Сведения о наследуемом методе
onAddParticipant(CommunicationUserIdentifier)
function onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>
Параметры
- participant
- CommunicationUserIdentifier
Возвращаемое значение
Promise<void>
Наследуется отCommonCallingHandlers.onAddParticipant
onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
function onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>
Параметры
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Возвращаемое значение
Promise<void>
Наследуется отCommonCallingHandlers.onAddParticipant
onRemoveParticipant(CommunicationIdentifier)
function onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>
Параметры
- participant
- CommunicationIdentifier
Возвращаемое значение
Promise<void>
унаследован отCommonCallingHandlers.onRemoveParticipant
onRemoveParticipant(string)
function onRemoveParticipant(userId: string): Promise<void>
Параметры
- userId
-
string
Возвращаемое значение
Promise<void>
унаследован отCommonCallingHandlers.onRemoveParticipant
onSubmitSurvey(CallSurvey)
function onSubmitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
Параметры
- survey
- CallSurvey
Возвращаемое значение
Promise<undefined | CallSurveyResponse>
Наследуется отCommonCallingHandlers.onSubmitSurvey