Package io.agora.rtm

Class JoinChannelOptions

java.lang.Object

io.agora.rtm.JoinChannelOptions

public class JoinChannelOptions
extends Object

Join channel options.

Constructor Summary

Constructors

Constructor	Description
JoinChannelOptions()	Creates a new instance of JoinChannelOptions with default options.
JoinChannelOptions(String token, boolean withPresence, boolean withMetadata, boolean withLock, boolean beQuiet)	Creates a new instance of JoinChannelOptions with specifies options.

Method Summary

Modifier and Type	Method	Description
String	getToken()
boolean	getWithLock()
boolean	getWithMetadata()
boolean	getWithPresence()
boolean	isBeQuiet()
void	setBeQuiet(boolean beQuiet)
void	setToken(String token)
void	setWithLock(boolean withLock)
void	setWithMetadata(boolean withMetadata)
void	setWithPresence(boolean withPresence)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JoinChannelOptions

public JoinChannelOptions()

Creates a new instance of JoinChannelOptions with default options.

JoinChannelOptions

public JoinChannelOptions(String token,
 boolean withPresence,
 boolean withMetadata,
 boolean withLock,
 boolean beQuiet)

Creates a new instance of JoinChannelOptions with specifies options.

Parameters:

token - The token used for authentication

withPresence - Indicates whether subscribe presence event notify

withMetadata - Indicates whether subscribe storage event notify

withLock - Indicates whether subscribe lock event notify

beQuiet - Indicates whether join channel in quiet mode

Method Details

setToken

public void setToken(String token)

setWithPresence

public void setWithPresence(boolean withPresence)

setWithMetadata

public void setWithMetadata(boolean withMetadata)

setWithLock

public void setWithLock(boolean withLock)

setBeQuiet

public void setBeQuiet(boolean beQuiet)

getToken

public String getToken()

getWithMetadata

public boolean getWithMetadata()

getWithPresence

public boolean getWithPresence()

getWithLock

public boolean getWithLock()

isBeQuiet

public boolean isBeQuiet()

toString

public String toString()

Overrides:

toString in class Object