AgoraRtmObjects.h

Go to the documentation of this file.

#import <Foundation/Foundation.h>
#import "AgoraRtmEnumerates.h"
 
@class AgoraRtmPublisherInfo;
@class AgoraRtmClientKit;
@class AgoraRtmMessageEvent;
@class AgoraRtmTopicOption;
@class AgoraRtmJoinTopicOption;
@class AgoraRtmJoinChannelOption;
@class AgoraRtmClientConfig;
@class AgoraRtmStreamChannel;
@class AgoraRtmTopicInfo;
@class AgoraRtmSubscribeOptions;
@class AgoraRtmPublishOptions;
@class AgoraRtmTopicMessageOptions;
@class AgoraRtmLock;
@class AgoraRtmStorage;
@class AgoraRtmPresence;
@class AgoraRtmMetadataOptions;
@class AgoraRtmMetadataItem;
@class AgoraRtmMetadata;
@class AgoraRtmLockDetail;
@class AgoraRtmPresenceOptions;
@class AgoraRtmGetOnlineUsersOptions;
@class AgoraRtmUserState;
@class AgoraRtmChannelInfo;
@class AgoraRtmTopicEvent;
@class AgoraRtmLockEvent;
@class AgoraRtmStorageEvent;
@class AgoraRtmPresenceEvent;
@class AgoraRtmLogConfig;
@class AgoraRtmProxyConfig;
@class AgoraRtmEncryptionConfig;
@class AgoraRtmPresenceIntervalInfo;
@class AgoraRtmErrorInfo;
@class AgoraRtmTopicSubscriptionResponse;
@class AgoraRtmLoginErrorInfo;
@class AgoraRtmGetMetadataResponse;
@class AgoraRtmGetLocksResponse;
@class AgoraRtmWhoNowResponse;
@class AgoraRtmGetOnlineUsersResponse;
@class AgoraRtmWhereNowResponse;
@class AgoraRtmGetUserChannelsResponse;
@class AgoraRtmPresenceGetStateResponse;
@class AgoraRtmGetTopicSubscribedUsersResponse;
@class AgoraRtmMessage;
@class AgoraRtmPrivateConfig;
@class AgoraRtmLinkStateEvent;
@class AgoraRtmHistory;
@class AgoraRtmGetHistoryMessagesOptions;
@class AgoraRtmHistoryMessage;
@class AgoraRtmGetHistoryMessagesResponse;
 
__attribute__((visibility("default"))) @interface AgoraRtmPublishOptions: NSObject
@property (nonatomic, assign) AgoraRtmChannelType channelType;
 
@property (nonatomic, copy, nonnull) NSString* customType;
 
@property (nonatomic, assign) BOOL storeInHistory;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmTopicMessageOptions: NSObject
@property (nonatomic, copy, nonnull) NSString* customType;
 
@property (nonatomic, assign) unsigned long long sendTs;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmMetadataOptions: NSObject
 
@property (nonatomic, assign) BOOL recordTs;
 
@property (nonatomic, assign) BOOL recordUserId;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmMetadataItem: NSObject
 
@property (nonatomic, copy, nonnull) NSString* key;
 
@property (nonatomic, copy, nonnull) NSString* value;
 
@property (nonatomic, copy, nonnull) NSString* authorUserId;
 
@property (nonatomic, assign) long long revision;
 
@property (nonatomic, assign) unsigned long long updateTs;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmMetadata: NSObject
 
- (instancetype _Nullable)init;
@property (nonatomic, assign) long long majorRevision;
 
@property (nonatomic, copy, nullable) NSArray<AgoraRtmMetadataItem *> *items;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmLockDetail: NSObject
@property (nonatomic, copy, nonnull) NSString* lockName;
 
@property (nonatomic, copy, nonnull) NSString* owner;
 
@property (nonatomic, assign) int ttl;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersOptions: NSObject
@property (nonatomic, assign) BOOL includeUserId;
 
@property (nonatomic, assign) BOOL includeState;
 
@property (nonatomic, copy, nonnull) NSString* page;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmPresenceOptions: NSObject
@property (nonatomic, assign) BOOL includeUserId;
 
@property (nonatomic, assign) BOOL includeState;
 
@property (nonatomic, copy, nonnull) NSString* page;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmUserState: NSObject
 
@property (nonatomic, copy, nonnull) NSString* userId;
 
@property (nonatomic, copy, nonnull)  NSDictionary<NSString *, NSString *> * states;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmChannelInfo: NSObject
 
@property (nonatomic, copy, nonnull) NSString* channelName;
 
@property (nonatomic, assign) AgoraRtmChannelType channelType;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmTopicEvent: NSObject
 
@property (nonatomic, assign) AgoraRtmTopicEventType type;
 
@property (nonatomic, copy, nonnull) NSString* channelName;
 
@property (nonatomic, copy, nonnull) NSString* publisher;
 
@property (nonatomic, copy, nonnull) NSArray<AgoraRtmTopicInfo *> *topicInfos;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmPublisherInfo: NSObject
@property (nonatomic, copy, nonnull) NSString* publisherUserId;
 
@property (nonatomic, copy, nullable) NSString* publisherMeta;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmLockEvent: NSObject
@property (nonatomic, assign) AgoraRtmChannelType channelType;
 
@property (nonatomic, assign) AgoraRtmLockEventType eventType;
 
@property (nonatomic, copy, nonnull) NSString* channelName;
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmLockDetail *> * lockDetailList;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmStorageEvent: NSObject
 
@property (nonatomic, assign) AgoraRtmChannelType channelType;
 
@property (nonatomic, assign) AgoraRtmStorageType storageType;   
 
@property (nonatomic, assign) AgoraRtmStorageEventType eventType;   
 
@property (nonatomic, copy, nonnull) NSString* target;
 
@property (nonatomic, strong, nonnull) AgoraRtmMetadata* data;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmLogConfig: NSObject <NSCopying>
@property (nonatomic, copy, nullable) NSString* filePath;
@property (nonatomic, assign) int fileSizeInKB;
@property (nonatomic, assign) AgoraRtmLogLevel level;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmProxyConfig: NSObject <NSCopying>
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
 
- (instancetype _Nonnull) initWithServer:(NSString * _Nonnull)server
                                    port:(unsigned short)port
                               proxyType:(AgoraRtmProxyType)proxyType; 
@property (nonatomic, assign) AgoraRtmProxyType proxyType;
 
@property (nonatomic, copy, nonnull) NSString* server;
 
@property (nonatomic, assign) unsigned short port;
 
@property (nonatomic, copy, nullable) NSString* account;
 
@property (nonatomic, copy, nullable) NSString* password;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmEncryptionConfig: NSObject <NSCopying>
 
@property (nonatomic, assign) AgoraRtmEncryptionMode encryptionMode;
 
@property (copy, nonatomic ,nullable) NSString * encryptionKey;
 
@property (strong, nonatomic, nullable) NSData * encryptionSalt;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmJoinTopicOption: NSObject
@property (nonatomic, assign) AgoraRtmMessageQos qos;
 
@property (nonatomic, nullable) NSString* meta;
 
@property (nonatomic, assign) AgoraRtmMessagePriority priority;
 
 @property (nonatomic, assign) BOOL syncWithMedia;
 
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmTopicOption: NSObject
@property (nonatomic, copy, nullable) NSArray<NSString *> *users;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmJoinChannelOption: NSObject
@property (nonatomic, copy, nullable) NSString *token;
 
@property (nonatomic, assign) AgoraRtmJoinChannelFeature features;
 
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmMessageEvent: NSObject
 
@property (nonatomic, assign) AgoraRtmChannelType channelType;
@property (nonatomic, copy, nonnull) NSString *channelName;
@property (nonatomic, copy, nonnull) NSString *channelTopic;
@property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
@property (nonatomic, copy, nonnull) NSString *publisher;
@property (nonatomic, copy, nullable) NSString *customType;
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmTopicInfo: NSObject
@property (nonatomic, copy, nonnull) NSString *topic;
 
@property (nonatomic, copy, nonnull) NSArray<AgoraRtmPublisherInfo *> *publishers;
 
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmSubscribeOptions: NSObject
 
@property (nonatomic, assign) AgoraRtmSubscribeChannelFeature features;
 
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmPresenceIntervalInfo: NSObject
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> *joinUserList;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> *leaveUserList;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> *timeoutUserList;
 
@property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmPresenceEvent: NSObject
@property (nonatomic, assign) AgoraRtmPresenceEventType type;
@property (nonatomic, assign) AgoraRtmChannelType channelType;
 
@property (nonatomic, copy, nonnull) NSString * channelName;
 
@property (nonatomic, copy, nullable) NSString * publisher;
 
@property (nonatomic, copy, nonnull) NSDictionary<NSString *, NSString *> * states;
 
@property (nonatomic, copy, nullable) AgoraRtmPresenceIntervalInfo* interval;
 
@property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> * snapshot;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmClientConfig: NSObject
 
- (instancetype _Nullable)init NS_UNAVAILABLE;
- (instancetype _Nonnull) initWithAppId:(NSString * _Nonnull)appId
                        userId:(NSString * _Nonnull)userId;
@property (nonatomic, assign) AgoraRtmAreaCode areaCode;
 
@property (nonatomic, assign)  AgoraRtmProtocolType protocolType;
 
@property (nonatomic, assign) unsigned int presenceTimeout;
 
@property (nonatomic, assign) unsigned int heartbeatInterval;
 
@property (nonatomic, copy, nonnull) NSString *appId;
 
@property (nonatomic, copy, nonnull) NSString *userId;
 
@property (nonatomic, assign) BOOL useStringUserId;
 
@property (nonatomic, assign) BOOL multipath;
 
@property (nonatomic, assign) BOOL ispPolicyEnabled;
 
@property (nonatomic, copy, nullable) AgoraRtmLogConfig * logConfig;
 
@property (nonatomic, copy, nullable) AgoraRtmProxyConfig * proxyConfig;
 
@property (nonatomic, copy, nullable) AgoraRtmEncryptionConfig * encryptionConfig;
 
@property (nonatomic, copy, nullable) AgoraRtmPrivateConfig * privateConfig;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmErrorInfo: NSError
 
/*
*Error code of operation. see enum class  AgoraRtmOperationErrorCode for detail
*/
@property (nonatomic, assign) AgoraRtmErrorCode errorCode;
 
@property (nonatomic, copy, nonnull) NSString *operation;
 
@property (nonatomic, copy, nonnull) NSString *reason;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmTopicSubscriptionResponse: NSObject
@property (nonatomic, copy, nonnull) NSArray<NSString *> *succeedUsers;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> *failedUsers;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetMetadataResponse: NSObject
 
@property (nonatomic, strong, nullable) AgoraRtmMetadata* data;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetLocksResponse: NSObject
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmLockDetail *> * lockDetailList;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersResponse: NSObject
@property (nonatomic, assign) int totalOccupancy;
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmUserState *> *userStateList;
 
@property (nonatomic, copy, nullable) NSString *nextPage;
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmWhoNowResponse: NSObject
@property (nonatomic, assign) int totalOccupancy;
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmUserState *> *userStateList;
 
@property (nonatomic, copy, nullable) NSString *nextPage;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmWhereNowResponse: NSObject
 
@property (nonatomic, assign) int totalChannel;
 
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmChannelInfo *> * channels;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetUserChannelsResponse: NSObject
 
@property (nonatomic, assign) int totalChannel;
 
@property (nonatomic, copy, nonnull)  NSArray<AgoraRtmChannelInfo *> * channels;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmPresenceGetStateResponse: NSObject
 
@property (nonatomic, strong, nonnull)  AgoraRtmUserState * state;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmCommonResponse: NSObject
@end
 
 
__attribute__((visibility("default"))) @interface AgoraRtmMessage: NSObject <NSCopying>
 
@property (nonatomic, copy, nullable) NSData* rawData;
 
@property (nonatomic, copy, nullable) NSString* stringData;
 
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetTopicSubscribedUsersResponse: NSObject
@property (nonatomic, copy, nonnull) NSArray<NSString *> *users;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmPrivateConfig: NSObject
@property (nonatomic, assign) AgoraRtmServiceType serviceType;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> *accessPointHosts;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmLinkStateEvent: NSObject
@property (nonatomic, assign) AgoraRtmLinkState currentState;
 
@property (nonatomic, assign) AgoraRtmLinkState previousState;
 
@property (nonatomic, assign) AgoraRtmServiceType serviceType;
 
@property (nonatomic, assign) AgoraRtmLinkOperation operation;
 
@property (nonatomic, assign) AgoraRtmLinkStateChangeReason reasonCode;
 
@property (nonatomic, copy, nullable) NSString* reason;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> * affectedChannels;
 
@property (nonatomic, copy, nonnull) NSArray<NSString *> * unrestoredChannels;
 
@property (nonatomic, assign) BOOL isResumed;
 
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesOptions: NSObject
@property (nonatomic, assign) int messageCount;
@property (nonatomic, assign) unsigned long long start;
@property (nonatomic, assign) unsigned long long end;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmHistoryMessage : NSObject <NSCopying>
@property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
@property (nonatomic, copy, nonnull) NSString *publisher;
@property (nonatomic, copy, nullable) NSString *customType;
@property (nonatomic, assign) unsigned long long timestamp;
@end
 
__attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesResponse : NSObject
 
@property (nonatomic, copy, nonnull) NSArray <AgoraRtmHistoryMessage *> *messageList;
 
@property (nonatomic, assign) unsigned long long newStart;
@end
 
 
 
typedef void (^AgoraRtmTopicSubscriptionBlock)(AgoraRtmTopicSubscriptionResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmOperationBlock)(AgoraRtmCommonResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmGetMetadataBlock)(AgoraRtmGetMetadataResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmGetLocksBlock)(AgoraRtmGetLocksResponse * _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmWhoNowBlock)(AgoraRtmWhoNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmWhereNowBlock)(AgoraRtmWhereNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmGetOnlineUsersBlock)(AgoraRtmGetOnlineUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmGetUserChannelsBlock)(AgoraRtmGetUserChannelsResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmPresenceGetStateBlock)(AgoraRtmPresenceGetStateResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
 
typedef void (^AgoraRtmGetTopicSubscribedUsersBlock)(AgoraRtmGetTopicSubscribedUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
 
typedef void (^AgoraRtmGetHistoryMessagesBlock)(AgoraRtmGetHistoryMessagesResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);