Class ZoomVideoSdkOnHoldHelper

Implements

ZoomVideoSdkOnHoldHelperType

Index

Constructors

Methods

admit admitAll enableHold getOnHoldUserList isOnHoldEnabled isSupportHold

Constructors

constructor

new ZoomVideoSdkOnHoldHelper(): ZoomVideoSdkOnHoldHelper

Returns ZoomVideoSdkOnHoldHelper

Methods

admit

admit(userId: string): Promise<any>
Admit a user from hold into the session. Host or manager only. Resolves Errors.InvalidParameter when userId is not on hold.
Parameters
- userId: string
Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.admit
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:67

admitAll

admitAll(): Promise<any>
Admit all users currently on hold. Host or manager only.

Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.admitAll
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:71

enableHold

enableHold(enable: boolean): Promise<any>
Enable or disable hold for the session. Host or manager only.
Parameters
- enable: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.enableHold
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:59

getOnHoldUserList

getOnHoldUserList(): Promise<any>
Get the list of users currently on hold.

Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.getOnHoldUserList
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:63

isOnHoldEnabled

isOnHoldEnabled(): Promise<any>
Determine whether hold is currently enabled.

Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.isOnHoldEnabled
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:55

isSupportHold

isSupportHold(): Promise<any>
Determine whether the current session supports the hold feature.

Returns Promise<any>
Implementation of ZoomVideoSdkOnHoldHelperType.isSupportHold
- Defined in native/ZoomVideoSdkOnHoldHelper.ts:51