Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
(int) | - joinWithOption: |
(int) | - leave |
(NSString *_Nonnull) | - getChannelName |
(int) | - joinTopic:withOption: |
(int) | - publishMessage:inTopic: |
(int) | - leaveTopic: |
(int) | - subscribeTopic:withOption: |
(int) | - unsubscribeTopic:withOption: |
(int) | - destroy |
- (int) joinWithOption: | (AgoraRtmJoinChannelOption *_Nonnull) | option |
join the channel.
[in] | option | join channel options. |
- (int) leave |
leave the channel.
- (NSString * _Nonnull) getChannelName |
return the channel name of this stream channel.
- (int) joinTopic: | (NSString *_Nonnull) | topic | |
withOption: | (AgoraRtmJoinTopicOption *_Nullable) | option | |
join a topic.
[in] | topic | The name of the topic. |
[in] | option | The options of create a topic. |
- (int) publishMessage: | (NSData *_Nonnull) | message | |
inTopic: | (NSString *_Nonnull) | topic | |
publish a message in the topic.
[in] | topic | The name of the topic. |
[in] | message | The content of the message. |
- (int) leaveTopic: | (NSString *_Nonnull) | topic |
leave the topic.
[in] | topic | The name of the topic. |
- (int) subscribeTopic: | (NSString *_Nonnull) | topic | |
withOption: | (AgoraRtmTopicOption *_Nullable) | option | |
unsubscribe a topic.
[in] | topic | The name of the topic. |
- (int) unsubscribeTopic: | (NSString *_Nonnull) | topic | |
withOption: | (AgoraRtmTopicOption *_Nullable) | option | |
unsubscribe a topic.
[in] | topic | The name of the topic. |
- (int) getSubscribedUserList: | (NSMutableArray< NSString * > *_Nonnull) | users | |
inTopic: | (NSString *_Nonnull) | topic | |
- (int) destroy |
release the stream channel instance.