WhiteRoomCallbackDelegate Protocol Reference

Conforms to NSObject
Declared in WhiteRoomCallbacks.h

Overview

The event callback interface of the WhiteRoom object.

– firePhaseChanged:

Occurs when the room connection state changes.

- (void)firePhaseChanged:(WhiteRoomPhase)phase

Parameters

phase

The current connection state of the room. See WhiteRoomPhase.

Declared In

WhiteRoomCallbacks.h

– fireRoomStateChanged:

Occurs when the room state changes.

- (void)fireRoomStateChanged:(WhiteRoomState *)modifyState

Parameters

modifyState

The room state that has changed. See WhiteRoomState.

Discussion

This callback reports only the room state fields that have changed and returns null for the room state fields that have not changed.

Declared In

WhiteRoomCallbacks.h

– fireDisconnectWithError:

Occurs when the SDK loses connection with the Interactive Whiteboard server.

- (void)fireDisconnectWithError:(NSString *)error

Parameters

error

An error message.

Declared In

WhiteRoomCallbacks.h

– fireKickedWithReason:

Occurs when the local user is removed from the live Interactive Whiteboard room.

- (void)fireKickedWithReason:(NSString *)reason

Parameters

reason

The reason why the user is removed from the room.

Declared In

WhiteRoomCallbacks.h

– fireCatchErrorWhenAppendFrame:error:

Reports the errors that occur during the synchronization of a user’s operations.

- (void)fireCatchErrorWhenAppendFrame:(NSUInteger)userId error:(NSString *)error

Parameters

userId

The user ID of the user whose operations are being synchronized.
error

An error message.

Declared In

WhiteRoomCallbacks.h

– fireCanUndoStepsUpdate:

Occurs when the number of undoable actions changes.

- (void)fireCanUndoStepsUpdate:(NSInteger)canUndoSteps

Parameters

canUndoSteps

The number of remaining undoable actions.

Discussion

The SDK triggers this callback every time the local user calls undo and reports the number of remaining undoable actions.

Declared In

WhiteRoomCallbacks.h

– fireCanRedoStepsUpdate:

Occurs when the number of undoable actions changes.

- (void)fireCanRedoStepsUpdate:(NSInteger)canRedoSteps

Parameters

canRedoSteps

The number of remaining undoable actions.

Discussion

The SDK triggers this callback every time the local user calls redo and reports the number of remaining undoable actions.

Declared In

WhiteRoomCallbacks.h

– fireMagixEvent:

Occurs when the a custom event is created.

- (void)fireMagixEvent:(WhiteEvent *)event

Parameters

event

A custom event. See WhiteEvent.

Declared In

WhiteRoomCallbacks.h

– fireHighFrequencyEvent:

Occurs when the a high frequency event is created.

- (void)fireHighFrequencyEvent:(NSArray<WhiteEvent*> *)events

Parameters

events

A high frequency event. See WhiteEvent.

Declared In

WhiteRoomCallbacks.h