7 #import <Foundation/Foundation.h>
18 didReceiveLinkStateEvent:(
AgoraRtmLinkStateEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveLinkStateEvent:));
26 didReceiveMessageEvent:(
AgoraRtmMessageEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveMessageEvent:));
35 didReceivePresenceEvent:(
AgoraRtmPresenceEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceivePresenceEvent:));
43 didReceiveLockEvent:(
AgoraRtmLockEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveLockEvent:));
52 didReceiveStorageEvent:(
AgoraRtmStorageEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveStorageEvent:));
62 didReceiveTopicEvent:(
AgoraRtmTopicEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveTopicEvent:));
71 tokenPrivilegeWillExpire:(NSString * _Nullable)channel NS_SWIFT_NAME(rtmKit(_:tokenPrivilegeWillExpire:));
82 channel:(NSString * _Nonnull)channelName
87 NS_ASSUME_NONNULL_BEGIN
115 error:(NSError**)error NS_SWIFT_NAME(init(_:delegate:));
124 - (void) loginByToken:(NSString* _Nullable)token
125 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(login(_:completion:));
133 - (void) logout:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(logout(_:));
167 - (void) renewToken:(NSString* _Nonnull)token
168 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
178 - (void) subscribeWithChannel:(NSString* _Nonnull)channelName
180 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribe(channelName:option:completion:));
189 - (void) unsubscribeWithChannel:(NSString* _Nonnull)channelName
190 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribe(_:completion:));
200 - (void) publish:(NSString* _Nonnull)channelName
201 message:(NSString* _Nonnull)message
203 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:message:option:completion:));
214 - (void) publish:(NSString* _Nonnull)channelName
215 data:(NSData* _Nonnull)data
217 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:data:option:completion:));
242 - (
AgoraRtmErrorCode)setParameters:(NSString* _Nonnull)parameter NS_SWIFT_NAME(setParameters(_:));
250 + (NSString* _Nullable)getErrorReason:(
AgoraRtmErrorCode)errorCode NS_SWIFT_NAME(getErrorReason(_:));
269 error:(NSError**)error NS_SWIFT_NAME(createStreamChannel(_:));
282 NS_ASSUME_NONNULL_END
295 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(join(_:completion:));
303 - (void)leave:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leave(_:));
313 - (void)renewToken:(NSString* _Nonnull)token
314 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
324 - (void) joinTopic:(NSString * _Nonnull)topic
326 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(joinTopic(_:option:completion:));
335 - (void) leaveTopic:(NSString * _Nonnull)topic
336 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leaveTopic(_:completion:));
346 - (void) subscribeTopic:(NSString * _Nonnull)topic
348 completion:(AgoraRtmTopicSubscriptionBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeTopic(_:option:completion:));
359 - (void) unsubscribeTopic:(NSString * _Nonnull)topic
361 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeTopic(_:option:completion:));
372 - (void) publishTopicMessage:(NSString * _Nonnull)topic
373 message:(NSString * _Nonnull)message
375 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:message:option:completion:));
387 - (void) publishTopicMessage:(NSString * _Nonnull)topic
388 data:(NSData * _Nonnull)data
390 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:data:option:completion:));
398 - (void) getSubscribedUserList:(NSString* _Nonnull)topic
399 completion:(AgoraRtmGetTopicSubscribedUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getSubscribedUserList(_:completion:));
433 - (void) setChannelMetadata:(NSString * _Nonnull)channelName
437 lock:(NSString * _Nullable)lock
438 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setChannelMetadata(channelName:channelType:data:options:lock:completion:));
451 - (void) updateChannelMetadata:(NSString * _Nonnull)channelName
455 lock:(NSString * _Nullable)lock
456 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateChannelMetadata(channelName:channelType:data:options:lock:completion:));
469 - (void) removeChannelMetadata:(NSString * _Nonnull)channelName
473 lock:(NSString * _Nullable)lock
474 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeChannelMetadata(channelName:channelType:data:options:lock:completion:));
484 - (void) getChannelMetadata:(NSString * _Nonnull)channelName
486 completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getChannelMetadata(channelName:channelType:completion:));
498 - (void) setUserMetadata:(NSString * _Nonnull)userId
501 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setUserMetadata(userId:data:options:completion:));
512 - (void) updateUserMetadata:(NSString * _Nonnull)userId
515 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateUserMetadata(userId:data:options:completion:));
526 - (void) removeUserMetadata:(NSString * _Nonnull)userId
529 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeUserMetadata(userId:data:options:completion:));
538 - (void) getUserMetadata:(NSString * _Nonnull)userId
539 completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserMetadata(userId:completion:));
548 - (void) subscribeUserMetadata:(NSString * _Nonnull)userId
549 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeUserMetadata(userId:completion:));
558 - (void) unsubscribeUserMetadata:(NSString * _Nonnull)userId
559 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeUserMetadata(userId:completion:));
562 __attribute__((visibility(
"default")))
@interface AgoraRtmLock : NSObject
575 -(void) setLock:(NSString * _Nonnull)channelName
577 lockName:(NSString * _Nonnull)lockName
579 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setLock(channelName:channelType:lockName:ttl:completion:));
590 -(void) removeLock:(NSString * _Nonnull)channelName
592 lockName:(NSString * _Nonnull)lockName
593 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeLock(channelName:channelType:lockName:completion:));
605 -(void) acquireLock:(NSString * _Nonnull)channelName
607 lockName:(NSString * _Nonnull)lockName
609 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(acquireLock(channelName:channelType:lockName:retry:completion:));
621 -(void) releaseLock:(NSString * _Nonnull)channelName
623 lockName:(NSString * _Nonnull)lockName
624 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(releaseLock(channelName:channelType:lockName:completion:));
636 -(void) revokeLock:(NSString * _Nonnull)channelName
638 lockName:(NSString * _Nonnull)lockName
639 userId:(NSString * _Nonnull)userId
640 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(revokeLock(channelName:channelType:lockName:userId:completion:));
651 -(void) getLocks:(NSString * _Nonnull)channelName
653 completion:(AgoraRtmGetLocksBlock _Nullable)completionBlock NS_SWIFT_NAME(getLocks(channelName:channelType:completion:));
675 -(void) whoNow:(NSString * _Nonnull)channelName
678 completion:(AgoraRtmWhoNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whoNow(channelName:channelType:options:completion:));
689 -(void) getOnlineUsers:(NSString * _Nonnull)channelName
692 completion:(AgoraRtmGetOnlineUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getOnlineUser(channelName:channelType:options:completion:));
701 -(void) whereNow:(NSString * _Nonnull)userId
702 completion:(AgoraRtmWhereNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whereNow(userId:completion:));
711 -(void) getUserChannels:(NSString * _Nonnull)userId
712 completion:(AgoraRtmGetUserChannelsBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserChannels(userId:completion:));
723 -(void) setState:(NSString * _Nonnull)channelName
725 items:(NSDictionary<NSString *, NSString *> *_Nonnull)items
726 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setState(channelName:channelType:items:completion:));
737 -(void) removeState:(NSString * _Nonnull)channelName
739 keys:(NSArray<NSString *> * _Nonnull)keys
740 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeState(channelName:channelType:keys:completion:));
751 -(void) getState:(NSString * _Nonnull)channelName
753 userId:(NSString * _Nonnull)userId
754 completion:(AgoraRtmPresenceGetStateBlock _Nullable)completionBlock NS_SWIFT_NAME(getState(channelName:channelType:userId:completion:));