Agora RTC Objective-C API Reference  Refactor
AgoraRtmObjects.h
Go to the documentation of this file.
1 #import <Foundation/Foundation.h>
2 #import "AgoraRtmEnumerates.h"
3 
5 @class AgoraRtmClientKit;
12 @class AgoraRtmTopicInfo;
16 @class AgoraRtmLock;
17 @class AgoraRtmStorage;
18 @class AgoraRtmPresence;
21 @class AgoraRtmMetadata;
22 @class AgoraRtmLockDetail;
25 @class AgoraRtmUserState;
26 @class AgoraRtmChannelInfo;
27 @class AgoraRtmTopicEvent;
28 @class AgoraRtmLockEvent;
31 @class AgoraRtmLogConfig;
32 @class AgoraRtmProxyConfig;
35 @class AgoraRtmErrorInfo;
37 @class AgoraRtmLoginErrorInfo;
46 @class AgoraRtmMessage;
49 @class AgoraRtmHistory;
53 
54 __attribute__((visibility("default"))) @interface AgoraRtmPublishOptions: NSObject
58 @property (nonatomic, assign) AgoraRtmChannelType channelType;
59 
63 @property (nonatomic, copy, nonnull) NSString* customType;
64 
68 @property (nonatomic, assign) BOOL storeInHistory;
69 @end
70 
71 
72 __attribute__((visibility("default"))) @interface AgoraRtmTopicMessageOptions: NSObject
76 @property (nonatomic, copy, nonnull) NSString* customType;
77 
82 @property (nonatomic, assign) unsigned long long sendTs;
83 @end
84 
85 __attribute__((visibility("default"))) @interface AgoraRtmMetadataOptions: NSObject
86 
90 @property (nonatomic, assign) BOOL recordTs;
91 
95 @property (nonatomic, assign) BOOL recordUserId;
96 @end
97 
98 __attribute__((visibility("default"))) @interface AgoraRtmMetadataItem: NSObject
99 
103 @property (nonatomic, copy, nonnull) NSString* key;
104 
108 @property (nonatomic, copy, nonnull) NSString* value;
109 
113 @property (nonatomic, copy, nonnull) NSString* authorUserId;
114 
118 @property (nonatomic, assign) long long revision;
119 
123 @property (nonatomic, assign) unsigned long long updateTs;
124 @end
125 
126 __attribute__((visibility("default"))) @interface AgoraRtmMetadata: NSObject
127 
128 - (instancetype _Nullable)init;
132 @property (nonatomic, assign) long long majorRevision;
133 
137 @property (nonatomic, copy, nullable) NSArray<AgoraRtmMetadataItem *> *items;
138 @end
139 
140 __attribute__((visibility("default"))) @interface AgoraRtmLockDetail: NSObject
144 @property (nonatomic, copy, nonnull) NSString* lockName;
145 
149 @property (nonatomic, copy, nonnull) NSString* owner;
150 
154 @property (nonatomic, assign) int ttl;
155 
159 @property (nonatomic, assign) unsigned long long timestamp;
160 @end
161 
162 __attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersOptions: NSObject
166 @property (nonatomic, assign) BOOL includeUserId;
167 
171 @property (nonatomic, assign) BOOL includeState;
172 
176 @property (nonatomic, copy, nonnull) NSString* page;
177 @end
178 
179 __attribute__((visibility("default"))) @interface AgoraRtmPresenceOptions: NSObject
183 @property (nonatomic, assign) BOOL includeUserId;
184 
188 @property (nonatomic, assign) BOOL includeState;
189 
193 @property (nonatomic, copy, nonnull) NSString* page;
194 @end
195 
196 __attribute__((visibility("default"))) @interface AgoraRtmUserState: NSObject
197 
201 @property (nonatomic, copy, nonnull) NSString* userId;
202 
206 @property (nonatomic, copy, nonnull) NSDictionary<NSString *, NSString *> * states;
207 @end
208 
209 __attribute__((visibility("default"))) @interface AgoraRtmChannelInfo: NSObject
210 
214 @property (nonatomic, copy, nonnull) NSString* channelName;
215 
219 @property (nonatomic, assign) AgoraRtmChannelType channelType;
220 @end
221 
222 
223 __attribute__((visibility("default"))) @interface AgoraRtmTopicEvent: NSObject
224 
228 @property (nonatomic, assign) AgoraRtmTopicEventType type;
229 
233 @property (nonatomic, copy, nonnull) NSString* channelName;
234 
238 @property (nonatomic, copy, nonnull) NSString* publisher;
239 
243 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmTopicInfo *> *topicInfos;
244 
248 @property (nonatomic, assign) unsigned long long timestamp;
249 @end
250 
251 __attribute__((visibility("default"))) @interface AgoraRtmPublisherInfo: NSObject
255 @property (nonatomic, copy, nonnull) NSString* publisherUserId;
256 
260 @property (nonatomic, copy, nullable) NSString* publisherMeta;
261 @end
262 
263 __attribute__((visibility("default"))) @interface AgoraRtmLockEvent: NSObject
267 @property (nonatomic, assign) AgoraRtmChannelType channelType;
268 
272 @property (nonatomic, assign) AgoraRtmLockEventType eventType;
273 
277 @property (nonatomic, copy, nonnull) NSString* channelName;
281 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmLockDetail *> * lockDetailList;
282 
286 @property (nonatomic, assign) unsigned long long timestamp;
287 @end
288 
289 __attribute__((visibility("default"))) @interface AgoraRtmStorageEvent: NSObject
290 
294 @property (nonatomic, assign) AgoraRtmChannelType channelType;
295 
299 @property (nonatomic, assign) AgoraRtmStorageType storageType;
300 
304 @property (nonatomic, assign) AgoraRtmStorageEventType eventType;
305 
309 @property (nonatomic, copy, nonnull) NSString* target;
310 
314 @property (nonatomic, strong, nonnull) AgoraRtmMetadata* data;
315 
319 @property (nonatomic, assign) unsigned long long timestamp;
320 @end
321 
322 __attribute__((visibility("default"))) @interface AgoraRtmLogConfig: NSObject <NSCopying>
326 @property (nonatomic, copy, nullable) NSString* filePath;
330 @property (nonatomic, assign) int fileSizeInKB;
334 @property (nonatomic, assign) AgoraRtmLogLevel level;
335 @end
336 
337 __attribute__((visibility("default"))) @interface AgoraRtmProxyConfig: NSObject <NSCopying>
338 
339 - (instancetype _Nullable)init NS_UNAVAILABLE;
340 
341 - (instancetype _Nonnull) initWithServer:(NSString * _Nonnull)server
342  port:(unsigned short)port
343  proxyType:(AgoraRtmProxyType)proxyType;
347 @property (nonatomic, assign) AgoraRtmProxyType proxyType;
348 
352 @property (nonatomic, copy, nonnull) NSString* server;
353 
357 @property (nonatomic, assign) unsigned short port;
358 
362 @property (nonatomic, copy, nullable) NSString* account;
363 
367 @property (nonatomic, copy, nullable) NSString* password;
368 @end
369 
370 __attribute__((visibility("default"))) @interface AgoraRtmEncryptionConfig: NSObject <NSCopying>
371 
375 @property (nonatomic, assign) AgoraRtmEncryptionMode encryptionMode;
376 
380 @property (copy, nonatomic ,nullable) NSString * encryptionKey;
381 
385 @property (strong, nonatomic, nullable) NSData * encryptionSalt;
386 @end
387 
391 __attribute__((visibility("default"))) @interface AgoraRtmJoinTopicOption: NSObject
395 @property (nonatomic, assign) AgoraRtmMessageQos qos;
396 
400 @property (nonatomic, nullable) NSString* meta;
401 
405 @property (nonatomic, assign) AgoraRtmMessagePriority priority;
406 
410  @property (nonatomic, assign) BOOL syncWithMedia;
411 
412 @end
413 
417 __attribute__((visibility("default"))) @interface AgoraRtmTopicOption: NSObject
421 @property (nonatomic, copy, nullable) NSArray<NSString *> *users;
422 @end
423 
427 __attribute__((visibility("default"))) @interface AgoraRtmJoinChannelOption: NSObject
431 @property (nonatomic, copy, nullable) NSString *token;
432 
436 @property (nonatomic, assign) AgoraRtmJoinChannelFeature features;
437 
438 @end
439 
440 __attribute__((visibility("default"))) @interface AgoraRtmMessageEvent: NSObject
441 
445 @property (nonatomic, assign) AgoraRtmChannelType channelType;
449 @property (nonatomic, copy, nonnull) NSString *channelName;
453 @property (nonatomic, copy, nonnull) NSString *channelTopic;
457 @property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
461 @property (nonatomic, copy, nonnull) NSString *publisher;
465 @property (nonatomic, copy, nullable) NSString *customType;
469 @property (nonatomic, assign) unsigned long long timestamp;
470 @end
471 
472 __attribute__((visibility("default"))) @interface AgoraRtmTopicInfo: NSObject
476 @property (nonatomic, copy, nonnull) NSString *topic;
477 
481 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmPublisherInfo *> *publishers;
482 
483 @end
484 
485 __attribute__((visibility("default"))) @interface AgoraRtmSubscribeOptions: NSObject
486 
490 @property (nonatomic, assign) AgoraRtmSubscribeChannelFeature features;
491 
492 @end
493 
494 __attribute__((visibility("default"))) @interface AgoraRtmPresenceIntervalInfo: NSObject
495 
499 @property (nonatomic, copy, nonnull) NSArray<NSString *> *joinUserList;
500 
504 @property (nonatomic, copy, nonnull) NSArray<NSString *> *leaveUserList;
505 
509 @property (nonatomic, copy, nonnull) NSArray<NSString *> *timeoutUserList;
510 
514 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
515 @end
516 
517 
518 __attribute__((visibility("default"))) @interface AgoraRtmPresenceEvent: NSObject
522 @property (nonatomic, assign) AgoraRtmPresenceEventType type;
526 @property (nonatomic, assign) AgoraRtmChannelType channelType;
527 
531 @property (nonatomic, copy, nonnull) NSString * channelName;
532 
536 @property (nonatomic, copy, nullable) NSString * publisher;
537 
541 @property (nonatomic, copy, nonnull) NSDictionary<NSString *, NSString *> * states;
542 
546 @property (nonatomic, copy, nullable) AgoraRtmPresenceIntervalInfo* interval;
547 
551 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> * snapshot;
552 
556 @property (nonatomic, assign) unsigned long long timestamp;
557 @end
558 
562 __attribute__((visibility("default"))) @interface AgoraRtmClientConfig: NSObject
563 
564 - (instancetype _Nullable)init NS_UNAVAILABLE;
568 - (instancetype _Nonnull) initWithAppId:(NSString * _Nonnull)appId
569  userId:(NSString * _Nonnull)userId;
579 @property (nonatomic, assign) AgoraRtmAreaCode areaCode;
580 
584 @property (nonatomic, assign) AgoraRtmProtocolType protocolType;
585 
590 @property (nonatomic, assign) unsigned int presenceTimeout;
591 
596 @property (nonatomic, assign) unsigned int heartbeatInterval;
597 
601 @property (nonatomic, copy, nonnull) NSString *appId;
602 
606 @property (nonatomic, copy, nonnull) NSString *userId;
607 
612 @property (nonatomic, assign) BOOL useStringUserId;
613 
617 @property (nonatomic, assign) BOOL multipath;
618 
622 @property (nonatomic, copy, nullable) AgoraRtmLogConfig * logConfig;
623 
627 @property (nonatomic, copy, nullable) AgoraRtmProxyConfig * proxyConfig;
628 
632 @property (nonatomic, copy, nullable) AgoraRtmEncryptionConfig * encryptionConfig;
633 
637 @property (nonatomic, copy, nullable) AgoraRtmPrivateConfig * privateConfig;
638 @end
639 
640 __attribute__((visibility("default"))) @interface AgoraRtmErrorInfo: NSError
641 
642 /*
643 *Error code of operation. see enum class AgoraRtmOperationErrorCode for detail
644 */
645 @property (nonatomic, assign) AgoraRtmErrorCode errorCode;
646 
650 @property (nonatomic, copy, nonnull) NSString *operation;
651 
655 @property (nonatomic, copy, nonnull) NSString *reason;
656 @end
657 
658 
659 __attribute__((visibility("default"))) @interface AgoraRtmTopicSubscriptionResponse: NSObject
663 @property (nonatomic, copy, nonnull) NSArray<NSString *> *succeedUsers;
664 
668 @property (nonatomic, copy, nonnull) NSArray<NSString *> *failedUsers;
669 @end
670 
671 __attribute__((visibility("default"))) @interface AgoraRtmGetMetadataResponse: NSObject
672 
676 @property (nonatomic, strong, nullable) AgoraRtmMetadata* data;
677 @end
678 
679 __attribute__((visibility("default"))) @interface AgoraRtmGetLocksResponse: NSObject
683 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmLockDetail *> * lockDetailList;
684 @end
685 
686 
687 __attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersResponse: NSObject
691 @property (nonatomic, assign) int totalOccupancy;
695 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
696 
700 @property (nonatomic, copy, nullable) NSString *nextPage;
701 @end
702 
703 
704 __attribute__((visibility("default"))) @interface AgoraRtmWhoNowResponse: NSObject
708 @property (nonatomic, assign) int totalOccupancy;
712 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
713 
717 @property (nonatomic, copy, nullable) NSString *nextPage;
718 @end
719 
720 __attribute__((visibility("default"))) @interface AgoraRtmWhereNowResponse: NSObject
721 
725 @property (nonatomic, assign) int totalChannel;
726 
730 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
731 @end
732 
733 __attribute__((visibility("default"))) @interface AgoraRtmGetUserChannelsResponse: NSObject
734 
738 @property (nonatomic, assign) int totalChannel;
739 
743 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
744 @end
745 
746 __attribute__((visibility("default"))) @interface AgoraRtmPresenceGetStateResponse: NSObject
747 
751 @property (nonatomic, strong, nonnull) AgoraRtmUserState * state;
752 @end
753 
754 __attribute__((visibility("default"))) @interface AgoraRtmCommonResponse: NSObject
755 @end
756 
757 
758 __attribute__((visibility("default"))) @interface AgoraRtmMessage: NSObject <NSCopying>
759 
763 @property (nonatomic, copy, nullable) NSData* rawData;
764 
768 @property (nonatomic, copy, nullable) NSString* stringData;
769 
770 @end
771 
772 __attribute__((visibility("default"))) @interface AgoraRtmGetTopicSubscribedUsersResponse: NSObject
776 @property (nonatomic, copy, nonnull) NSArray<NSString *> *users;
777 @end
778 
779 __attribute__((visibility("default"))) @interface AgoraRtmPrivateConfig: NSObject
783 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
784 
788 @property (nonatomic, copy, nonnull) NSArray<NSString *> *accessPointHosts;
789 @end
790 
791 __attribute__((visibility("default"))) @interface AgoraRtmLinkStateEvent: NSObject
795 @property (nonatomic, assign) AgoraRtmLinkState currentState;
796 
800 @property (nonatomic, assign) AgoraRtmLinkState previousState;
801 
805 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
806 
810 @property (nonatomic, assign) AgoraRtmLinkOperation operation;
811 
815 @property (nonatomic, assign) AgoraRtmLinkStateChangeReason reasonCode;
816 
820 @property (nonatomic, copy, nullable) NSString* reason;
821 
825 @property (nonatomic, copy, nonnull) NSArray<NSString *> * affectedChannels;
826 
830 @property (nonatomic, copy, nonnull) NSArray<NSString *> * unrestoredChannels;
831 
835 @property (nonatomic, assign) BOOL isResumed;
836 
840 @property (nonatomic, assign) unsigned long long timestamp;
841 @end
842 
846 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesOptions: NSObject
850 @property (nonatomic, assign) int messageCount;
854 @property (nonatomic, assign) unsigned long long start;
858 @property (nonatomic, assign) unsigned long long end;
859 @end
860 
864 __attribute__((visibility("default"))) @interface AgoraRtmHistoryMessage : NSObject <NSCopying>
868 @property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
872 @property (nonatomic, copy, nonnull) NSString *publisher;
876 @property (nonatomic, copy, nullable) NSString *customType;
880 @property (nonatomic, assign) unsigned long long timestamp;
881 @end
882 
883 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesResponse : NSObject
884 
888 @property (nonatomic, copy, nonnull) NSArray <AgoraRtmHistoryMessage *> *messageList;
889 
893 @property (nonatomic, assign) unsigned long long newStart;
894 @end
895 
896 
897 
898 typedef void (^AgoraRtmTopicSubscriptionBlock)(AgoraRtmTopicSubscriptionResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
899 
900 typedef void (^AgoraRtmOperationBlock)(AgoraRtmCommonResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
901 
902 typedef void (^AgoraRtmGetMetadataBlock)(AgoraRtmGetMetadataResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
903 
904 typedef void (^AgoraRtmGetLocksBlock)(AgoraRtmGetLocksResponse * _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
905 
906 typedef void (^AgoraRtmWhoNowBlock)(AgoraRtmWhoNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
907 
908 typedef void (^AgoraRtmWhereNowBlock)(AgoraRtmWhereNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
909 
910 typedef void (^AgoraRtmGetOnlineUsersBlock)(AgoraRtmGetOnlineUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
911 
912 typedef void (^AgoraRtmGetUserChannelsBlock)(AgoraRtmGetUserChannelsResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
913 
914 typedef void (^AgoraRtmPresenceGetStateBlock)(AgoraRtmPresenceGetStateResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
915 
916 typedef void (^AgoraRtmGetTopicSubscribedUsersBlock)(AgoraRtmGetTopicSubscribedUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
917 
918 typedef void (^AgoraRtmGetHistoryMessagesBlock)(AgoraRtmGetHistoryMessagesResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
AgoraRtmPublishOptions::customType
NSString * customType
Definition: AgoraRtmObjects.h:63
AgoraRtmGetHistoryMessagesOptions
The option to query history message.
Definition: AgoraRtmObjects.h:847
AgoraRtmStorageEvent
Definition: AgoraRtmObjects.h:290
AgoraRtmGetOnlineUsersOptions
Definition: AgoraRtmObjects.h:163
AgoraRtmClientConfig::logConfig
AgoraRtmLogConfig * logConfig
Definition: AgoraRtmObjects.h:622
AgoraRtmClientConfig::appId
NSString * appId
Definition: AgoraRtmObjects.h:601
AgoraRtmProxyType
AgoraRtmProxyType
Definition: AgoraRtmEnumerates.h:584
AgoraRtmClientConfig::proxyConfig
AgoraRtmProxyConfig * proxyConfig
Definition: AgoraRtmObjects.h:627
AgoraRtmUserState
Definition: AgoraRtmObjects.h:197
AgoraRtmProxyConfig::server
NSString * server
Definition: AgoraRtmObjects.h:352
AgoraRtmClientConfig::useStringUserId
BOOL useStringUserId
Definition: AgoraRtmObjects.h:612
-[AgoraRtmProxyConfig NS_UNAVAILABLE]
instancetype _Nullable NS_UNAVAILABLE()
AgoraRtmStorageEventType
AgoraRtmStorageEventType
Definition: AgoraRtmEnumerates.h:1150
AgoraRtmGetTopicSubscribedUsersResponse
Definition: AgoraRtmObjects.h:773
AgoraRtmPublishOptions::channelType
AgoraRtmChannelType channelType
Definition: AgoraRtmObjects.h:58
AgoraRtmLockDetail
Definition: AgoraRtmObjects.h:141
AgoraRtmServiceType
AgoraRtmServiceType
Definition: AgoraRtmEnumerates.h:599
AgoraRtmEncryptionConfig
Definition: AgoraRtmObjects.h:370
AgoraRtmGetHistoryMessagesResponse
Definition: AgoraRtmObjects.h:884
AgoraRtmMessage
Definition: AgoraRtmObjects.h:758
AgoraRtmAreaCode
AgoraRtmAreaCode
Definition: AgoraRtmEnumerates.h:6
AgoraRtmLogConfig
Definition: AgoraRtmObjects.h:322
AgoraRtmJoinChannelOption
Definition: AgoraRtmObjects.h:428
AgoraRtmPublishOptions
Definition: AgoraRtmObjects.h:55
AgoraRtmMetadata::items
NSArray< AgoraRtmMetadataItem * > * items
Definition: AgoraRtmObjects.h:137
AgoraRtmLinkOperation
AgoraRtmLinkOperation
Definition: AgoraRtmEnumerates.h:815
AgoraRtmPrivateConfig
Definition: AgoraRtmObjects.h:780
AgoraRtmPublisherInfo
Definition: AgoraRtmObjects.h:252
AgoraRtmLinkState
AgoraRtmLinkState
Definition: AgoraRtmEnumerates.h:631
AgoraRtmClientConfig::presenceTimeout
unsigned int presenceTimeout
Definition: AgoraRtmObjects.h:590
AgoraRtmPublishOptions::storeInHistory
BOOL storeInHistory
Definition: AgoraRtmObjects.h:68
AgoraRtmMetadata
Definition: AgoraRtmObjects.h:127
AgoraRtmWhereNowResponse
Definition: AgoraRtmObjects.h:721
AgoraRtmClientKit
Definition: AgoraRtmClientKit.h:99
AgoraRtmProxyConfig::account
NSString * account
Definition: AgoraRtmObjects.h:362
AgoraRtmLogLevel
AgoraRtmLogLevel
Definition: AgoraRtmEnumerates.h:1217
AgoraRtmProxyConfig
Definition: AgoraRtmObjects.h:337
AgoraRtmProxyConfig::proxyType
AgoraRtmProxyType proxyType
Definition: AgoraRtmObjects.h:347
AgoraRtmHistoryMessage
The details of history message.
Definition: AgoraRtmObjects.h:864
AgoraRtmTopicSubscriptionResponse
Definition: AgoraRtmObjects.h:660
AgoraRtmClientConfig::privateConfig
AgoraRtmPrivateConfig * privateConfig
Definition: AgoraRtmObjects.h:637
AgoraRtmTopicEventType
AgoraRtmTopicEventType
Topic event type.
Definition: AgoraRtmEnumerates.h:861
AgoraRtmChannelInfo
Definition: AgoraRtmObjects.h:210
AgoraRtmLockEventType
AgoraRtmLockEventType
Definition: AgoraRtmEnumerates.h:549
AgoraRtmTopicEvent
Definition: AgoraRtmObjects.h:224
AgoraRtmTopicMessageOptions
Definition: AgoraRtmObjects.h:73
AgoraRtmClientConfig
Definition: AgoraRtmObjects.h:563
AgoraRtmEncryptionMode
AgoraRtmEncryptionMode
Definition: AgoraRtmEnumerates.h:40
AgoraRtmTopicInfo
Definition: AgoraRtmObjects.h:473
AgoraRtmPresenceGetStateResponse
Definition: AgoraRtmObjects.h:747
AgoraRtmLockEvent
Definition: AgoraRtmObjects.h:264
AgoraRtmPresenceEventType
AgoraRtmPresenceEventType
Presence event type.
Definition: AgoraRtmEnumerates.h:883
AgoraRtmMetadata::majorRevision
long long majorRevision
Definition: AgoraRtmObjects.h:132
AgoraRtmGetMetadataResponse
Definition: AgoraRtmObjects.h:672
AgoraRtmJoinTopicOption
Definition: AgoraRtmObjects.h:392
AgoraRtmClientConfig::areaCode
AgoraRtmAreaCode areaCode
Definition: AgoraRtmObjects.h:579
AgoraRtmMessageEvent
Definition: AgoraRtmObjects.h:441
AgoraRtmMessagePriority
AgoraRtmMessagePriority
Definition: AgoraRtmEnumerates.h:55
AgoraRtmClientConfig::userId
NSString * userId
Definition: AgoraRtmObjects.h:606
AgoraRtmJoinChannelFeature
AgoraRtmJoinChannelFeature
Definition: AgoraRtmEnumerates.h:921
AgoraRtmErrorInfo
Definition: AgoraRtmObjects.h:641
AgoraRtmStorageType
AgoraRtmStorageType
Storage type indicate the storage event was triggered by user or channel.
Definition: AgoraRtmEnumerates.h:531
AgoraRtmMetadataOptions
Definition: AgoraRtmObjects.h:86
AgoraRtmStreamChannel
Definition: AgoraRtmClientKit.h:293
AgoraRtmProxyConfig::password
NSString * password
Definition: AgoraRtmObjects.h:367
AgoraRtmStorage
Definition: AgoraRtmClientKit.h:428
AgoraRtmErrorCode
AgoraRtmErrorCode
Definition: AgoraRtmEnumerates.h:78
AgoraRtmSubscribeChannelFeature
AgoraRtmSubscribeChannelFeature
Definition: AgoraRtmEnumerates.h:947
AgoraRtmGetOnlineUsersResponse
Definition: AgoraRtmObjects.h:688
AgoraRtmGetUserChannelsResponse
Definition: AgoraRtmObjects.h:734
AgoraRtmClientConfig::multipath
BOOL multipath
Definition: AgoraRtmObjects.h:617
AgoraRtmPresenceEvent
Definition: AgoraRtmObjects.h:519
AgoraRtmProxyConfig::port
unsigned short port
Definition: AgoraRtmObjects.h:357
AgoraRtmWhoNowResponse
Definition: AgoraRtmObjects.h:705
AgoraRtmMetadataItem
Definition: AgoraRtmObjects.h:99
AgoraRtmEnumerates.h
-[AgoraRtmClientConfig NS_UNAVAILABLE]
instancetype _Nullable NS_UNAVAILABLE()
AgoraRtmClientConfig::heartbeatInterval
unsigned int heartbeatInterval
Definition: AgoraRtmObjects.h:596
AgoraRtmClientConfig::protocolType
AgoraRtmProtocolType protocolType
Definition: AgoraRtmObjects.h:584
AgoraRtmSubscribeOptions
Definition: AgoraRtmObjects.h:486
AgoraRtmPresenceOptions
Definition: AgoraRtmObjects.h:180
AgoraRtmCommonResponse
Definition: AgoraRtmObjects.h:755
AgoraRtmLinkStateChangeReason
AgoraRtmLinkStateChangeReason
Definition: AgoraRtmEnumerates.h:661
AgoraRtmTopicOption
Definition: AgoraRtmObjects.h:418
AgoraRtmClientConfig::encryptionConfig
AgoraRtmEncryptionConfig * encryptionConfig
Definition: AgoraRtmObjects.h:632
AgoraRtmProtocolType
AgoraRtmProtocolType
Definition: AgoraRtmEnumerates.h:617
AgoraRtmHistory
Definition: AgoraRtmClientKit.h:772
AgoraRtmChannelType
AgoraRtmChannelType
Definition: AgoraRtmEnumerates.h:1128
AgoraRtmPresence
Definition: AgoraRtmClientKit.h:671
-[AgoraRtmMetadata init]
instancetype _Nullable init()
AgoraRtmGetLocksResponse
Definition: AgoraRtmObjects.h:680
AgoraRtmPresenceIntervalInfo
Definition: AgoraRtmObjects.h:495
AgoraRtmMessageQos
AgoraRtmMessageQos
Definition: AgoraRtmEnumerates.h:1206
AgoraRtmLock
Definition: AgoraRtmClientKit.h:571