AgoraEduSubRoomContext

The AgoraEduSubRoomContext class.

The AgoraEduSubRoomContext class provides methods for controlling sub-rooms.

joinSubRoom

Joins a sub-room.

void joinSubRoom(Callback<Void> success,
                 Callback<AgoraEduContextError> failure)

Parameter

success: The method call succeeds.
fail: If the method call fails, the SDK returns AgoraEduContextError.

Returns

If the method call succeeds, the SDK returns the current sub-room information AgoraEduContextSubRoomInfo.

leaveSubRoom

Leaves the sub-room.

void leaveSubRoom()

getSubRoomInfo

Gets the sub-room information.

AgoraEduContextSubRoomInfo getSubRoomInfo()

Returns

If the method call succeeds, the SDK returns the current sub-room information AgoraEduContextSubRoomInfo.

getSubRoomProperties

Gets the custom properties of a sub-room.

Map<String, Any> getSubRoomProperties()

Returns

The custom properties of a sub-room: Map<String, Any>. This parameter can be null.

updateSubRoomProperties

Updates the custom properties of a sub-room.

void updateSubRoomProperties(Map<String, Any> properties,
                             Map<String, Any> cause,
                             Callback<Void> success,
                             Callback<AgoraEduContextError> failure)

Parameter

properties: Room properties.
cause: The update reason. This parameter can be null.
success: The method call succeeds.
fail: If the method call fails, the SDK returns AgoraEduContextError.

deleteSubRoomProperties

Deletes the custom properties of a sub-room.

void deleteSubRoomProperties(Array<String> keyPaths,
                             Map<String, Any> cause,
                             Callback<Void> success,
                             Callback<AgoraEduContextError> failure)

Parameter

keyPaths: The key path of the property that you want to delete, such as key1.subkey1.
cause: The reason for deletion. This parameter can be null.
success: The method call succeeds.
fail: If the method call fails, the SDK returns AgoraEduContextError.