Package io.agora.rtm

Class StreamChannel

java.lang.Object

io.agora.rtm.StreamChannel

public abstract class StreamChannel
extends Object

The StreamChannel class. This class provides the stream channel methods that can be invoked by your app.

Constructor Summary

Constructors

Constructor	Description
StreamChannel()

Method Summary

Modifier and Type	Method	Description
abstract String	getChannelName()	Return the channel name of this stream channel.
abstract void	getSubscribedUserList(String topicName, ResultCallback<ArrayList<String>> resultCallback)	Get subscribed user list
abstract void	join(JoinChannelOptions options, ResultCallback<Void> resultCallback)	Join the channel.
abstract void	joinTopic(String topicName, JoinTopicOptions options, ResultCallback<Void> resultCallback)	Join a topic.
abstract void	leave(ResultCallback<Void> resultCallback)	Leave the channel.
abstract void	leaveTopic(String topicName, ResultCallback<Void> resultCallback)	Leave the topic.
abstract void	publishTopicMessage(String topicName, byte[] message, TopicMessageOptions options, ResultCallback<Void> resultCallback)	Publish a binary message in the topic.
abstract void	publishTopicMessage(String topicName, String message, TopicMessageOptions options, ResultCallback<Void> resultCallback)	Publish a string message in the topic.
abstract RtmConstants.RtmErrorCode	release()	Release the stream channel instance.
abstract void	renewToken(String token, ResultCallback<Void> resultCallback)	Renews the token.
abstract RtmConstants.RtmErrorCode	setParameters(String parameters)	Set parameters of the stream channel
abstract void	subscribeTopic(String topicName, TopicOptions options, ResultCallback<SubscribeTopicResult> resultCallback)	Subscribe a topic.
abstract void	unsubscribeTopic(String topicName, TopicOptions options, ResultCallback<Void> resultCallback)	Unsubscribe a topic.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamChannel

public StreamChannel()

Method Details

release

public abstract RtmConstants.RtmErrorCode release()

Release the stream channel instance.

Returns:

RtmErrorCode

join

public abstract void join(JoinChannelOptions options,
 ResultCallback<Void> resultCallback)

Join the channel.

Parameters:

options - join channel options.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

renewToken

public abstract void renewToken(String token,
 ResultCallback<Void> resultCallback)

Renews the token. Once a token is enabled and used, it expires after a certain period of time. You should generate a new token on your server, call this method to renew it.

Parameters:

token - Token used renew.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

leave

public abstract void leave(ResultCallback<Void> resultCallback)

Leave the channel.

Parameters:

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getChannelName

public abstract String getChannelName()

Return the channel name of this stream channel.

Returns:

The channel name.

joinTopic

public abstract void joinTopic(String topicName,
 JoinTopicOptions options,
 ResultCallback<Void> resultCallback)

Join a topic.

Parameters:

topicName - The name of the topic.

options - The options of the topic.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

publishTopicMessage

public abstract void publishTopicMessage(String topicName,
 byte[] message,
 TopicMessageOptions options,
 ResultCallback<Void> resultCallback)

Publish a binary message in the topic.

Parameters:

topicName - The name of the topic.

message - The content of the message.

options - The options of the message.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

publishTopicMessage

public abstract void publishTopicMessage(String topicName,
 String message,
 TopicMessageOptions options,
 ResultCallback<Void> resultCallback)

Publish a string message in the topic.

Parameters:

topicName - The name of the topic.

message - The content of the message.

options - The options of the message.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

leaveTopic

public abstract void leaveTopic(String topicName,
 ResultCallback<Void> resultCallback)

Leave the topic.

Parameters:

topicName - The name of the topic.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

subscribeTopic

public abstract void subscribeTopic(String topicName,
 TopicOptions options,
 ResultCallback<SubscribeTopicResult> resultCallback)

Subscribe a topic.

Parameters:

topicName - The name of the topic.

options - The options of subscribe the topic.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

unsubscribeTopic

public abstract void unsubscribeTopic(String topicName,
 TopicOptions options,
 ResultCallback<Void> resultCallback)

Unsubscribe a topic.

Parameters:

topicName - The name of the topic.

options - The options of unsubscribe the topic.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getSubscribedUserList

public abstract void getSubscribedUserList(String topicName,
 ResultCallback<ArrayList<String>> resultCallback)

Get subscribed user list

Parameters:

topicName - The name of the topic.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

setParameters

public abstract RtmConstants.RtmErrorCode setParameters(String parameters)

Set parameters of the stream channel

Parameters:

parameters - The parameters in json format

Returns:

RtmErrorCode