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
4 @class AgoraRtmPublisherInfo;
5 @class AgoraRtmClientKit;
6 @class AgoraRtmMessageEvent;
7 @class AgoraRtmTopicOption;
8 @class AgoraRtmJoinTopicOption;
9 @class AgoraRtmJoinChannelOption;
10 @class AgoraRtmClientConfig;
11 @class AgoraRtmStreamChannel;
12 @class AgoraRtmTopicInfo;
13 @class AgoraRtmSubscribeOptions;
14 @class AgoraRtmPublishOptions;
15 @class AgoraRtmTopicMessageOptions;
16 @class AgoraRtmLock;
17 @class AgoraRtmStorage;
18 @class AgoraRtmPresence;
19 @class AgoraRtmMetadataOptions;
20 @class AgoraRtmMetadataItem;
21 @class AgoraRtmMetadata;
22 @class AgoraRtmLockDetail;
23 @class AgoraRtmPresenceOptions;
24 @class AgoraRtmGetOnlineUsersOptions;
25 @class AgoraRtmUserState;
26 @class AgoraRtmChannelInfo;
27 @class AgoraRtmTopicEvent;
28 @class AgoraRtmLockEvent;
29 @class AgoraRtmStorageEvent;
30 @class AgoraRtmPresenceEvent;
31 @class AgoraRtmLogConfig;
32 @class AgoraRtmProxyConfig;
33 @class AgoraRtmEncryptionConfig;
34 @class AgoraRtmPresenceIntervalInfo;
35 @class AgoraRtmErrorInfo;
36 @class AgoraRtmTopicSubscriptionResponse;
37 @class AgoraRtmLoginErrorInfo;
38 @class AgoraRtmGetMetadataResponse;
39 @class AgoraRtmGetLocksResponse;
40 @class AgoraRtmWhoNowResponse;
41 @class AgoraRtmGetOnlineUsersResponse;
42 @class AgoraRtmWhereNowResponse;
43 @class AgoraRtmGetUserChannelsResponse;
44 @class AgoraRtmPresenceGetStateResponse;
45 @class AgoraRtmGetTopicSubscribedUsersResponse;
46 @class AgoraRtmMessage;
47 @class AgoraRtmPrivateConfig;
48 @class AgoraRtmLinkStateEvent;
49 @class AgoraRtmHistory;
50 @class AgoraRtmGetHistoryMessagesOptions;
51 @class AgoraRtmHistoryMessage;
52 @class AgoraRtmGetHistoryMessagesResponse;
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
624 @property (nonatomic, assign) BOOL ispPolicyEnabled;
625
629 @property (nonatomic, copy, nullable) AgoraRtmLogConfig * logConfig;
630
634 @property (nonatomic, copy, nullable) AgoraRtmProxyConfig * proxyConfig;
635
639 @property (nonatomic, copy, nullable) AgoraRtmEncryptionConfig * encryptionConfig;
640
644 @property (nonatomic, copy, nullable) AgoraRtmPrivateConfig * privateConfig;
645 @end
646
647 __attribute__((visibility("default"))) @interface AgoraRtmErrorInfo: NSError
648
649 /*
650 *Error code of operation. see enum class AgoraRtmOperationErrorCode for detail
651 */
652 @property (nonatomic, assign) AgoraRtmErrorCode errorCode;
653
657 @property (nonatomic, copy, nonnull) NSString *operation;
658
662 @property (nonatomic, copy, nonnull) NSString *reason;
663 @end
664
665
666 __attribute__((visibility("default"))) @interface AgoraRtmTopicSubscriptionResponse: NSObject
670 @property (nonatomic, copy, nonnull) NSArray<NSString *> *succeedUsers;
671
675 @property (nonatomic, copy, nonnull) NSArray<NSString *> *failedUsers;
676 @end
677
678 __attribute__((visibility("default"))) @interface AgoraRtmGetMetadataResponse: NSObject
679
683 @property (nonatomic, strong, nullable) AgoraRtmMetadata* data;
684 @end
685
686 __attribute__((visibility("default"))) @interface AgoraRtmGetLocksResponse: NSObject
690 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmLockDetail *> * lockDetailList;
691 @end
692
693
694 __attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersResponse: NSObject
698 @property (nonatomic, assign) int totalOccupancy;
702 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
703
707 @property (nonatomic, copy, nullable) NSString *nextPage;
708 @end
709
710
711 __attribute__((visibility("default"))) @interface AgoraRtmWhoNowResponse: NSObject
715 @property (nonatomic, assign) int totalOccupancy;
719 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
720
724 @property (nonatomic, copy, nullable) NSString *nextPage;
725 @end
726
727 __attribute__((visibility("default"))) @interface AgoraRtmWhereNowResponse: NSObject
728
732 @property (nonatomic, assign) int totalChannel;
733
737 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
738 @end
739
740 __attribute__((visibility("default"))) @interface AgoraRtmGetUserChannelsResponse: NSObject
741
745 @property (nonatomic, assign) int totalChannel;
746
750 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
751 @end
752
753 __attribute__((visibility("default"))) @interface AgoraRtmPresenceGetStateResponse: NSObject
754
758 @property (nonatomic, strong, nonnull) AgoraRtmUserState * state;
759 @end
760
761 __attribute__((visibility("default"))) @interface AgoraRtmCommonResponse: NSObject
762 @end
763
764
765 __attribute__((visibility("default"))) @interface AgoraRtmMessage: NSObject <NSCopying>
766
770 @property (nonatomic, copy, nullable) NSData* rawData;
771
775 @property (nonatomic, copy, nullable) NSString* stringData;
776
777 @end
778
779 __attribute__((visibility("default"))) @interface AgoraRtmGetTopicSubscribedUsersResponse: NSObject
783 @property (nonatomic, copy, nonnull) NSArray<NSString *> *users;
784 @end
785
786 __attribute__((visibility("default"))) @interface AgoraRtmPrivateConfig: NSObject
790 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
791
795 @property (nonatomic, copy, nonnull) NSArray<NSString *> *accessPointHosts;
796 @end
797
798 __attribute__((visibility("default"))) @interface AgoraRtmLinkStateEvent: NSObject
802 @property (nonatomic, assign) AgoraRtmLinkState currentState;
803
807 @property (nonatomic, assign) AgoraRtmLinkState previousState;
808
812 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
813
817 @property (nonatomic, assign) AgoraRtmLinkOperation operation;
818
822 @property (nonatomic, assign) AgoraRtmLinkStateChangeReason reasonCode;
823
827 @property (nonatomic, copy, nullable) NSString* reason;
828
832 @property (nonatomic, copy, nonnull) NSArray<NSString *> * affectedChannels;
833
837 @property (nonatomic, copy, nonnull) NSArray<NSString *> * unrestoredChannels;
838
842 @property (nonatomic, assign) BOOL isResumed;
843
847 @property (nonatomic, assign) unsigned long long timestamp;
848 @end
849
853 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesOptions: NSObject
857 @property (nonatomic, assign) int messageCount;
861 @property (nonatomic, assign) unsigned long long start;
865 @property (nonatomic, assign) unsigned long long end;
866 @end
867
871 __attribute__((visibility("default"))) @interface AgoraRtmHistoryMessage : NSObject <NSCopying>
875 @property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
879 @property (nonatomic, copy, nonnull) NSString *publisher;
883 @property (nonatomic, copy, nullable) NSString *customType;
887 @property (nonatomic, assign) unsigned long long timestamp;
888 @end
889
890 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesResponse : NSObject
891
895 @property (nonatomic, copy, nonnull) NSArray <AgoraRtmHistoryMessage *> *messageList;
896
900 @property (nonatomic, assign) unsigned long long newStart;
901 @end
902
903
904
905 typedef void (^AgoraRtmTopicSubscriptionBlock)(AgoraRtmTopicSubscriptionResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
906
907 typedef void (^AgoraRtmOperationBlock)(AgoraRtmCommonResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
908
909 typedef void (^AgoraRtmGetMetadataBlock)(AgoraRtmGetMetadataResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
910
911 typedef void (^AgoraRtmGetLocksBlock)(AgoraRtmGetLocksResponse * _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
912
913 typedef void (^AgoraRtmWhoNowBlock)(AgoraRtmWhoNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
914
915 typedef void (^AgoraRtmWhereNowBlock)(AgoraRtmWhereNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
916
917 typedef void (^AgoraRtmGetOnlineUsersBlock)(AgoraRtmGetOnlineUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
918
919 typedef void (^AgoraRtmGetUserChannelsBlock)(AgoraRtmGetUserChannelsResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
920
921 typedef void (^AgoraRtmPresenceGetStateBlock)(AgoraRtmPresenceGetStateResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
922
923 typedef void (^AgoraRtmGetTopicSubscribedUsersBlock)(AgoraRtmGetTopicSubscribedUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
924
925 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:854
AgoraRtmStorageEvent
Definition: AgoraRtmObjects.h:290
AgoraRtmGetOnlineUsersOptions
Definition: AgoraRtmObjects.h:163
AgoraRtmLinkStateEvent
Definition: AgoraRtmObjects.h:799
AgoraRtmClientConfig::logConfig
AgoraRtmLogConfig * logConfig
Definition: AgoraRtmObjects.h:629
AgoraRtmClientConfig::appId
NSString * appId
Definition: AgoraRtmObjects.h:601
AgoraRtmProxyType
AgoraRtmProxyType
Definition: AgoraRtmEnumerates.h:588
AgoraRtmClientConfig::proxyConfig
AgoraRtmProxyConfig * proxyConfig
Definition: AgoraRtmObjects.h:634
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:1158
AgoraRtmGetTopicSubscribedUsersResponse
Definition: AgoraRtmObjects.h:780
AgoraRtmPublishOptions::channelType
AgoraRtmChannelType channelType
Definition: AgoraRtmObjects.h:58
AgoraRtmLockDetail
Definition: AgoraRtmObjects.h:141
AgoraRtmServiceType
AgoraRtmServiceType
Definition: AgoraRtmEnumerates.h:603
AgoraRtmEncryptionConfig
Definition: AgoraRtmObjects.h:370
AgoraRtmGetHistoryMessagesResponse
Definition: AgoraRtmObjects.h:891
AgoraRtmMessage
Definition: AgoraRtmObjects.h:765
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:823
AgoraRtmPrivateConfig
Definition: AgoraRtmObjects.h:787
AgoraRtmPublisherInfo
Definition: AgoraRtmObjects.h:252
AgoraRtmClientConfig::ispPolicyEnabled
BOOL ispPolicyEnabled
Definition: AgoraRtmObjects.h:624
AgoraRtmLinkState
AgoraRtmLinkState
Definition: AgoraRtmEnumerates.h:635
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:728
AgoraRtmClientKit
Definition: AgoraRtmClientKit.h:99
AgoraRtmProxyConfig::account
NSString * account
Definition: AgoraRtmObjects.h:362
AgoraRtmLogLevel
AgoraRtmLogLevel
Definition: AgoraRtmEnumerates.h:1225
AgoraRtmProxyConfig
Definition: AgoraRtmObjects.h:337
AgoraRtmProxyConfig::proxyType
AgoraRtmProxyType proxyType
Definition: AgoraRtmObjects.h:347
AgoraRtmHistoryMessage
The details of history message.
Definition: AgoraRtmObjects.h:871
AgoraRtmTopicSubscriptionResponse
Definition: AgoraRtmObjects.h:667
AgoraRtmClientConfig::privateConfig
AgoraRtmPrivateConfig * privateConfig
Definition: AgoraRtmObjects.h:644
AgoraRtmTopicEventType
AgoraRtmTopicEventType
Topic event type.
Definition: AgoraRtmEnumerates.h:869
AgoraRtmChannelInfo
Definition: AgoraRtmObjects.h:210
AgoraRtmLockEventType
AgoraRtmLockEventType
Definition: AgoraRtmEnumerates.h:553
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:754
AgoraRtmLockEvent
Definition: AgoraRtmObjects.h:264
AgoraRtmPresenceEventType
AgoraRtmPresenceEventType
Presence event type.
Definition: AgoraRtmEnumerates.h:891
AgoraRtmMetadata::majorRevision
long long majorRevision
Definition: AgoraRtmObjects.h:132
AgoraRtmGetMetadataResponse
Definition: AgoraRtmObjects.h:679
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:929
AgoraRtmErrorInfo
Definition: AgoraRtmObjects.h:648
AgoraRtmStorageType
AgoraRtmStorageType
Storage type indicate the storage event was triggered by user or channel.
Definition: AgoraRtmEnumerates.h:535
AgoraRtmMetadataOptions
Definition: AgoraRtmObjects.h:86
AgoraRtmStreamChannel
Definition: AgoraRtmClientKit.h:293
AgoraRtmProxyConfig::password
NSString * password
Definition: AgoraRtmObjects.h:367
AgoraRtmStorage
Definition: AgoraRtmClientKit.h:438
AgoraRtmErrorCode
AgoraRtmErrorCode
Definition: AgoraRtmEnumerates.h:78
AgoraRtmSubscribeChannelFeature
AgoraRtmSubscribeChannelFeature
Definition: AgoraRtmEnumerates.h:955
AgoraRtmGetOnlineUsersResponse
Definition: AgoraRtmObjects.h:695
AgoraRtmGetUserChannelsResponse
Definition: AgoraRtmObjects.h:741
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:712
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:762
AgoraRtmLinkStateChangeReason
AgoraRtmLinkStateChangeReason
Definition: AgoraRtmEnumerates.h:665
AgoraRtmTopicOption
Definition: AgoraRtmObjects.h:418
AgoraRtmClientConfig::encryptionConfig
AgoraRtmEncryptionConfig * encryptionConfig
Definition: AgoraRtmObjects.h:639
AgoraRtmProtocolType
AgoraRtmProtocolType
Definition: AgoraRtmEnumerates.h:621
AgoraRtmHistory
Definition: AgoraRtmClientKit.h:782
AgoraRtmChannelType
AgoraRtmChannelType
Definition: AgoraRtmEnumerates.h:1136
AgoraRtmPresence
Definition: AgoraRtmClientKit.h:681
-[AgoraRtmMetadata init]
instancetype _Nullable init()
AgoraRtmGetLocksResponse
Definition: AgoraRtmObjects.h:687
AgoraRtmPresenceIntervalInfo
Definition: AgoraRtmObjects.h:495
AgoraRtmMessageQos
AgoraRtmMessageQos
Definition: AgoraRtmEnumerates.h:1214
AgoraRtmLock
Definition: AgoraRtmClientKit.h:581