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(_:));
175 - (void) renewToken:(NSString* _Nonnull)token
176 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
186 - (void) subscribeWithChannel:(NSString* _Nonnull)channelName
188 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribe(channelName:option:completion:));
197 - (void) unsubscribeWithChannel:(NSString* _Nonnull)channelName
198 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribe(_:completion:));
208 - (void) publish:(NSString* _Nonnull)channelName
209 message:(NSString* _Nonnull)message
211 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:message:option:completion:));
222 - (void) publish:(NSString* _Nonnull)channelName
223 data:(NSData* _Nonnull)data
225 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:data:option:completion:));
250 - (
AgoraRtmErrorCode)setParameters:(NSString* _Nonnull)parameter NS_SWIFT_NAME(setParameters(_:));
258 + (NSString* _Nullable)getErrorReason:(
AgoraRtmErrorCode)errorCode NS_SWIFT_NAME(getErrorReason(_:));
277 error:(NSError**)error NS_SWIFT_NAME(createStreamChannel(_:));
290 NS_ASSUME_NONNULL_END
303 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(join(_:completion:));
311 - (void)leave:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leave(_:));
321 - (void)renewToken:(NSString* _Nonnull)token
322 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
332 - (void) joinTopic:(NSString * _Nonnull)topic
334 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(joinTopic(_:option:completion:));
343 - (void) leaveTopic:(NSString * _Nonnull)topic
344 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leaveTopic(_:completion:));
354 - (void) subscribeTopic:(NSString * _Nonnull)topic
356 completion:(AgoraRtmTopicSubscriptionBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeTopic(_:option:completion:));
367 - (void) unsubscribeTopic:(NSString * _Nonnull)topic
369 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeTopic(_:option:completion:));
380 - (void) publishTopicMessage:(NSString * _Nonnull)topic
381 message:(NSString * _Nonnull)message
383 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:message:option:completion:));
395 - (void) publishTopicMessage:(NSString * _Nonnull)topic
396 data:(NSData * _Nonnull)data
398 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:data:option:completion:));
406 - (void) getSubscribedUserList:(NSString* _Nonnull)topic
407 completion:(AgoraRtmGetTopicSubscribedUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getSubscribedUserList(_:completion:));
441 - (void) setChannelMetadata:(NSString * _Nonnull)channelName
445 lock:(NSString * _Nullable)lock
446 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setChannelMetadata(channelName:channelType:data:options:lock:completion:));
459 - (void) updateChannelMetadata:(NSString * _Nonnull)channelName
463 lock:(NSString * _Nullable)lock
464 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateChannelMetadata(channelName:channelType:data:options:lock:completion:));
477 - (void) removeChannelMetadata:(NSString * _Nonnull)channelName
481 lock:(NSString * _Nullable)lock
482 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeChannelMetadata(channelName:channelType:data:options:lock:completion:));
492 - (void) getChannelMetadata:(NSString * _Nonnull)channelName
494 completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getChannelMetadata(channelName:channelType:completion:));
506 - (void) setUserMetadata:(NSString * _Nonnull)userId
509 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setUserMetadata(userId:data:options:completion:));
520 - (void) updateUserMetadata:(NSString * _Nonnull)userId
523 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateUserMetadata(userId:data:options:completion:));
534 - (void) removeUserMetadata:(NSString * _Nonnull)userId
537 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeUserMetadata(userId:data:options:completion:));
546 - (void) getUserMetadata:(NSString * _Nonnull)userId
547 completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserMetadata(userId:completion:));
556 - (void) subscribeUserMetadata:(NSString * _Nonnull)userId
557 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeUserMetadata(userId:completion:));
566 - (void) unsubscribeUserMetadata:(NSString * _Nonnull)userId
567 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeUserMetadata(userId:completion:));
570 __attribute__((visibility(
"default")))
@interface AgoraRtmLock : NSObject
583 -(void) setLock:(NSString * _Nonnull)channelName
585 lockName:(NSString * _Nonnull)lockName
587 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setLock(channelName:channelType:lockName:ttl:completion:));
598 -(void) removeLock:(NSString * _Nonnull)channelName
600 lockName:(NSString * _Nonnull)lockName
601 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeLock(channelName:channelType:lockName:completion:));
613 -(void) acquireLock:(NSString * _Nonnull)channelName
615 lockName:(NSString * _Nonnull)lockName
617 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(acquireLock(channelName:channelType:lockName:retry:completion:));
629 -(void) releaseLock:(NSString * _Nonnull)channelName
631 lockName:(NSString * _Nonnull)lockName
632 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(releaseLock(channelName:channelType:lockName:completion:));
644 -(void) revokeLock:(NSString * _Nonnull)channelName
646 lockName:(NSString * _Nonnull)lockName
647 userId:(NSString * _Nonnull)userId
648 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(revokeLock(channelName:channelType:lockName:userId:completion:));
659 -(void) getLocks:(NSString * _Nonnull)channelName
661 completion:(AgoraRtmGetLocksBlock _Nullable)completionBlock NS_SWIFT_NAME(getLocks(channelName:channelType:completion:));
683 -(void) whoNow:(NSString * _Nonnull)channelName
686 completion:(AgoraRtmWhoNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whoNow(channelName:channelType:options:completion:));
697 -(void) getOnlineUsers:(NSString * _Nonnull)channelName
700 completion:(AgoraRtmGetOnlineUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getOnlineUser(channelName:channelType:options:completion:));
709 -(void) whereNow:(NSString * _Nonnull)userId
710 completion:(AgoraRtmWhereNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whereNow(userId:completion:));
719 -(void) getUserChannels:(NSString * _Nonnull)userId
720 completion:(AgoraRtmGetUserChannelsBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserChannels(userId:completion:));
731 -(void) setState:(NSString * _Nonnull)channelName
733 items:(NSDictionary<NSString *, NSString *> *_Nonnull)items
734 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setState(channelName:channelType:items:completion:));
745 -(void) removeState:(NSString * _Nonnull)channelName
747 keys:(NSArray<NSString *> * _Nonnull)keys
748 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeState(channelName:channelType:keys:completion:));
759 -(void) getState:(NSString * _Nonnull)channelName
761 userId:(NSString * _Nonnull)userId
762 completion:(AgoraRtmPresenceGetStateBlock _Nullable)completionBlock NS_SWIFT_NAME(getState(channelName:channelType:userId:completion:));
783 -(void) getMessages:(NSString* _Nonnull)channelName
786 completion:(AgoraRtmGetHistoryMessagesBlock _Nullable)completionBlock NS_SWIFT_NAME(getMessages(channelName:channelType:options:completion:));