AgoraEduSubRoomHandler

The AgoraEduSubRoomHandler class contains the event callbacks related to sub-rooms.

onJoinSubRoomSuccess

Occurs when the local user successfully joins the room.

void onJoinSubRoomSuccess(roomInfo: AgoraEduContextSubRoomInfo)

Parameter

roomInfo: The room information: AgoraEduContextRoomInfo.

onJoinSubRoomFailure

Occurs when the local user fails to join the sub-room.

void onJoinSubRoomFailure(roomInfo: AgoraEduContextRoomInfo,
                          error: AgoraEduContextError)

Parameter

roomInfo: The room information: AgoraEduContextRoomInfo.
error: The reason why the user fails to join the room: AgoraEduContextError.

onSubRoomPropertiesUpdated

Occurs when the custom properties of a sub-room are updated.

void onSubRoomPropertiesUpdated(Map<String, Any> changedProperties,
                                Map<String, Any> cause,
                                AgoraEduContextUserInfo operator)

Parameter

changedProperties: The updated room properties.
cause: The update reason.
operator: The operator AgoraEduContextUserInfo, which can be empty.

onSubRoomPropertiesDeleted

Occurs when the custom properties of a sub-room are deleted.

void onSubRoomPropertiesDeleted(Array<String> keyPaths,
                                Map<String, Any> cause,
                                AgoraEduContextUserInfo operator)

Parameter

keyPaths: The keyPath array of the deleted properties.
cause: The reason for deletion.
operator: The operator AgoraEduContextUserInfo, which can be empty.

onSubRoomClosed

Occurs when a room is closed.

void onSubRoomClosed()