Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.rtm.JoinChannelOptions Class Reference

Public Member Functions

 JoinChannelOptions ()
 
 JoinChannelOptions (String token, boolean withPresence, boolean withMetadata, boolean withLock, boolean beQuiet)
 
void setToken (String token)
 
void setWithPresence (boolean withPresence)
 
void setWithMetadata (boolean withMetadata)
 
void setWithLock (boolean withLock)
 
void setBeQuiet (boolean beQuiet)
 
String getToken ()
 
boolean getWithMetadata ()
 
boolean getWithPresence ()
 
boolean getWithLock ()
 
boolean isBeQuiet ()
 
String toString ()
 

Detailed Description

Join channel options.

Constructor & Destructor Documentation

◆ JoinChannelOptions() [1/2]

io.agora.rtm.JoinChannelOptions.JoinChannelOptions ( )

Creates a new instance of

with default options.

◆ JoinChannelOptions() [2/2]

io.agora.rtm.JoinChannelOptions.JoinChannelOptions ( String  token,
boolean  withPresence,
boolean  withMetadata,
boolean  withLock,
boolean  beQuiet 
)

Creates a new instance of

with specifies options.

Parameters
tokenThe token used for authentication
withPresenceIndicates whether subscribe presence event notify
withMetadataIndicates whether subscribe storage event notify
withLockIndicates whether subscribe lock event notify
beQuietIndicates whether join channel in quiet mode
io.agora.rtm.JoinChannelOptions.JoinChannelOptions
JoinChannelOptions()
Definition: JoinChannelOptions.java:40