Agora Java API Reference for Android
|
Public Member Functions | |
abstract void | setLock (String channelName, RtmChannelType channelType, String lockName, long ttl, ResultCallback< Void > resultCallback) |
abstract void | getLocks (String channelName, RtmChannelType channelType, ResultCallback< ArrayList< LockDetail >> resultCallback) |
abstract void | removeLock (String channelName, RtmChannelType channelType, String lockName, ResultCallback< Void > resultCallback) |
abstract void | acquireLock (String channelName, RtmChannelType channelType, String lockName, boolean retry, ResultCallback< Void > resultCallback) |
abstract void | releaseLock (String channelName, RtmChannelType channelType, String lockName, ResultCallback< Void > resultCallback) |
abstract void | revokeLock (String channelName, RtmChannelType channelType, String lockName, String owner, ResultCallback< Void > resultCallback) |
The RtmLock class.
This class provides the rtm lock methods that can be invoked by your app.
|
abstract |
sets a lock.
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
ttl | The lock ttl. |
resultCallback | A ResultCallback object.
|
|
abstract |
gets locks in the channel.
channelName | The name of the channel. |
channelType | The type of the channel. |
resultCallback | A ResultCallback object.
|
|
abstract |
removes a lock.
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
resultCallback | A ResultCallback object.
|
|
abstract |
acquires a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
retry | Whether to automatically retry when acquires lock failed |
resultCallback | A ResultCallback object.
|
|
abstract |
releases a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
resultCallback | A ResultCallback object.
|
|
abstract |
disables a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
owner | The lock owner. |
resultCallback | A ResultCallback object.
|