Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
7 #import <Foundation/Foundation.h>
269 @property (nonatomic, nullable) NSData*
meta;
280 @property (nonatomic, copy, nullable) NSArray<NSString *> *users;
290 @property (nonatomic, copy, nullable) NSString *token;
301 @property (nonatomic, copy, nonnull) NSString *channelName;
305 @property (nonatomic, copy, nonnull) NSString *channelTopic;
309 @property (nonatomic, copy, nonnull) NSData *message;
313 @property (nonatomic, copy, nonnull) NSString *publisher;
320 @property (nonatomic, copy, nonnull) NSString *topic;
325 @property (nonatomic, copy, nonnull) NSArray<NSString *> *publisherUserIds;
330 @property (nonatomic, copy, nonnull) NSArray<NSData *> *publisherMetas;
346 @property (nonatomic, copy, nonnull) NSString *channelName;
350 @property (nonatomic, copy, nonnull) NSArray<AgoraRtmTopicInfo *> *topicInfos;
354 @property (nonatomic, copy, nonnull) NSString *userId;
364 @property (nonatomic, copy, nonnull) NSString *appId;
369 @property (nonatomic, copy, nonnull) NSString *userId;
411 onUser:(NSString * _Nonnull)userId
412 joinChannel:(NSString * _Nonnull)channelName
423 onUser:(NSString * _Nonnull)userId
424 leaveChannel:(NSString * _Nonnull)channelName
437 onUser:(NSString * _Nonnull)userId
438 joinTopic:(NSString * _Nonnull)topic
439 inChannel:(NSString * _Nonnull)channelName
440 withMeta:(NSData * _Nullable)meta
453 onUser:(NSString * _Nonnull)userId
454 leaveTopic:(NSString * _Nonnull)topic
455 inChannel:(NSString * _Nonnull)channelName
456 withMeta:(NSData * _Nullable)meta
470 onUser:(NSString * _Nonnull)userId
471 inTopic:(NSString * _Nonnull)topic
472 inChannel:(NSString * _Nonnull)channelName
473 withSubscribeSuccess:(NSArray<NSString *> * _Nonnull)succeedUsers
474 withSubscribeFailed:(NSArray<NSString *> * _Nonnull)failedUsers
488 onUser:(NSString * _Nonnull)userId
489 inTopic:(NSString * _Nonnull)topic
490 inChannel:(NSString * _Nonnull)channelName
491 withUnsubscribeSuccess:(NSArray<NSString *> * _Nonnull)succeedUsers
492 withUnsubscribeFailed:(NSArray<NSString *> * _Nonnull)failedUsers
503 channel:(NSString * _Nonnull)channelName
521 @property (atomic, weak, nullable) id<AgoraRtmClientDelegate> agoraRtmDelegate;
531 delegate:(id <AgoraRtmClientDelegate> _Nullable)delegate;
598 - (int) publishMessage:(NSData * _Nonnull) message
599 inTopic:(NSString * _Nonnull) topic;
609 - (int) leaveTopic:(NSString * _Nonnull)topic;
619 - (int) subscribeTopic:(NSString * _Nonnull)topic withOption:(
AgoraRtmTopicOption * _Nullable)option;
629 - (int) unsubscribeTopic:(NSString * _Nonnull)topic withOption:(
AgoraRtmTopicOption * _Nullable)option;
631 - (int) getSubscribedUserList:(NSMutableArray<NSString *> * _Nonnull)users inTopic:(NSString * _Nonnull)topic;
@ AgoraRtmClientConnectionChangedInvalidToken
Definition: AgoraRtmClientKit.h:129
@ AgoraRtmClientConnectionChangedRejectedByServer
Definition: AgoraRtmClientKit.h:137
@ AgoraRtmChannelTypeStream
Definition: AgoraRtmClientKit.h:192
NSData * meta
Definition: AgoraRtmClientKit.h:269
@ AgoraRtmClientConnectionChangedEchoTest
Definition: AgoraRtmClientKit.h:166
@ AgoraRtmClientConnectionChangedBannedByServer
Definition: AgoraRtmClientKit.h:109
@ AgoraRtmPresenceTypeRemoteConnectionTimeout
Definition: AgoraRtmClientKit.h:210
NSString *_Nonnull getChannelName()
AgoraRtmStreamChannelErrorCode
Definition: AgoraRtmClientKit.h:228
Definition: AgoraRtmClientKit.h:372
AgoraRtmPresenceType
Definition: AgoraRtmClientKit.h:198
@ AgoraRtmClientConnectionChangedTokenExpired
Definition: AgoraRtmClientKit.h:133
@ AgoraRtmPresenceTypeSelfJoinChannel
Definition: AgoraRtmClientKit.h:222
Definition: AgoraRtmClientKit.h:287
@ AgoraRtmClientErrPublishTopicFailed
Definition: AgoraRtmClientKit.h:38
@ AgoraRtmClientConnectionChangedSameUidLogin
Definition: AgoraRtmClientKit.h:174
@ AgoraRtmClientConnectionStateFailed
Definition: AgoraRtmClientKit.h:86
@ AgoraRtmClientConnectionChangedRejoinSuccess
Definition: AgoraRtmClientKit.h:158
@ AgoraRtmPresenceTypeRemoteJoinChannel
Definition: AgoraRtmClientKit.h:202
@ AgoraRtmClientErrNotJoinChannel
Definition: AgoraRtmClientKit.h:58
@ AgoraRtmClientConnectionChangedJoinFailed
Definition: AgoraRtmClientKit.h:113
Definition: AgoraRtmClientKit.h:520
@ AgoraRtmClientConnectionChangedKeepAliveTimeout
Definition: AgoraRtmClientKit.h:154
AgoraRtmClientErrorCode
Definition: AgoraRtmClientKit.h:22
AgoraRtmMessageQos
Definition: AgoraRtmClientKit.h:246
AgoraRtmMessageQos qos
Definition: AgoraRtmClientKit.h:264
@ AgoraRtmPresenceTypeRemoteLeaveChannel
Definition: AgoraRtmClientKit.h:206
@ AgoraRtmClientConnectionStateDisconnected
Definition: AgoraRtmClientKit.h:68
@ AgoraRtmChannelTypeMessage
Definition: AgoraRtmClientKit.h:188
@ AgoraRtmClientErrInvalidTopicName
Definition: AgoraRtmClientKit.h:34
@ AgoraRtmPresenceTypeRemoteJoinTopic
Definition: AgoraRtmClientKit.h:214
@ AgoraRtmClientConnectionChangedSettingProxyServer
Definition: AgoraRtmClientKit.h:141
@ AgoraRtmClientConnectionChangedLeaveChannel
Definition: AgoraRtmClientKit.h:117
@ AgoraRtmClientErrExceedCreateTopicLimitation
Definition: AgoraRtmClientKit.h:30
@ AgoraRtmClientConnectionChangedChangedLost
Definition: AgoraRtmClientKit.h:162
Definition: AgoraRtmClientKit.h:361
@ AgoraRtmClientConnectionStateConnecting
Definition: AgoraRtmClientKit.h:72
@ AgoraRtmClientErrTopicAlreadyExist
Definition: AgoraRtmClientKit.h:26
Definition: AgoraRtmClientKit.h:317
@ AgoraRtmClientErrExceedUserLimitation
Definition: AgoraRtmClientKit.h:46
@ AgoraRtmClientConnectionStateConnected
Definition: AgoraRtmClientKit.h:77
@ AgoraRtmClientConnectionChangedTooManyBroadcasters
Definition: AgoraRtmClientKit.h:178
@ AgoraRtmClientConnectionChangedClientIpAddressChangedByUser
Definition: AgoraRtmClientKit.h:170
@ AgoraRtmClientErrExceedChannelLimitation
Definition: AgoraRtmClientKit.h:50
@ AgoraRtmStreamChannelErrorOk
Definition: AgoraRtmClientKit.h:232
Definition: AgoraRtmClientKit.h:261
@ AgoraRtmPresenceTypeRemoteLeaveTopic
Definition: AgoraRtmClientKit.h:218
Definition: AgoraRtmClientKit.h:294
AgoraRtmClientConnectionChangeReason
Definition: AgoraRtmClientKit.h:93
@ AgoraRtmMessageQosOrdered
Definition: AgoraRtmClientKit.h:254
Definition: AgoraRtmClientKit.h:552
@ AgoraRtmClientConnectionChangedJoinSuccess
Definition: AgoraRtmClientKit.h:101
@ AgoraRtmClientConnectionChangedClientIpAddressChanged
Definition: AgoraRtmClientKit.h:150
AgoraRtmClientConnectionState
Definition: AgoraRtmClientKit.h:64
AgoraRtmChannelType
Definition: AgoraRtmClientKit.h:184
@ AgoraRtmClientConnectionChangedRenewToken
Definition: AgoraRtmClientKit.h:145
@ AgoraRtmClientConnectionStateReconnecting
Definition: AgoraRtmClientKit.h:82
Definition: AgoraRtmClientKit.h:335
@ AgoraRtmClientConnectionChangedConnecting
Definition: AgoraRtmClientKit.h:97
@ AgoraRtmStreamChannelErrorUserNotExist
Definition: AgoraRtmClientKit.h:240
@ AgoraRtmStreamChannelErroExceedLimitation
Definition: AgoraRtmClientKit.h:236
@ AgoraRtmClientErrAlreadyJoinChannel
Definition: AgoraRtmClientKit.h:54
@ AgoraRtmClientConnectionChangedInvalidAppId
Definition: AgoraRtmClientKit.h:121
Definition: AgoraRtmClientKit.h:277
@ AgoraRtmClientConnectionChangedInterrupted
Definition: AgoraRtmClientKit.h:105
@ AgoraRtmClientConnectionChangedInvalidChannelName
Definition: AgoraRtmClientKit.h:125
@ AgoraRtmMessageQosUnordered
Definition: AgoraRtmClientKit.h:250
@ AgoraRtmClientErrExceedSubscribeTopicLimitation
Definition: AgoraRtmClientKit.h:42