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

Public Member Functions

abstract void setChannelMetadata (String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback< Void > resultCallback)
 
abstract void updateChannelMetadata (String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback< Void > resultCallback)
 
abstract void removeChannelMetadata (String channelName, RtmChannelType channelType, Metadata data, MetadataOptions options, String lockName, ResultCallback< Void > resultCallback)
 
abstract void getChannelMetadata (String channelName, RtmChannelType channelType, ResultCallback< Metadata > resultCallback)
 
abstract void setUserMetadata (String userId, Metadata data, MetadataOptions options, ResultCallback< Void > resultCallback)
 
abstract void updateUserMetadata (String userId, Metadata data, MetadataOptions options, ResultCallback< Void > resultCallback)
 
abstract void removeUserMetadata (String userId, Metadata data, MetadataOptions options, ResultCallback< Void > resultCallback)
 
abstract void getUserMetadata (String userId, ResultCallback< Metadata > resultCallback)
 
abstract void subscribeUserMetadata (String userId, ResultCallback< Void > resultCallback)
 
abstract void unsubscribeUserMetadata (String userId, ResultCallback< Void > resultCallback)
 

Detailed Description

The RtmStorage class.

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

Member Function Documentation

◆ setChannelMetadata()

abstract void io.agora.rtm.RtmStorage.setChannelMetadata ( String  channelName,
RtmChannelType  channelType,
Metadata  data,
MetadataOptions  options,
String  lockName,
ResultCallback< Void >  resultCallback 
)
abstract

Set the metadata of a specified channel.

Parameters
channelNameThe name of the channel
channelTypeThe type of the channel RtmChannelType
dataMetadata data
optionsThe options of operate metadata
lockNamelock for operate channel metadata
resultCallbackA ResultCallback object.

◆ updateChannelMetadata()

abstract void io.agora.rtm.RtmStorage.updateChannelMetadata ( String  channelName,
RtmChannelType  channelType,
Metadata  data,
MetadataOptions  options,
String  lockName,
ResultCallback< Void >  resultCallback 
)
abstract

Update the metadata of a specified channel.

Parameters
channelNameThe name of the channel
channelTypeThe type of the channel RtmChannelType
dataMetadata data
optionsThe options of operate metadata
lockNamelock for operate channel metadata
resultCallbackA ResultCallback object.

◆ removeChannelMetadata()

abstract void io.agora.rtm.RtmStorage.removeChannelMetadata ( String  channelName,
RtmChannelType  channelType,
Metadata  data,
MetadataOptions  options,
String  lockName,
ResultCallback< Void >  resultCallback 
)
abstract

Remove the metadata of a specified channel.

Parameters
channelNameThe name of the channel
channelTypeThe type of the channel RtmChannelType
dataMetadata data
optionsThe options of operate metadata
lockNamelock for operate channel metadata
resultCallbackA ResultCallback object.

◆ getChannelMetadata()

abstract void io.agora.rtm.RtmStorage.getChannelMetadata ( String  channelName,
RtmChannelType  channelType,
ResultCallback< Metadata resultCallback 
)
abstract

Get the metadata of a specified channel.

Parameters
channelNameThe name of the channel
channelTypeThe type of the channel RtmChannelType
resultCallbackA ResultCallback object

◆ setUserMetadata()

abstract void io.agora.rtm.RtmStorage.setUserMetadata ( String  userId,
Metadata  data,
MetadataOptions  options,
ResultCallback< Void >  resultCallback 
)
abstract

Set the metadata of a specified user.

Parameters
userIdThe user ID of the specified user
dataMetadata data
optionsThe options of operate metadata
resultCallbackA ResultCallback object.

◆ updateUserMetadata()

abstract void io.agora.rtm.RtmStorage.updateUserMetadata ( String  userId,
Metadata  data,
MetadataOptions  options,
ResultCallback< Void >  resultCallback 
)
abstract

Update the metadata of a specified user.

Parameters
userIdThe user ID of the specified user
dataMetadata data
optionsThe options of operate metadata
resultCallbackA ResultCallback object.

◆ removeUserMetadata()

abstract void io.agora.rtm.RtmStorage.removeUserMetadata ( String  userId,
Metadata  data,
MetadataOptions  options,
ResultCallback< Void >  resultCallback 
)
abstract

Remove the metadata of a specified user.

Parameters
userIdThe user ID of the specified user
dataMetadata data
optionsThe options of operate metadata
resultCallbackA ResultCallback object.

◆ getUserMetadata()

abstract void io.agora.rtm.RtmStorage.getUserMetadata ( String  userId,
ResultCallback< Metadata resultCallback 
)
abstract

Get the metadata of a specified user.

Parameters
userIdThe user ID of the specified user.
resultCallbackA ResultCallback object.

◆ subscribeUserMetadata()

abstract void io.agora.rtm.RtmStorage.subscribeUserMetadata ( String  userId,
ResultCallback< Void >  resultCallback 
)
abstract

Subscribe the metadata update event of a specified user.

Parameters
userIdThe user ID of the specified user.
resultCallbackA ResultCallback object.

◆ unsubscribeUserMetadata()

abstract void io.agora.rtm.RtmStorage.unsubscribeUserMetadata ( String  userId,
ResultCallback< Void >  resultCallback 
)
abstract

unsubscribe the metadata update event of a specified user.

Parameters
userIdThe user ID of the specified user.
resultCallbackA ResultCallback object.