Agora Interactive Whiteboard Java API Reference
Public Member Functions | List of all members
com.herewhite.sdk.domain.RoomMember Class Reference

Public Member Functions

MemberState getMemberState ()
 
Object getPayload ()
 
Long getMemberId ()
 
String getCurrentApplianceName ()
 
MemberInformation getInformation ()
 

Detailed Description

The RoomMember class, for getting the information of the users in interactive mode in the live Interactive Whiteboard room.

Note
This class applies to the users in interactive mode only, because the users in subscription mode are not room members.

Member Function Documentation

◆ getMemberState()

MemberState com.herewhite.sdk.domain.RoomMember.getMemberState ( )

Gets the state of the whiteboard tool currently in use by the user.

Since
2.4.8
Returns
The state of the whiteboard tool currently in use. See MemberState.

◆ getPayload()

Object com.herewhite.sdk.domain.RoomMember.getPayload ( )

Gets the customized user information of the user that is passed in when the user joins the room.

Since
2.4.8

◆ getMemberId()

Long com.herewhite.sdk.domain.RoomMember.getMemberId ( )

Gets the member ID of the user.

When a user joins the live Interactive Whiteboard room in interactive mode, the SDK assigns a unique member ID for the user.

Returns
The member ID of the user.

◆ getCurrentApplianceName()

String com.herewhite.sdk.domain.RoomMember.getCurrentApplianceName ( )

Gets the whiteboard tool currently in use by the user.

Since
2.4.8
Deprecated:
This method is deprecated. Use getMemberState instead.
Returns
The name of the whiteboard tool.

◆ getInformation()

MemberInformation com.herewhite.sdk.domain.RoomMember.getInformation ( )

Gets the customized user information that is passed in when the user joins the room.

Deprecated:
This method is deprecated. Use getPayload instead.
Returns
The customized user information.