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 AgoraRtmTokenEvent;
32 @class AgoraRtmLogConfig;
33 @class AgoraRtmProxyConfig;
34 @class AgoraRtmEncryptionConfig;
35 @class AgoraRtmPresenceIntervalInfo;
36 @class AgoraRtmErrorInfo;
37 @class AgoraRtmTopicSubscriptionResponse;
38 @class AgoraRtmLoginErrorInfo;
39 @class AgoraRtmGetMetadataResponse;
40 @class AgoraRtmGetLocksResponse;
41 @class AgoraRtmWhoNowResponse;
42 @class AgoraRtmGetOnlineUsersResponse;
43 @class AgoraRtmWhereNowResponse;
44 @class AgoraRtmGetUserChannelsResponse;
45 @class AgoraRtmPresenceGetStateResponse;
46 @class AgoraRtmGetTopicSubscribedUsersResponse;
47 @class AgoraRtmMessage;
48 @class AgoraRtmPrivateConfig;
49 @class AgoraRtmLinkStateEvent;
50 @class AgoraRtmHistory;
51 @class AgoraRtmGetHistoryMessagesOptions;
52 @class AgoraRtmHistoryMessage;
53 @class AgoraRtmGetHistoryMessagesResponse;
54 @class AgoraRtmAffectedResources;
55
56 __attribute__((visibility("default"))) @interface AgoraRtmPublishOptions: NSObject
60 @property (nonatomic, assign) AgoraRtmChannelType channelType;
61
65 @property (nonatomic, copy, nonnull) NSString* customType;
66
70 @property (nonatomic, assign) BOOL storeInHistory;
71 @end
72
73
74 __attribute__((visibility("default"))) @interface AgoraRtmTopicMessageOptions: NSObject
78 @property (nonatomic, copy, nonnull) NSString* customType;
79
84 @property (nonatomic, assign) unsigned long long sendTs;
85 @end
86
87 __attribute__((visibility("default"))) @interface AgoraRtmMetadataOptions: NSObject
88
92 @property (nonatomic, assign) BOOL recordTs;
93
97 @property (nonatomic, assign) BOOL recordUserId;
98 @end
99
100 __attribute__((visibility("default"))) @interface AgoraRtmMetadataItem: NSObject
101
105 @property (nonatomic, copy, nonnull) NSString* key;
106
110 @property (nonatomic, copy, nonnull) NSString* value;
111
115 @property (nonatomic, copy, nonnull) NSString* authorUserId;
116
120 @property (nonatomic, assign) long long revision;
121
125 @property (nonatomic, assign) unsigned long long updateTs;
126 @end
127
128 __attribute__((visibility("default"))) @interface AgoraRtmMetadata: NSObject
129
130 - (instancetype _Nullable)init;
134 @property (nonatomic, assign) long long majorRevision;
135
139 @property (nonatomic, copy, nullable) NSArray<AgoraRtmMetadataItem *> *items;
140 @end
141
142 __attribute__((visibility("default"))) @interface AgoraRtmLockDetail: NSObject
146 @property (nonatomic, copy, nonnull) NSString* lockName;
147
151 @property (nonatomic, copy, nonnull) NSString* owner;
152
156 @property (nonatomic, assign) int ttl;
157
161 @property (nonatomic, assign) unsigned long long timestamp;
162 @end
163
164 __attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersOptions: NSObject
168 @property (nonatomic, assign) BOOL includeUserId;
169
173 @property (nonatomic, assign) BOOL includeState;
174
178 @property (nonatomic, copy, nonnull) NSString* page;
179 @end
180
181 __attribute__((visibility("default"))) @interface AgoraRtmPresenceOptions: NSObject
185 @property (nonatomic, assign) BOOL includeUserId;
186
190 @property (nonatomic, assign) BOOL includeState;
191
195 @property (nonatomic, copy, nonnull) NSString* page;
196 @end
197
198 __attribute__((visibility("default"))) @interface AgoraRtmUserState: NSObject
199
203 @property (nonatomic, copy, nonnull) NSString* userId;
204
208 @property (nonatomic, copy, nonnull) NSDictionary<NSString *, NSString *> * states;
209 @end
210
211 __attribute__((visibility("default"))) @interface AgoraRtmChannelInfo: NSObject
212
216 @property (nonatomic, copy, nonnull) NSString* channelName;
217
221 @property (nonatomic, assign) AgoraRtmChannelType channelType;
222 @end
223
224
225 __attribute__((visibility("default"))) @interface AgoraRtmTopicEvent: NSObject
226
230 @property (nonatomic, assign) AgoraRtmTopicEventType type;
231
235 @property (nonatomic, copy, nonnull) NSString* channelName;
236
240 @property (nonatomic, copy, nonnull) NSString* publisher;
241
245 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmTopicInfo *> *topicInfos;
246
250 @property (nonatomic, assign) unsigned long long timestamp;
251 @end
252
253 __attribute__((visibility("default"))) @interface AgoraRtmPublisherInfo: NSObject
257 @property (nonatomic, copy, nonnull) NSString* publisherUserId;
258
262 @property (nonatomic, copy, nullable) NSString* publisherMeta;
263 @end
264
265 __attribute__((visibility("default"))) @interface AgoraRtmLockEvent: NSObject
269 @property (nonatomic, assign) AgoraRtmChannelType channelType;
270
274 @property (nonatomic, assign) AgoraRtmLockEventType eventType;
275
279 @property (nonatomic, copy, nonnull) NSString* channelName;
283 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmLockDetail *> * lockDetailList;
284
288 @property (nonatomic, assign) unsigned long long timestamp;
289 @end
290
291 __attribute__((visibility("default"))) @interface AgoraRtmStorageEvent: NSObject
292
296 @property (nonatomic, assign) AgoraRtmChannelType channelType;
297
301 @property (nonatomic, assign) AgoraRtmStorageType storageType;
302
306 @property (nonatomic, assign) AgoraRtmStorageEventType eventType;
307
311 @property (nonatomic, copy, nonnull) NSString* target;
312
316 @property (nonatomic, strong, nonnull) AgoraRtmMetadata* data;
317
321 @property (nonatomic, assign) unsigned long long timestamp;
322 @end
323
324 __attribute__((visibility("default"))) @interface AgoraRtmLogConfig: NSObject <NSCopying>
328 @property (nonatomic, copy, nullable) NSString* filePath;
332 @property (nonatomic, assign) int fileSizeInKB;
336 @property (nonatomic, assign) AgoraRtmLogLevel level;
337 @end
338
339 __attribute__((visibility("default"))) @interface AgoraRtmProxyConfig: NSObject <NSCopying>
340
341 - (instancetype _Nullable)init NS_UNAVAILABLE;
342
343 - (instancetype _Nonnull) initWithServer:(NSString * _Nonnull)server
344 port:(unsigned short)port
345 proxyType:(AgoraRtmProxyType)proxyType;
349 @property (nonatomic, assign) AgoraRtmProxyType proxyType;
350
354 @property (nonatomic, copy, nonnull) NSString* server;
355
359 @property (nonatomic, assign) unsigned short port;
360
364 @property (nonatomic, copy, nullable) NSString* account;
365
369 @property (nonatomic, copy, nullable) NSString* password;
370 @end
371
372 __attribute__((visibility("default"))) @interface AgoraRtmEncryptionConfig: NSObject <NSCopying>
373
377 @property (nonatomic, assign) AgoraRtmEncryptionMode encryptionMode;
378
382 @property (copy, nonatomic ,nullable) NSString * encryptionKey;
383
387 @property (strong, nonatomic, nullable) NSData * encryptionSalt;
388 @end
389
393 __attribute__((visibility("default"))) @interface AgoraRtmJoinTopicOption: NSObject
397 @property (nonatomic, assign) AgoraRtmMessageQos qos;
398
402 @property (nonatomic, nullable) NSString* meta;
403
407 @property (nonatomic, assign) AgoraRtmMessagePriority priority;
408
412 @property (nonatomic, assign) BOOL syncWithMedia;
413
414 @end
415
419 __attribute__((visibility("default"))) @interface AgoraRtmTopicOption: NSObject
423 @property (nonatomic, copy, nullable) NSArray<NSString *> *users;
424 @end
425
429 __attribute__((visibility("default"))) @interface AgoraRtmJoinChannelOption: NSObject
433 @property (nonatomic, copy, nullable) NSString *token;
434
438 @property (nonatomic, assign) AgoraRtmJoinChannelFeature features;
439
440 @end
441
442 __attribute__((visibility("default"))) @interface AgoraRtmMessageEvent: NSObject
443
447 @property (nonatomic, assign) AgoraRtmChannelType channelType;
451 @property (nonatomic, copy, nonnull) NSString *channelName;
455 @property (nonatomic, copy, nonnull) NSString *channelTopic;
459 @property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
463 @property (nonatomic, copy, nonnull) NSString *publisher;
467 @property (nonatomic, copy, nullable) NSString *customType;
471 @property (nonatomic, assign) unsigned long long timestamp;
472 @end
473
474 __attribute__((visibility("default"))) @interface AgoraRtmTopicInfo: NSObject
478 @property (nonatomic, copy, nonnull) NSString *topic;
479
483 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmPublisherInfo *> *publishers;
484
485 @end
486
487 __attribute__((visibility("default"))) @interface AgoraRtmSubscribeOptions: NSObject
488
492 @property (nonatomic, assign) AgoraRtmSubscribeChannelFeature features;
493
494 @end
495
496 __attribute__((visibility("default"))) @interface AgoraRtmPresenceIntervalInfo: NSObject
497
501 @property (nonatomic, copy, nonnull) NSArray<NSString *> *joinUserList;
502
506 @property (nonatomic, copy, nonnull) NSArray<NSString *> *leaveUserList;
507
511 @property (nonatomic, copy, nonnull) NSArray<NSString *> *timeoutUserList;
512
516 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
517 @end
518
519
520 __attribute__((visibility("default"))) @interface AgoraRtmPresenceEvent: NSObject
524 @property (nonatomic, assign) AgoraRtmPresenceEventType type;
528 @property (nonatomic, assign) AgoraRtmChannelType channelType;
529
533 @property (nonatomic, copy, nonnull) NSString * channelName;
534
538 @property (nonatomic, copy, nullable) NSString * publisher;
539
543 @property (nonatomic, copy, nonnull) NSDictionary<NSString *, NSString *> * states;
544
548 @property (nonatomic, copy, nullable) AgoraRtmPresenceIntervalInfo* interval;
549
553 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> * snapshot;
554
558 @property (nonatomic, assign) unsigned long long timestamp;
559 @end
560
561 __attribute__((visibility("default"))) @interface AgoraRtmTokenEvent: NSObject
565 @property (nonatomic, assign) AgoraRtmTokenEventTokenType eventType;
566
570 @property (nonatomic, copy, nonnull) NSString * reason;
571
575 @property (nonatomic, copy, nonnull) AgoraRtmAffectedResources * affectedResources;
576
580 @property (nonatomic, assign) unsigned long long timestamp;
581 @end
582
583 __attribute__((visibility("default"))) @interface AgoraRtmAffectedResources: NSObject
584
588 @property (nonatomic, copy, nonnull) NSArray<NSString *> * messageChannels;
589 @end
590
594 __attribute__((visibility("default"))) @interface AgoraRtmClientConfig: NSObject
595
596 - (instancetype _Nullable)init NS_UNAVAILABLE;
600 - (instancetype _Nonnull) initWithAppId:(NSString * _Nonnull)appId
601 userId:(NSString * _Nonnull)userId;
611 @property (nonatomic, assign) AgoraRtmAreaCode areaCode;
612
616 @property (nonatomic, assign) AgoraRtmProtocolType protocolType;
617
622 @property (nonatomic, assign) unsigned int presenceTimeout;
623
628 @property (nonatomic, assign) unsigned int heartbeatInterval;
629
633 @property (nonatomic, assign) unsigned int reconnectTimeout;
634
638 @property (nonatomic, copy, nonnull) NSString *appId;
639
643 @property (nonatomic, copy, nonnull) NSString *userId;
644
649 @property (nonatomic, assign) BOOL useStringUserId;
650
654 @property (nonatomic, assign) BOOL multipath;
655
661 @property (nonatomic, assign) BOOL ispPolicyEnabled;
662
666 @property (nonatomic, copy, nullable) AgoraRtmLogConfig * logConfig;
667
671 @property (nonatomic, copy, nullable) AgoraRtmProxyConfig * proxyConfig;
672
676 @property (nonatomic, copy, nullable) AgoraRtmEncryptionConfig * encryptionConfig;
677
681 @property (nonatomic, copy, nullable) AgoraRtmPrivateConfig * privateConfig;
682
688 @property (nonatomic, strong, nullable) dispatch_queue_t callbackQueue;
689 @end
690
691 __attribute__((visibility("default"))) @interface AgoraRtmErrorInfo: NSError
692
693 /*
694 *Error code of operation. see enum class AgoraRtmOperationErrorCode for detail
695 */
696 @property (nonatomic, assign) AgoraRtmErrorCode errorCode;
697
701 @property (nonatomic, copy, nonnull) NSString *operation;
702
706 @property (nonatomic, copy, nonnull) NSString *reason;
707 @end
708
709
710 __attribute__((visibility("default"))) @interface AgoraRtmTopicSubscriptionResponse: NSObject
714 @property (nonatomic, copy, nonnull) NSArray<NSString *> *succeedUsers;
715
719 @property (nonatomic, copy, nonnull) NSArray<NSString *> *failedUsers;
720 @end
721
722 __attribute__((visibility("default"))) @interface AgoraRtmGetMetadataResponse: NSObject
723
727 @property (nonatomic, strong, nullable) AgoraRtmMetadata* data;
728 @end
729
730 __attribute__((visibility("default"))) @interface AgoraRtmGetLocksResponse: NSObject
734 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmLockDetail *> * lockDetailList;
735 @end
736
737
738 __attribute__((visibility("default"))) @interface AgoraRtmGetOnlineUsersResponse: NSObject
742 @property (nonatomic, assign) int totalOccupancy;
746 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
747
751 @property (nonatomic, copy, nullable) NSString *nextPage;
752 @end
753
754
755 __attribute__((visibility("default"))) @interface AgoraRtmWhoNowResponse: NSObject
759 @property (nonatomic, assign) int totalOccupancy;
763 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmUserState *> *userStateList;
764
768 @property (nonatomic, copy, nullable) NSString *nextPage;
769 @end
770
771 __attribute__((visibility("default"))) @interface AgoraRtmWhereNowResponse: NSObject
772
776 @property (nonatomic, assign) int totalChannel;
777
781 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
782 @end
783
784 __attribute__((visibility("default"))) @interface AgoraRtmGetUserChannelsResponse: NSObject
785
789 @property (nonatomic, assign) int totalChannel;
790
794 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmChannelInfo *> * channels;
795 @end
796
797 __attribute__((visibility("default"))) @interface AgoraRtmPresenceGetStateResponse: NSObject
798
802 @property (nonatomic, strong, nonnull) AgoraRtmUserState * state;
803 @end
804
805 __attribute__((visibility("default"))) @interface AgoraRtmCommonResponse: NSObject
806 @end
807
808
809 __attribute__((visibility("default"))) @interface AgoraRtmMessage: NSObject <NSCopying>
810
814 @property (nonatomic, copy, nullable) NSData* rawData;
815
819 @property (nonatomic, copy, nullable) NSString* stringData;
820
821 @end
822
823 __attribute__((visibility("default"))) @interface AgoraRtmGetTopicSubscribedUsersResponse: NSObject
827 @property (nonatomic, copy, nonnull) NSArray<NSString *> *users;
828 @end
829
830 __attribute__((visibility("default"))) @interface AgoraRtmPrivateConfig: NSObject
834 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
835
839 @property (nonatomic, copy, nonnull) NSArray<NSString *> *accessPointHosts;
840 @end
841
842 __attribute__((visibility("default"))) @interface AgoraRtmLinkStateEvent: NSObject
846 @property (nonatomic, assign) AgoraRtmLinkState currentState;
847
851 @property (nonatomic, assign) AgoraRtmLinkState previousState;
852
856 @property (nonatomic, assign) AgoraRtmServiceType serviceType;
857
861 @property (nonatomic, assign) AgoraRtmLinkOperation operation;
862
866 @property (nonatomic, assign) AgoraRtmLinkStateChangeReason reasonCode;
867
871 @property (nonatomic, copy, nullable) NSString* reason;
872
876 @property (nonatomic, copy, nonnull) NSArray<NSString *> * affectedChannels;
877
881 @property (nonatomic, copy, nonnull) NSArray<NSString *> * unrestoredChannels;
882
886 @property (nonatomic, assign) BOOL isResumed;
887
891 @property (nonatomic, assign) unsigned long long timestamp;
892 @end
893
897 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesOptions: NSObject
901 @property (nonatomic, assign) int messageCount;
905 @property (nonatomic, assign) unsigned long long start;
909 @property (nonatomic, assign) unsigned long long end;
910 @end
911
915 __attribute__((visibility("default"))) @interface AgoraRtmHistoryMessage : NSObject <NSCopying>
919 @property (nonatomic, copy, nonnull) AgoraRtmMessage *message;
923 @property (nonatomic, copy, nonnull) NSString *publisher;
927 @property (nonatomic, copy, nullable) NSString *customType;
931 @property (nonatomic, assign) unsigned long long timestamp;
932 @end
933
934 __attribute__((visibility("default"))) @interface AgoraRtmGetHistoryMessagesResponse : NSObject
935
939 @property (nonatomic, copy, nonnull) NSArray <AgoraRtmHistoryMessage *> *messageList;
940
944 @property (nonatomic, assign) unsigned long long newStart;
945 @end
946
947
948
949 typedef void (^AgoraRtmTopicSubscriptionBlock)(AgoraRtmTopicSubscriptionResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
950
951 typedef void (^AgoraRtmOperationBlock)(AgoraRtmCommonResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
952
953 typedef void (^AgoraRtmGetMetadataBlock)(AgoraRtmGetMetadataResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
954
955 typedef void (^AgoraRtmGetLocksBlock)(AgoraRtmGetLocksResponse * _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
956
957 typedef void (^AgoraRtmWhoNowBlock)(AgoraRtmWhoNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
958
959 typedef void (^AgoraRtmWhereNowBlock)(AgoraRtmWhereNowResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
960
961 typedef void (^AgoraRtmGetOnlineUsersBlock)(AgoraRtmGetOnlineUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
962
963 typedef void (^AgoraRtmGetUserChannelsBlock)(AgoraRtmGetUserChannelsResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
964
965 typedef void (^AgoraRtmPresenceGetStateBlock)(AgoraRtmPresenceGetStateResponse* _Nullable response, AgoraRtmErrorInfo* _Nullable errorInfo);
966
967 typedef void (^AgoraRtmGetTopicSubscribedUsersBlock)(AgoraRtmGetTopicSubscribedUsersResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
968
969 typedef void (^AgoraRtmGetHistoryMessagesBlock)(AgoraRtmGetHistoryMessagesResponse* _Nullable response, AgoraRtmErrorInfo* _Nonnull errorInfo);
AgoraRtmPublishOptions::customType
NSString * customType
Definition: AgoraRtmObjects.h:65
AgoraRtmGetHistoryMessagesOptions
The option to query history message.
Definition: AgoraRtmObjects.h:898
AgoraRtmStorageEvent
Definition: AgoraRtmObjects.h:292
AgoraRtmGetOnlineUsersOptions
Definition: AgoraRtmObjects.h:165
AgoraRtmLinkStateEvent
Definition: AgoraRtmObjects.h:843
AgoraRtmClientConfig::callbackQueue
dispatch_queue_t callbackQueue
Definition: AgoraRtmObjects.h:688
AgoraRtmClientConfig::logConfig
AgoraRtmLogConfig * logConfig
Definition: AgoraRtmObjects.h:666
AgoraRtmClientConfig::appId
NSString * appId
Definition: AgoraRtmObjects.h:638
AgoraRtmProxyType
AgoraRtmProxyType
Definition: AgoraRtmEnumerates.h:618
AgoraRtmClientConfig::proxyConfig
AgoraRtmProxyConfig * proxyConfig
Definition: AgoraRtmObjects.h:671
AgoraRtmUserState
Definition: AgoraRtmObjects.h:199
AgoraRtmProxyConfig::server
NSString * server
Definition: AgoraRtmObjects.h:354
AgoraRtmClientConfig::useStringUserId
BOOL useStringUserId
Definition: AgoraRtmObjects.h:649
-[AgoraRtmProxyConfig NS_UNAVAILABLE]
instancetype _Nullable NS_UNAVAILABLE()
AgoraRtmStorageEventType
AgoraRtmStorageEventType
Definition: AgoraRtmEnumerates.h:1188
AgoraRtmTokenEventTokenType
AgoraRtmTokenEventTokenType
Definition: AgoraRtmEnumerates.h:40
AgoraRtmGetTopicSubscribedUsersResponse
Definition: AgoraRtmObjects.h:824
AgoraRtmPublishOptions::channelType
AgoraRtmChannelType channelType
Definition: AgoraRtmObjects.h:60
AgoraRtmLockDetail
Definition: AgoraRtmObjects.h:143
AgoraRtmServiceType
AgoraRtmServiceType
Definition: AgoraRtmEnumerates.h:633
AgoraRtmEncryptionConfig
Definition: AgoraRtmObjects.h:372
AgoraRtmGetHistoryMessagesResponse
Definition: AgoraRtmObjects.h:935
AgoraRtmMessage
Definition: AgoraRtmObjects.h:809
AgoraRtmAreaCode
AgoraRtmAreaCode
Definition: AgoraRtmEnumerates.h:6
AgoraRtmLogConfig
Definition: AgoraRtmObjects.h:324
AgoraRtmJoinChannelOption
Definition: AgoraRtmObjects.h:430
AgoraRtmPublishOptions
Definition: AgoraRtmObjects.h:57
AgoraRtmMetadata::items
NSArray< AgoraRtmMetadataItem * > * items
Definition: AgoraRtmObjects.h:139
AgoraRtmLinkOperation
AgoraRtmLinkOperation
Definition: AgoraRtmEnumerates.h:853
AgoraRtmPrivateConfig
Definition: AgoraRtmObjects.h:831
AgoraRtmPublisherInfo
Definition: AgoraRtmObjects.h:254
AgoraRtmClientConfig::ispPolicyEnabled
BOOL ispPolicyEnabled
Definition: AgoraRtmObjects.h:661
AgoraRtmLinkState
AgoraRtmLinkState
Definition: AgoraRtmEnumerates.h:665
AgoraRtmClientConfig::presenceTimeout
unsigned int presenceTimeout
Definition: AgoraRtmObjects.h:622
AgoraRtmPublishOptions::storeInHistory
BOOL storeInHistory
Definition: AgoraRtmObjects.h:70
AgoraRtmMetadata
Definition: AgoraRtmObjects.h:129
AgoraRtmWhereNowResponse
Definition: AgoraRtmObjects.h:772
AgoraRtmClientKit
Definition: AgoraRtmClientKit.h:107
AgoraRtmProxyConfig::account
NSString * account
Definition: AgoraRtmObjects.h:364
AgoraRtmLogLevel
AgoraRtmLogLevel
Definition: AgoraRtmEnumerates.h:1255
AgoraRtmProxyConfig
Definition: AgoraRtmObjects.h:339
AgoraRtmProxyConfig::proxyType
AgoraRtmProxyType proxyType
Definition: AgoraRtmObjects.h:349
AgoraRtmHistoryMessage
The details of history message.
Definition: AgoraRtmObjects.h:915
AgoraRtmTopicSubscriptionResponse
Definition: AgoraRtmObjects.h:711
AgoraRtmClientConfig::privateConfig
AgoraRtmPrivateConfig * privateConfig
Definition: AgoraRtmObjects.h:681
AgoraRtmTopicEventType
AgoraRtmTopicEventType
Topic event type.
Definition: AgoraRtmEnumerates.h:899
AgoraRtmAffectedResources
Definition: AgoraRtmObjects.h:584
AgoraRtmChannelInfo
Definition: AgoraRtmObjects.h:212
AgoraRtmLockEventType
AgoraRtmLockEventType
Definition: AgoraRtmEnumerates.h:583
AgoraRtmTopicEvent
Definition: AgoraRtmObjects.h:226
AgoraRtmTopicMessageOptions
Definition: AgoraRtmObjects.h:75
AgoraRtmClientConfig
Definition: AgoraRtmObjects.h:595
AgoraRtmEncryptionMode
AgoraRtmEncryptionMode
Definition: AgoraRtmEnumerates.h:54
AgoraRtmTopicInfo
Definition: AgoraRtmObjects.h:475
AgoraRtmPresenceGetStateResponse
Definition: AgoraRtmObjects.h:798
AgoraRtmLockEvent
Definition: AgoraRtmObjects.h:266
AgoraRtmPresenceEventType
AgoraRtmPresenceEventType
Presence event type.
Definition: AgoraRtmEnumerates.h:921
AgoraRtmMetadata::majorRevision
long long majorRevision
Definition: AgoraRtmObjects.h:134
AgoraRtmGetMetadataResponse
Definition: AgoraRtmObjects.h:723
AgoraRtmJoinTopicOption
Definition: AgoraRtmObjects.h:394
AgoraRtmClientConfig::areaCode
AgoraRtmAreaCode areaCode
Definition: AgoraRtmObjects.h:611
AgoraRtmMessageEvent
Definition: AgoraRtmObjects.h:443
AgoraRtmMessagePriority
AgoraRtmMessagePriority
Definition: AgoraRtmEnumerates.h:69
AgoraRtmClientConfig::reconnectTimeout
unsigned int reconnectTimeout
Definition: AgoraRtmObjects.h:633
AgoraRtmClientConfig::userId
NSString * userId
Definition: AgoraRtmObjects.h:643
AgoraRtmJoinChannelFeature
AgoraRtmJoinChannelFeature
Definition: AgoraRtmEnumerates.h:959
AgoraRtmErrorInfo
Definition: AgoraRtmObjects.h:692
AgoraRtmStorageType
AgoraRtmStorageType
Storage type indicate the storage event was triggered by user or channel.
Definition: AgoraRtmEnumerates.h:565
AgoraRtmMetadataOptions
Definition: AgoraRtmObjects.h:88
AgoraRtmStreamChannel
Definition: AgoraRtmClientKit.h:301
AgoraRtmProxyConfig::password
NSString * password
Definition: AgoraRtmObjects.h:369
AgoraRtmTokenEvent
Definition: AgoraRtmObjects.h:562
AgoraRtmStorage
Definition: AgoraRtmClientKit.h:446
AgoraRtmErrorCode
AgoraRtmErrorCode
Definition: AgoraRtmEnumerates.h:92
AgoraRtmSubscribeChannelFeature
AgoraRtmSubscribeChannelFeature
Definition: AgoraRtmEnumerates.h:985
AgoraRtmGetOnlineUsersResponse
Definition: AgoraRtmObjects.h:739
AgoraRtmGetUserChannelsResponse
Definition: AgoraRtmObjects.h:785
AgoraRtmClientConfig::multipath
BOOL multipath
Definition: AgoraRtmObjects.h:654
AgoraRtmPresenceEvent
Definition: AgoraRtmObjects.h:521
AgoraRtmProxyConfig::port
unsigned short port
Definition: AgoraRtmObjects.h:359
AgoraRtmWhoNowResponse
Definition: AgoraRtmObjects.h:756
AgoraRtmMetadataItem
Definition: AgoraRtmObjects.h:101
AgoraRtmEnumerates.h
-[AgoraRtmClientConfig NS_UNAVAILABLE]
instancetype _Nullable NS_UNAVAILABLE()
AgoraRtmClientConfig::heartbeatInterval
unsigned int heartbeatInterval
Definition: AgoraRtmObjects.h:628
AgoraRtmClientConfig::protocolType
AgoraRtmProtocolType protocolType
Definition: AgoraRtmObjects.h:616
AgoraRtmSubscribeOptions
Definition: AgoraRtmObjects.h:488
AgoraRtmPresenceOptions
Definition: AgoraRtmObjects.h:182
AgoraRtmCommonResponse
Definition: AgoraRtmObjects.h:806
AgoraRtmLinkStateChangeReason
AgoraRtmLinkStateChangeReason
Definition: AgoraRtmEnumerates.h:695
AgoraRtmTopicOption
Definition: AgoraRtmObjects.h:420
AgoraRtmClientConfig::encryptionConfig
AgoraRtmEncryptionConfig * encryptionConfig
Definition: AgoraRtmObjects.h:676
AgoraRtmProtocolType
AgoraRtmProtocolType
Definition: AgoraRtmEnumerates.h:651
AgoraRtmHistory
Definition: AgoraRtmClientKit.h:790
AgoraRtmChannelType
AgoraRtmChannelType
Definition: AgoraRtmEnumerates.h:1166
AgoraRtmPresence
Definition: AgoraRtmClientKit.h:689
-[AgoraRtmMetadata init]
instancetype _Nullable init()
AgoraRtmGetLocksResponse
Definition: AgoraRtmObjects.h:731
AgoraRtmPresenceIntervalInfo
Definition: AgoraRtmObjects.h:497
AgoraRtmMessageQos
AgoraRtmMessageQos
Definition: AgoraRtmEnumerates.h:1244
AgoraRtmLock
Definition: AgoraRtmClientKit.h:589