Signaling (previously RTM) SDK v1.5.0 API Reference for Android
Public Member Functions | List of all members
io.agora.rtm.RtmChannelMemberCount Class Reference

Public Member Functions

  RtmChannelMemberCount (String channelID, int memberCount)
 
void  setChannelID (String channelID)
 
String  getChannelID ()
 
void  setMemberCount (int memberCount)
 
int  getMemberCount ()
 
String  toString ()
 

Constructor & Destructor Documentation

◆ RtmChannelMemberCount()

io.agora.rtm.RtmChannelMemberCount.RtmChannelMemberCount ( String  channelID,
int  memberCount 
)

The construction method of the RtmChannelMemberCount class.

Parameters
channelID The ID of the channel. The string length must be less than 64 bytes with the following character scope:
  • The 26 lowercase English letters: a to z
  • The 26 uppercase English letters: A to Z
  • The 10 numbers: 0 to 9
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
Note A channelId cannot be empty, null, or "null".
memberCount The member count of channel [channelID].

Member Function Documentation

◆ setChannelID()

void io.agora.rtm.RtmChannelMemberCount.setChannelID ( String  channelID )

Sets the ID of the channel.

Parameters
channelID The ID of the channel. The string length must be less than 64 bytes with the following character scope:
  • The 26 lowercase English letters: a to z
  • The 26 uppercase English letters: A to Z
  • The 10 numbers: 0 to 9
  • Space
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
Note A channelId cannot be empty, null, or "null".

◆ getChannelID()

String io.agora.rtm.RtmChannelMemberCount.getChannelID ( )

Gets the ID of the channel.

Returns
The channel ID.

◆ setMemberCount()

void io.agora.rtm.RtmChannelMemberCount.setMemberCount ( int  memberCount )

FOR INTERNAL USE ONLY

◆ getMemberCount()

int io.agora.rtm.RtmChannelMemberCount.getMemberCount ( )

Gets the current member count of the channel.

Returns
  • The current channel member count.
  • 0, if a channel with the specified channelId is not found.