Class ZoomVideoSdkSubSession

Implements

ZoomVideoSdkSubSessionType

Index

Constructors

Methods

broadcastMessage commitSubSessionList getCommittedSubSessionList getRequestSubSessionName getRequestUserName ignore isSubSessionStarted joinSubSession joinSubSessionByUserRequest requestForHelp returnToMainSession startSubSession stopSubSession withdrawSubSessionList

Constructors

constructor

new ZoomVideoSdkSubSession(): ZoomVideoSdkSubSession
Returns ZoomVideoSdkSubSession

Methods

broadcastMessage

broadcastMessage(message: string): Promise<any>
Broadcast message to all sub-sessions. Only host and manger can call this function.
Parameters
- message: string
Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.broadcastMessage
- Defined in src/native/ZoomVideoSdkSubSession.ts:150

commitSubSessionList

commitSubSessionList(subSessionNameList: string[]): Promise<any>
Create sub-session list.
Parameters
- subSessionNameList: string[]
Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.commitSubSessionList
- Defined in src/native/ZoomVideoSdkSubSession.ts:178

getCommittedSubSessionList

getCommittedSubSessionList(): Promise<any>
Get committed sub-session list.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.getCommittedSubSessionList
- Defined in src/native/ZoomVideoSdkSubSession.ts:186

getRequestSubSessionName

getRequestSubSessionName(): Promise<any>
Get request sub-session name. When attendee request for help from sub-session, the manager can call this function to get request sub-session name.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.getRequestSubSessionName
- Defined in src/native/ZoomVideoSdkSubSession.ts:166

getRequestUserName

getRequestUserName(): Promise<any>
Get request user name.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.getRequestUserName
- Defined in src/native/ZoomVideoSdkSubSession.ts:162

ignore

ignore(): Promise<any>
Ignore help request. When attendee request for help from sub-session, the manager can call this function to ignore the request, the attendee will receive notification.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.ignore
- Defined in src/native/ZoomVideoSdkSubSession.ts:170

isSubSessionStarted

isSubSessionStarted(): Promise<any>
Check if sub-session is started.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.isSubSessionStarted
- Defined in src/native/ZoomVideoSdkSubSession.ts:146

joinSubSession

joinSubSession(subSessionID: string): Promise<any>
Join a sub-session by sub-session ID.
Parameters
- subSessionID: string
Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.joinSubSession
- Defined in src/native/ZoomVideoSdkSubSession.ts:134

joinSubSessionByUserRequest

joinSubSessionByUserRequest(): Promise<any>
Join sub-session by user request.
- When attendee request for help from sub-session, the manager can call this function to join
- the sub-session.
Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.joinSubSessionByUserRequest
- Defined in src/native/ZoomVideoSdkSubSession.ts:174

requestForHelp

requestForHelp(): Promise<any>
Request for help from sub-session. Only attendee can call this function.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.requestForHelp
- Defined in src/native/ZoomVideoSdkSubSession.ts:158

returnToMainSession

returnToMainSession(): Promise<any>
Return to main session from sub-session.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.returnToMainSession
- Defined in src/native/ZoomVideoSdkSubSession.ts:154

startSubSession

startSubSession(): Promise<any>
Start a sub-session.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.startSubSession
- Defined in src/native/ZoomVideoSdkSubSession.ts:138

stopSubSession

stopSubSession(): Promise<any>
Stop a sub-session, after calling stopSubSession, there will be a buffer period for the participants in the sub-session to exit. Once the buffer period ends, the sub-session will be closed.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.stopSubSession
- Defined in src/native/ZoomVideoSdkSubSession.ts:142

withdrawSubSessionList

withdrawSubSessionList(): Promise<any>
Withdraw sub-session list.

Returns Promise<any>
Implementation of ZoomVideoSdkSubSessionType.withdrawSubSessionList
- Defined in src/native/ZoomVideoSdkSubSession.ts:182