Type Alias ZoomVideoSdkOnHoldHelperType

A class to operate the on-hold (holding) state in the join flow.

type ZoomVideoSdkOnHoldHelperType = {
    admit: (userId: string) => Promise<Errors>;
    admitAll: () => Promise<Errors>;
    enableHold: (enable: boolean) => Promise<Errors>;
    getOnHoldUserList: () => Promise<ZoomVideoSdkOnHoldUserType[]>;
    isOnHoldEnabled: () => Promise<boolean>;
    isSupportHold: () => Promise<boolean>;
}

Properties

admit: (userId: string) => Promise<Errors>

Admit a user from hold into the session. Host or manager only. Resolves Errors.InvalidParameter when userId is not on hold.

admitAll: () => Promise<Errors>

Admit all users currently on hold. Host or manager only.

enableHold: (enable: boolean) => Promise<Errors>

Enable or disable hold for the session. Host or manager only.

getOnHoldUserList: () => Promise<ZoomVideoSdkOnHoldUserType[]>

Get the list of users currently on hold.

isOnHoldEnabled: () => Promise<boolean>

Determine whether hold is currently enabled.

isSupportHold: () => Promise<boolean>

Determine whether the current session supports the hold feature.