Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
(void) | - setLock:channelType:lockName:ttl:completion: |
(void) | - removeLock:channelType:lockName:completion: |
(void) | - acquireLock:channelType:lockName:retry:completion: |
(void) | - releaseLock:channelType:lockName:completion: |
(void) | - revokeLock:channelType:lockName:userId:completion: |
(void) | - getLocks:channelType:completion: |
- (instancetype _Nullable) NS_UNAVAILABLE |
- (void) setLock: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
lockName: | (NSString *_Nonnull) | lockName | |
ttl: | (int) | ttl | |
completion: | (AgoraRtmOperationBlock _Nullable) | completionBlock | |
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. |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |
- (void) removeLock: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
lockName: | (NSString *_Nonnull) | lockName | |
completion: | (AgoraRtmOperationBlock _Nullable) | completionBlock | |
removes a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |
- (void) acquireLock: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
lockName: | (NSString *_Nonnull) | lockName | |
retry: | (BOOL) | retry | |
completion: | (AgoraRtmOperationBlock _Nullable) | completionBlock | |
acquires a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
retry | Whether to automatic retry when acquires lock failed |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |
- (void) releaseLock: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
lockName: | (NSString *_Nonnull) | lockName | |
completion: | (AgoraRtmOperationBlock _Nullable) | completionBlock | |
releases a lock
channelName | The name of the channel. |
channelType | The type of the channel. |
lockName | The name of the lock. |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |
- (void) revokeLock: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
lockName: | (NSString *_Nonnull) | lockName | |
userId: | (NSString *_Nonnull) | userId | |
completion: | (AgoraRtmOperationBlock _Nullable) | completionBlock | |
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. |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |
- (void) getLocks: | (NSString *_Nonnull) | channelName | |
channelType: | (AgoraRtmChannelType) | channelType | |
completion: | (AgoraRtmGetLocksBlock _Nullable) | completionBlock | |
gets locks in the channel
channelName | The name of the channel. |
channelType | The type of the channel. |
completionBlock | The operation result will be notified by completionBlock, if operation success,will given a not nil response and nil errorInfo,if operation failed,will given a nil response and not nil errorInfo. |