AgoraRtmClientKit.h

Go to the documentation of this file.

//
//  AgoraRtmClientKit.h
//  AgoraRtcKit
//
//  Copyright (c) 2022 Agora. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "AgoraRtmObjects.h"
@protocol AgoraRtmClientDelegate <NSObject>
@optional
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceiveLinkStateEvent:(AgoraRtmLinkStateEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveLinkStateEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceiveMessageEvent:(AgoraRtmMessageEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveMessageEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceivePresenceEvent:(AgoraRtmPresenceEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceivePresenceEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceiveLockEvent:(AgoraRtmLockEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveLockEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceiveStorageEvent:(AgoraRtmStorageEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveStorageEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
    didReceiveTopicEvent:(AgoraRtmTopicEvent * _Nonnull)event NS_SWIFT_NAME(rtmKit(_:didReceiveTopicEvent:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)rtmKit
      tokenPrivilegeWillExpire:(NSString * _Nullable)channel NS_SWIFT_NAME(rtmKit(_:tokenPrivilegeWillExpire:));
 
- (void)rtmKit:(AgoraRtmClientKit * _Nonnull)kit
    channel:(NSString * _Nonnull)channelName
    connectionChangedToState:(AgoraRtmClientConnectionState)state
    reason:(AgoraRtmClientConnectionChangeReason)reason NS_SWIFT_NAME(rtmKit(_:channel:connectionChangedToState:reason:));
@end
 
NS_ASSUME_NONNULL_BEGIN
__attribute__((visibility("default"))) @interface AgoraRtmClientKit : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
 
- (instancetype _Nullable)initWithConfig:(AgoraRtmClientConfig * _Nonnull)config
                                 delegate:(id <AgoraRtmClientDelegate> _Nullable)delegate
                                    error:(NSError**)error NS_SWIFT_NAME(init(_:delegate:));
 
- (void) loginByToken:(NSString* _Nullable)token
           completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(login(_:completion:));
 
- (void) logout:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(logout(_:));
   
- (AgoraRtmStorage* _Nullable)getStorage NS_SWIFT_NAME(getStorage());
 
- (AgoraRtmLock* _Nullable)getLock NS_SWIFT_NAME(getLock());
 
- (AgoraRtmPresence* _Nullable)getPresence NS_SWIFT_NAME(getPresence());
 
- (AgoraRtmHistory* _Nullable) getHistory NS_SWIFT_NAME(getHistory());
 
- (void) renewToken:(NSString* _Nonnull)token
         completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
 
- (void) subscribeWithChannel:(NSString* _Nonnull)channelName
                       option:(AgoraRtmSubscribeOptions* _Nullable)subscribeOption
                   completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribe(channelName:option:completion:));
 
- (void) unsubscribeWithChannel:(NSString* _Nonnull)channelName
                     completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribe(_:completion:));
- (void) publish:(NSString* _Nonnull)channelName
         message:(NSString* _Nonnull)message
          option:(AgoraRtmPublishOptions* _Nullable)publishOption
      completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:message:option:completion:));
 
- (void) publish:(NSString* _Nonnull)channelName
            data:(NSData* _Nonnull)data
          option:(AgoraRtmPublishOptions* _Nullable)publishOption
      completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publish(channelName:data:option:completion:));
 
- (void) addDelegate:(id <AgoraRtmClientDelegate> _Nonnull)delegate NS_SWIFT_NAME(addDelegate(_:));
 
- (void) removeDelegate:(id <AgoraRtmClientDelegate> _Nonnull)delegate NS_SWIFT_NAME(removeDelegate(_:));  
- (AgoraRtmErrorCode)setParameters:(NSString* _Nonnull)parameter NS_SWIFT_NAME(setParameters(_:));
 
+ (NSString* _Nullable)getErrorReason:(AgoraRtmErrorCode)errorCode NS_SWIFT_NAME(getErrorReason(_:));
+ (NSString * _Nonnull)getVersion NS_SWIFT_NAME(getVersion());
        
 
- (AgoraRtmStreamChannel * _Nullable)createStreamChannel:(NSString * _Nonnull)channelName 
                                                   error:(NSError**)error NS_SWIFT_NAME(createStreamChannel(_:));
 
 
- (AgoraRtmErrorCode)destroy NS_SWIFT_NAME(destroy());
@end
 
NS_ASSUME_NONNULL_END
 
__attribute__((visibility("default"))) @interface AgoraRtmStreamChannel : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
- (void)joinWithOption:(AgoraRtmJoinChannelOption * _Nonnull)option
            completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(join(_:completion:));
 
- (void)leave:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leave(_:));
 
- (void)renewToken:(NSString* _Nonnull)token
        completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(renewToken(_:completion:));
 
- (void) joinTopic:(NSString * _Nonnull)topic 
            option:(AgoraRtmJoinTopicOption * _Nullable)option
        completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(joinTopic(_:option:completion:));
 
- (void) leaveTopic:(NSString * _Nonnull)topic
         completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(leaveTopic(_:completion:));
 
- (void) subscribeTopic:(NSString * _Nonnull)topic 
                 option:(AgoraRtmTopicOption * _Nullable)option
             completion:(AgoraRtmTopicSubscriptionBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeTopic(_:option:completion:));
 
             
- (void) unsubscribeTopic:(NSString * _Nonnull)topic 
                   option:(AgoraRtmTopicOption * _Nullable)option
               completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeTopic(_:option:completion:));
 
- (void) publishTopicMessage:(NSString * _Nonnull)topic
                     message:(NSString * _Nonnull)message
                      option:(AgoraRtmTopicMessageOptions * _Nullable)options
                  completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:message:option:completion:));
 
 
- (void) publishTopicMessage:(NSString * _Nonnull)topic
                        data:(NSData * _Nonnull)data
                      option:(AgoraRtmTopicMessageOptions * _Nullable)options
                  completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(publishTopicMessage(topic:data:option:completion:));
- (void) getSubscribedUserList:(NSString* _Nonnull)topic
                    completion:(AgoraRtmGetTopicSubscribedUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getSubscribedUserList(_:completion:));
 
- (NSString * _Nonnull)getChannelName NS_SWIFT_NAME(getChannelName());
 
- (AgoraRtmErrorCode)setParameters:(NSString* _Nonnull)parameters NS_SWIFT_NAME(setParameters(_:));
 
- (AgoraRtmErrorCode)destroy;
              
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmStorage : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
- (void) setChannelMetadata:(NSString * _Nonnull)channelName
                channelType:(AgoraRtmChannelType)channelType
                       data:(AgoraRtmMetadata* _Nonnull)data
                    options:(AgoraRtmMetadataOptions* _Nullable)options
                       lock:(NSString * _Nullable)lock
                 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setChannelMetadata(channelName:channelType:data:options:lock:completion:));
 
- (void) updateChannelMetadata:(NSString * _Nonnull)channelName
                   channelType:(AgoraRtmChannelType)channelType
                          data:(AgoraRtmMetadata* _Nonnull)data
                       options:(AgoraRtmMetadataOptions* _Nullable)options
                          lock:(NSString * _Nullable)lock
                    completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateChannelMetadata(channelName:channelType:data:options:lock:completion:));
 
- (void) removeChannelMetadata:(NSString * _Nonnull)channelName
                   channelType:(AgoraRtmChannelType)channelType
                          data:(AgoraRtmMetadata* _Nonnull)data
                       options:(AgoraRtmMetadataOptions* _Nullable)options
                          lock:(NSString * _Nullable)lock
                    completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeChannelMetadata(channelName:channelType:data:options:lock:completion:));
 
- (void) getChannelMetadata:(NSString * _Nonnull)channelName
                channelType:(AgoraRtmChannelType)channelType
                 completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getChannelMetadata(channelName:channelType:completion:));
 
- (void) setUserMetadata:(NSString * _Nonnull)userId
                    data:(AgoraRtmMetadata* _Nonnull)data
                 options:(AgoraRtmMetadataOptions* _Nullable)options
              completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setUserMetadata(userId:data:options:completion:));
 
- (void) updateUserMetadata:(NSString * _Nonnull)userId
                       data:(AgoraRtmMetadata* _Nonnull)data
                    options:(AgoraRtmMetadataOptions* _Nullable)options
                 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(updateUserMetadata(userId:data:options:completion:));
 
- (void) removeUserMetadata:(NSString * _Nonnull)userId
                       data:(AgoraRtmMetadata* _Nonnull)data
                    options:(AgoraRtmMetadataOptions* _Nullable)options
                 completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeUserMetadata(userId:data:options:completion:));
 
- (void) getUserMetadata:(NSString * _Nonnull)userId
              completion:(AgoraRtmGetMetadataBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserMetadata(userId:completion:));
 
- (void) subscribeUserMetadata:(NSString * _Nonnull)userId
                    completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(subscribeUserMetadata(userId:completion:));
 
- (void) unsubscribeUserMetadata:(NSString * _Nonnull)userId
                      completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(unsubscribeUserMetadata(userId:completion:));
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmLock : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
-(void) setLock:(NSString * _Nonnull)channelName
    channelType:(AgoraRtmChannelType)channelType
       lockName:(NSString * _Nonnull)lockName
            ttl:(int) ttl
     completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setLock(channelName:channelType:lockName:ttl:completion:));
 
-(void) removeLock:(NSString * _Nonnull)channelName
       channelType:(AgoraRtmChannelType)channelType
          lockName:(NSString * _Nonnull)lockName
        completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeLock(channelName:channelType:lockName:completion:));
 
-(void) acquireLock:(NSString * _Nonnull)channelName
        channelType:(AgoraRtmChannelType)channelType
           lockName:(NSString * _Nonnull)lockName
              retry:(BOOL)retry
         completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(acquireLock(channelName:channelType:lockName:retry:completion:));
 
 
-(void) releaseLock:(NSString * _Nonnull)channelName
        channelType:(AgoraRtmChannelType)channelType
           lockName:(NSString * _Nonnull)lockName
         completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(releaseLock(channelName:channelType:lockName:completion:));
 
-(void) revokeLock:(NSString * _Nonnull)channelName
       channelType:(AgoraRtmChannelType)channelType
          lockName:(NSString * _Nonnull)lockName
            userId:(NSString * _Nonnull)userId
        completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(revokeLock(channelName:channelType:lockName:userId:completion:));
 
 
-(void) getLocks:(NSString * _Nonnull)channelName
     channelType:(AgoraRtmChannelType)channelType
      completion:(AgoraRtmGetLocksBlock _Nullable)completionBlock NS_SWIFT_NAME(getLocks(channelName:channelType:completion:));
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmPresence : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
 
-(void) whoNow:(NSString * _Nonnull)channelName
   channelType:(AgoraRtmChannelType)channelType
       options:(AgoraRtmPresenceOptions* _Nullable)options
    completion:(AgoraRtmWhoNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whoNow(channelName:channelType:options:completion:));
 
-(void) getOnlineUsers:(NSString * _Nonnull)channelName
           channelType:(AgoraRtmChannelType)channelType
               options:(AgoraRtmGetOnlineUsersOptions* _Nullable)options
            completion:(AgoraRtmGetOnlineUsersBlock _Nullable)completionBlock NS_SWIFT_NAME(getOnlineUser(channelName:channelType:options:completion:));
 
-(void) whereNow:(NSString * _Nonnull)userId
      completion:(AgoraRtmWhereNowBlock _Nullable)completionBlock NS_SWIFT_NAME(whereNow(userId:completion:));
 
-(void) getUserChannels:(NSString * _Nonnull)userId
             completion:(AgoraRtmGetUserChannelsBlock _Nullable)completionBlock NS_SWIFT_NAME(getUserChannels(userId:completion:));
 
-(void) setState:(NSString * _Nonnull)channelName
     channelType:(AgoraRtmChannelType)channelType
           items:(NSDictionary<NSString *, NSString *> *_Nonnull)items
      completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(setState(channelName:channelType:items:completion:));
 
-(void) removeState:(NSString * _Nonnull)channelName
        channelType:(AgoraRtmChannelType)channelType
               keys:(NSArray<NSString *> * _Nonnull)keys
         completion:(AgoraRtmOperationBlock _Nullable)completionBlock NS_SWIFT_NAME(removeState(channelName:channelType:keys:completion:));
 
-(void) getState:(NSString * _Nonnull)channelName
     channelType:(AgoraRtmChannelType)channelType
          userId:(NSString * _Nonnull)userId
      completion:(AgoraRtmPresenceGetStateBlock _Nullable)completionBlock NS_SWIFT_NAME(getState(channelName:channelType:userId:completion:));
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmHistory : NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
 
-(void) getMessages:(NSString* _Nonnull)channelName
        channelType:(AgoraRtmChannelType)channelType
            options:(AgoraRtmGetHistoryMessagesOptions* _Nullable)options
         completion:(AgoraRtmGetHistoryMessagesBlock _Nullable)completionBlock NS_SWIFT_NAME(getMessages(channelName:channelType:options:completion:));
 
@end