ZoomVideoSdkSubSessionHelper class
Helper class for managing sub-sessions (breakout rooms) in the session.
- Inheritance
-
- Object
- PlatformInterface
- ZoomVideoSdkSubSessionHelper
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- methodChannel → MethodChannel
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
broadcastMessage(
String message) → Future< String> -
Broadcast a message to all sub-sessions.
messageThe message content to broadcast
Note: Only the session host/manager can broadcast messages.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
commitSubSessionList(
List< String> subSessionNames) → Future<String> -
Commit the sub-session list to create or update sub-sessions.
subSessionNamesA list of sub-session names to create
Note: Only the session host/manager can commit sub-session lists.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
getCommittedSubSessionList(
) → Future< List< ZoomVideoSdkSubSessionKit> > -
Get the list of committed sub-sessions.
Return a JSON string containing the list of committed sub-sessions. -
getRequestSubSessionName(
) → Future< String> -
Get the name of the sub-session where help is requested.
Return the sub-session name as a string. -
getRequestUserName(
) → Future< String> -
Get the name of the user requesting help.
Return the user name as a string. -
ignoreUserHelpRequest(
) → Future< String> -
Ignore a help request from a participant in a sub-session.
Note: Only the session host/manager can ignore help requests.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
isSubSessionStarted(
) → Future< bool> -
Check if the sub-session has been started.
Return true if the sub-session is started, otherwise false. -
joinSubSession(
String subSessionId) → Future< String> -
Join a specific sub-session.
subSessionIdThe ID of the sub-session to join
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
joinSubSessionByUserRequest(
) → Future< String> -
Join the sub-session where a user has requested help.
Note: Only the session host/manager can use this function.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
requestForHelp(
) → Future< String> -
Request help from the host/manager when in a sub-session.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
returnToMainSession(
) → Future< String> -
Return to the main session from a sub-session.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
startSubSession(
) → Future< String> -
Start the sub-session.
Note: Only the session host/manager can start sub-sessions.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
stopSubSession(
) → Future< String> -
Stop the sub-session.
Note: Only the session host/manager can stop sub-sessions.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error. -
toString(
) → String -
A string representation of this object.
inherited
-
withdrawSubSessionList(
) → Future< String> -
Withdraw the sub-session list (cancel uncommitted sub-session changes).
Note: Only the session host/manager can withdraw sub-session lists.
ReturnZoomVideoSDKError_Successif the function succeeds. Otherwise, this function returns an error.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited