Public Member Functions | |
| void | onPhaseChanged (RoomPhase phase) |
| void | onDisconnectWithError (Exception e) |
| void | onKickedWithReason (String reason) |
| void | onRoomStateChanged (RoomState modifyState) |
| void | onCanUndoStepsUpdate (long canUndoSteps) |
| void | onCanRedoStepsUpdate (long canRedoSteps) |
| void | onCatchErrorWhenAppendFrame (long userId, Exception error) |
Detailed Description
The event callback interface of the Room instance.
Member Function Documentation
◆ onPhaseChanged()
| void com.herewhite.sdk.RoomListener.onPhaseChanged | ( | RoomPhase | phase | ) |
Occurs when the room connection state changes.
- Parameters
-
phase The current connection state of the room. See RoomPhase.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onDisconnectWithError()
| void com.herewhite.sdk.RoomListener.onDisconnectWithError | ( | Exception | e | ) |
Occurs when the SDK loses connection with the Interactive Whiteboard server.
- Parameters
-
e An error message.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onKickedWithReason()
| void com.herewhite.sdk.RoomListener.onKickedWithReason | ( | String | reason | ) |
Occurs when the local user is removed from the live Interactive Whiteboard room.
- Parameters
-
reason The reason why the user is removed from the room.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onRoomStateChanged()
| void com.herewhite.sdk.RoomListener.onRoomStateChanged | ( | RoomState | modifyState | ) |
Occurs when the room state changes.
This callback reports only the room state fields that have changed and returns null for the room state fields that have not changed.
- Parameters
-
modifyState The room state that has changed. See RoomState.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onCanUndoStepsUpdate()
| void com.herewhite.sdk.RoomListener.onCanUndoStepsUpdate | ( | long | canUndoSteps | ) |
Occurs when the number of undoable actions changes.
The SDK triggers this callback every time the local user calls undo and reports the number of remaining undoable actions.
- Parameters
-
canUndoSteps The number of remaining undoable actions.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onCanRedoStepsUpdate()
| void com.herewhite.sdk.RoomListener.onCanRedoStepsUpdate | ( | long | canRedoSteps | ) |
Occurs when the number of redoable actions changes.
The SDK triggers this callback every time the local user calls redo and reports the number of remaining redoable actions.
- Parameters
-
canRedoSteps The number of remaining redoable actions.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
◆ onCatchErrorWhenAppendFrame()
| void com.herewhite.sdk.RoomListener.onCatchErrorWhenAppendFrame | ( | long | userId, |
| Exception | error | ||
| ) |
Reports the errors that occur during the synchronization of a user's operations.
- Parameters
-
userId The user ID of the user whose operations are being synchronized. error An error message.
Implemented in com.herewhite.sdk.AbstractRoomCallbacks.
