Type Alias ZoomVideoSdkSubSessionType

ZoomVideoSdkSubSessionType: {
    broadcastMessage: (message: string) => Promise<Errors>;
    commitSubSessionList: (subSessionNameList: string[]) => Promise<Errors>;
    getCommittedSubSessionList: () => Promise<SubSessionKit[]>;
    getRequestSubSessionName: () => Promise<string>;
    getRequestUserName: () => Promise<string>;
    ignore: () => Promise<Errors>;
    isSubSessionStarted: () => Promise<boolean>;
    joinSubSession: (subSessionID: string) => Promise<Errors>;
    joinSubSessionByUserRequest: () => Promise<Errors>;
    requestForHelp: () => Promise<Errors>;
    returnToMainSession: () => Promise<Errors>;
    startSubSession: () => Promise<Errors>;
    stopSubSession: () => Promise<Errors>;
    withdrawSubSessionList: () => Promise<Errors>;
}

A class to operate the sub-session actions.

Type declaration

  • broadcastMessage: (message: string) => Promise<Errors>

    Broadcast message to all sub-sessions. Only host and manger can call this function.

  • commitSubSessionList: (subSessionNameList: string[]) => Promise<Errors>

    Create sub-session list.

  • getCommittedSubSessionList: () => Promise<SubSessionKit[]>

    Get committed sub-session list.

  • getRequestSubSessionName: () => Promise<string>

    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.

  • getRequestUserName: () => Promise<string>

    Get request user name.

  • ignore: () => Promise<Errors>

    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.

  • isSubSessionStarted: () => Promise<boolean>

    Check if sub-session is started.

  • joinSubSession: (subSessionID: string) => Promise<Errors>

    Join a sub-session by sub-session ID.

  • joinSubSessionByUserRequest: () => Promise<Errors>

    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.
  • requestForHelp: () => Promise<Errors>

    Request for help from sub-session. Only attendee can call this function.

  • returnToMainSession: () => Promise<Errors>

    Return to main session from sub-session.

  • startSubSession: () => Promise<Errors>

    Start a sub-session.

  • stopSubSession: () => Promise<Errors>

    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.

  • withdrawSubSessionList: () => Promise<Errors>

    Withdraw sub-session list.

Settings

Member Visibility