Package io.agora.rtm

Class RtmStorage

java.lang.Object

io.agora.rtm.RtmStorage

public abstract class RtmStorage
extends Object

The RtmStorage class. This class provides the rtm storage methods that can be invoked by your app.

Constructor Summary

Constructors

Constructor	Description
RtmStorage()

Method Summary

Modifier and Type	Method	Description
abstract void	getChannelMetadata(String channelName, RtmConstants.RtmChannelType channelType, ResultCallback<Metadata> resultCallback)	Get the metadata of a specified channel.
abstract void	getUserMetadata(String userId, ResultCallback<Metadata> resultCallback)	Get the metadata of a specified user.
abstract void	removeChannelMetadata(String channelName, RtmConstants.RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)	Remove the metadata of a specified channel.
abstract void	removeUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)	Remove the metadata of a specified user.
abstract void	setChannelMetadata(String channelName, RtmConstants.RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)	Set the metadata of a specified channel.
abstract void	setUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)	Set the metadata of a specified user.
abstract void	subscribeUserMetadata(String userId, ResultCallback<Void> resultCallback)	Subscribe the metadata update event of a specified user.
abstract void	unsubscribeUserMetadata(String userId, ResultCallback<Void> resultCallback)	unsubscribe the metadata update event of a specified user.
abstract void	updateChannelMetadata(String channelName, RtmConstants.RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback<Void> resultCallback)	Update the metadata of a specified channel.
abstract void	updateUserMetadata(String userId, Metadata data, MetadataOptions options, ResultCallback<Void> resultCallback)	Update the metadata of a specified user.

Methods inherited from class java.lang.Object

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

Constructor Details

RtmStorage

public RtmStorage()

Method Details

setChannelMetadata

public abstract void setChannelMetadata(String channelName,
 RtmConstants.RtmChannelType channelType,
 Metadata data,
 MetadataOptions options,
 String lockName,
 ResultCallback<Void> resultCallback)

Set the metadata of a specified channel.

Parameters:

channelName - The name of the channel

channelType - The type of the channel RtmConstants.RtmChannelType

data - Metadata data

options - The options of operate metadata

lockName - lock for operate channel metadata

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

updateChannelMetadata

public abstract void updateChannelMetadata(String channelName,
 RtmConstants.RtmChannelType channelType,
 Metadata data,
 MetadataOptions options,
 String lockName,
 ResultCallback<Void> resultCallback)

Update the metadata of a specified channel.

Parameters:

channelName - The name of the channel

channelType - The type of the channel RtmConstants.RtmChannelType

data - Metadata data

options - The options of operate metadata

lockName - lock for operate channel metadata

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

removeChannelMetadata

public abstract void removeChannelMetadata(String channelName,
 RtmConstants.RtmChannelType channelType,
 Metadata data,
 MetadataOptions options,
 String lockName,
 ResultCallback<Void> resultCallback)

Remove the metadata of a specified channel.

Parameters:

channelName - The name of the channel

channelType - The type of the channel RtmConstants.RtmChannelType

data - Metadata data

options - The options of operate metadata

lockName - lock for operate channel metadata

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

getChannelMetadata

public abstract void getChannelMetadata(String channelName,
 RtmConstants.RtmChannelType channelType,
 ResultCallback<Metadata> resultCallback)

Get the metadata of a specified channel.

Parameters:

channelName - The name of the channel

channelType - The type of the channel RtmConstants.RtmChannelType

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

setUserMetadata

public abstract void setUserMetadata(String userId,
 Metadata data,
 MetadataOptions options,
 ResultCallback<Void> resultCallback)

Set the metadata of a specified user.

Parameters:

userId - The user ID of the specified user

data - Metadata data

options - The options of operate metadata

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

updateUserMetadata

public abstract void updateUserMetadata(String userId,
 Metadata data,
 MetadataOptions options,
 ResultCallback<Void> resultCallback)

Update the metadata of a specified user.

Parameters:

userId - The user ID of the specified user

data - Metadata data

options - The options of operate metadata

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

removeUserMetadata

public abstract void removeUserMetadata(String userId,
 Metadata data,
 MetadataOptions options,
 ResultCallback<Void> resultCallback)

Remove the metadata of a specified user.

Parameters:

userId - The user ID of the specified user

data - Metadata data

options - The options of operate metadata

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

getUserMetadata

public abstract void getUserMetadata(String userId,
 ResultCallback<Metadata> resultCallback)

Get the metadata of a specified user.

Parameters:

userId - The user ID of the specified user.

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

subscribeUserMetadata

public abstract void subscribeUserMetadata(String userId,
 ResultCallback<Void> resultCallback)

Subscribe the metadata update event of a specified user.

Parameters:

userId - The user ID of the specified user.

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

unsubscribeUserMetadata

public abstract void unsubscribeUserMetadata(String userId,
 ResultCallback<Void> resultCallback)

unsubscribe the metadata update event of a specified user.

Parameters:

userId - The user ID of the specified user.

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