Agora RTC Objective-C API Reference  Refactor
IAgoraRtmService.h
Go to the documentation of this file.
1 //
2 // Agora Rtm SDK
3 //
4 // Created by junhao Wang in 2018-05.
5 // Copyright (c) 2018 Agora IO. All rights reserved.
6 //
7 #pragma once
8 
9 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
10 #include <cstdint>
11 #endif
12 
13 namespace agora {
14 
15 namespace rtm {
16 
23 };
40  LOGIN_ERR_REJECTED = 2, // ALREADY LOGIN OR NOT INITIALIZED, SERVER REJECT
65 };
78 };
98 };
99 
113 };
122 
127 
131  JOIN_CHANNEL_ERR_REJECTED = 2, // Usually occurs when the user is already in the channel
132 
137 
142 
147 
152 
157 
162 
167 
172 };
177 
182 
187 
192 
197 
202 
207 };
208 
221 };
226 
231 
236 
241 
246 
251 
256 
261 };
262 
272 };
293 };
297 class IMessage {
298  public:
309  virtual ~IMessage() {}
314  virtual int64_t getMessageId() const = 0;
321  virtual int getMessageType() const = 0;
327  virtual void setText(const char *str) = 0;
333  virtual const char *getText() const = 0;
339  virtual const unsigned char *getRawMessageData() const = 0;
345  virtual int getRawMessageLength() const = 0;
349  virtual void setMessageType(int32_t type) = 0;
353  virtual void setRawMessage(const uint8_t* data, int length) = 0;
357  virtual void release() = 0;
358 };
359 
364  public:
365  virtual ~IChannelMember() {}
370  virtual const char *getMemberId() const = 0;
375  virtual const char *getChannelId() const = 0;
379  virtual void release() = 0;
380 };
385  public:
401  virtual int addAttribute(const char *key, const char *value) = 0;
409  virtual int removeAttribute(const char *key) = 0;
416  virtual int getAttributesSize() const = 0;
423  virtual void getAttributes(int size, char **key,
424  char **value) const = 0; // todo: discussion, how to traveral
429  virtual const char *getAttributeValue(const char *key) const = 0;
436  virtual int release() = 0;
437 };
442  public:
447  virtual void onJoinSuccess() {}
452  virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode) {}
457  virtual void onLeave(LEAVE_CHANNEL_ERR errorCode) {}
462  virtual void onMessageReceived(const char *userId, const IMessage *message) {}
468  virtual void onSendMessageState(int64_t messageId, CHANNEL_MESSAGE_STATE state) {}
475  virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state) {}
480  virtual void onMemberJoined(IChannelMember *member) {}
485  virtual void onMemberLeft(IChannelMember *member) {}
491  virtual void onMembersGotten(IChannelMember **members, int userCount) {}
496  virtual void onAttributesUpdated(const IChannelAttributes *attributes) {}
502  virtual void onUpdateAttributesResponse(int64_t requestId, RESPONSE_CODE resCode) {}
507  virtual void onAttributesDeleted(const IChannelAttributes *attributes) {}
513  virtual void onDeleteAttributesResponse(int64_t requestId, RESPONSE_CODE resCode) {}
514 };
518 class IChannel {
519  public:
524  virtual void setEventHandler(IChannelEventHandler *eventHandler) = 0;
534  virtual int join() = 0;
543  virtual int leave() = 0;
554  virtual int sendMessage(const IMessage *message) = 0;
565  virtual int updateAttributes(IChannelAttributes *attributes, int64_t &requestId) = 0;
576  virtual int deleteAttributes(IChannelAttributes *attributes, int64_t &requestId) = 0;
583  virtual const char *getId() const = 0;
584 
585  // sync_call
595  virtual int release() = 0;
596 };
601  public:
603 
607  virtual void onLoginSuccess() {}
612  virtual void onLoginFailure(LOGIN_ERR_CODE errorCode) {}
616  virtual void onLogout() {}
627  virtual void onSendMessageState(int64_t messageId, PEER_MESSAGE_STATE state) {}
633  virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message) {}
634 };
638 class IRtmService {
639  public:
640  virtual ~IRtmService() {}
650  virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler) = 0;
655  virtual void unregisterObserver(IRtmServiceEventHandler *eventHandler) = 0;
666  virtual int release(bool sync = false) = 0;
679  virtual int login(const char *token, const char *userId) = 0;
686  virtual int logout() = 0;
696  virtual int sendMessageToPeer(const char *peerId, const IMessage *message) = 0;
713  virtual IChannel *createChannel(const char *channelId, IChannelEventHandler *eventHandler) = 0;
714 };
715 
716 } // namespace rtm
717 } // namespace agora
agora::rtm::IChannelEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
Definition: IAgoraRtmService.h:475
agora::rtm::JOIN_CHANNEL_ERR_TOO_OFTEN
@ JOIN_CHANNEL_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:156
agora::rtm::LEAVE_CHANNEL_ERR_NOT_INITIALIZED
@ LEAVE_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:201
agora::rtm::RESPONSE_CODE_SUCCESS
@ RESPONSE_CODE_SUCCESS
Definition: IAgoraRtmService.h:270
agora::rtm::IChannelEventHandler::onMessageReceived
virtual void onMessageReceived(const char *userId, const IMessage *message)
Definition: IAgoraRtmService.h:462
agora::rtm::IMessage::release
virtual void release()=0
agora::rtm::LOGIN_ERR_UNKNOWN
@ LOGIN_ERR_UNKNOWN
Definition: IAgoraRtmService.h:35
agora::rtm::IMessage::setMessageType
virtual void setMessageType(int32_t type)=0
agora::rtm::JOIN_CHANNEL_ERR_ALREADY_JOINED
@ JOIN_CHANNEL_ERR_ALREADY_JOINED
Definition: IAgoraRtmService.h:151
agora::rtm::LOGIN_ERR_INVALID_TOKEN
@ LOGIN_ERR_INVALID_TOKEN
Definition: IAgoraRtmService.h:52
agora::rtm::IRtmService::initialize
virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler)=0
agora::rtm::IRtmServiceEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE state)
Definition: IAgoraRtmService.h:621
agora::rtm::PEER_MESSAGE_RECEIVED_BY_PEER
@ PEER_MESSAGE_RECEIVED_BY_PEER
Definition: IAgoraRtmService.h:21
agora::rtm::IChannel::join
virtual int join()=0
agora::rtm::IMessage::createMessage
static IMessage * createMessage()
agora::rtm::JOIN_CHANNEL_TIMEOUT
@ JOIN_CHANNEL_TIMEOUT
Definition: IAgoraRtmService.h:141
agora::rtm::IChannel::leave
virtual int leave()=0
agora::rtm::LEAVE_CHANNEL_ERR_REJECTED
@ LEAVE_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:191
agora::rtm::IRtmService::~IRtmService
virtual ~IRtmService()
Definition: IAgoraRtmService.h:640
agora::rtm::IChannel::sendMessage
virtual int sendMessage(const IMessage *message)=0
agora::rtm::RESPONSE_CODE_FAILURE
@ RESPONSE_CODE_FAILURE
Definition: IAgoraRtmService.h:271
agora::rtm::CONNECTION_STATE_DISCONNECTED
@ CONNECTION_STATE_DISCONNECTED
Definition: IAgoraRtmService.h:90
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:638
agora::rtm::IMessage::~IMessage
virtual ~IMessage()
Definition: IAgoraRtmService.h:309
agora::rtm::IChannelEventHandler::onJoinSuccess
virtual void onJoinSuccess()
Definition: IAgoraRtmService.h:447
agora::rtm::IChannelEventHandler::onAttributesUpdated
virtual void onAttributesUpdated(const IChannelAttributes *attributes)
Definition: IAgoraRtmService.h:496
agora::rtm::IRtmServiceEventHandler::onLoginFailure
virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:612
agora::rtm::LEAVE_CHANNEL_ERR
LEAVE_CHANNEL_ERR
Error codes related to leaving a channel.
Definition: IAgoraRtmService.h:176
agora::rtm::JOIN_CHANNEL_ERR
JOIN_CHANNEL_ERR
Definition: IAgoraRtmService.h:117
agora::rtm::IChannelMember::getChannelId
virtual const char * getChannelId() const =0
agora::rtm::CHANNEL_MESSAGE_ERR_OK
@ CHANNEL_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:230
agora::rtm::IChannelEventHandler::onDeleteAttributesResponse
virtual void onDeleteAttributesResponse(int64_t requestId, RESPONSE_CODE resCode)
Definition: IAgoraRtmService.h:513
agora::rtm::IRtmService::unregisterObserver
virtual void unregisterObserver(IRtmServiceEventHandler *eventHandler)=0
agora::rtm::MESSAGE_TYPE_TEXT
@ MESSAGE_TYPE_TEXT
Definition: IAgoraRtmService.h:284
agora::rtm::IMessage::getText
virtual const char * getText() const =0
agora::rtm::IMessage
Definition: IAgoraRtmService.h:297
agora::rtm::IRtmService::createChannel
virtual IChannel * createChannel(const char *channelId, IChannelEventHandler *eventHandler)=0
agora::rtm::LOGIN_ERR_INVALID_ARGUMENT
@ LOGIN_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:44
agora::rtm::IMessage::setRawMessage
virtual void setRawMessage(const uint8_t *data, int length)=0
agora::rtm::IChannelMember::release
virtual void release()=0
agora::rtm::IChannelEventHandler::onMembersGotten
virtual void onMembersGotten(IChannelMember **members, int userCount)
Definition: IAgoraRtmService.h:491
agora
Definition: AgoraAtomicOps.h:21
agora::rtm::IRtmService::release
virtual int release(bool sync=false)=0
agora::rtm::JOIN_CHANNEL_ERR_FAILURE
@ JOIN_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:126
agora::rtm::JOIN_CHANNEL_ERR_EXCEED_LIMIT
@ JOIN_CHANNEL_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:146
agora::rtm::IRtmService::logout
virtual int logout()=0
agora::rtm::IMessage::getMessageId
virtual int64_t getMessageId() const =0
agora::rtm::IChannelAttributes
Definition: IAgoraRtmService.h:384
agora::rtm::IRtmServiceEventHandler::onMessageReceivedFromPeer
virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
Definition: IAgoraRtmService.h:633
agora::rtm::IMessage::setText
virtual void setText(const char *str)=0
agora::rtm::IChannelAttributes::getAttributeValue
virtual const char * getAttributeValue(const char *key) const =0
agora::rtm::LOGIN_ERR_NOT_AUTHORIZED
@ LOGIN_ERR_NOT_AUTHORIZED
Definition: IAgoraRtmService.h:60
agora::rtm::IChannel::deleteAttributes
virtual int deleteAttributes(IChannelAttributes *attributes, int64_t &requestId)=0
agora::rtm::LEAVE_CHANNEL_REASON
LEAVE_CHANNEL_REASON
Definition: IAgoraRtmService.h:212
agora::rtm::LOGOUT_ERR_REJECTED
@ LOGOUT_ERR_REJECTED
Definition: IAgoraRtmService.h:77
agora::rtm::IChannelEventHandler::onUpdateAttributesResponse
virtual void onUpdateAttributesResponse(int64_t requestId, RESPONSE_CODE resCode)
Definition: IAgoraRtmService.h:502
agora::rtm::IChannelAttributes::release
virtual int release()=0
agora::rtm::JOIN_CHANNEL_ERR_INVALID_ARGUMENT
@ JOIN_CHANNEL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:136
agora::rtm::IChannelMember::~IChannelMember
virtual ~IChannelMember()
Definition: IAgoraRtmService.h:365
agora::rtm::IRtmServiceEventHandler::onLogout
virtual void onLogout()
Definition: IAgoraRtmService.h:616
agora::rtm::IChannel
Definition: IAgoraRtmService.h:518
agora::rtm::CONNECTION_STATE_CONNECTED
@ CONNECTION_STATE_CONNECTED
Definition: IAgoraRtmService.h:86
agora::rtm::CHANNEL_MESSAGE_RECEIVED_BY_SERVER
@ CHANNEL_MESSAGE_RECEIVED_BY_SERVER
Definition: IAgoraRtmService.h:107
agora::rtm::CONNECTION_STATE
CONNECTION_STATE
Definition: IAgoraRtmService.h:82
agora::rtm::IChannel::getId
virtual const char * getId() const =0
agora::rtm::IChannelAttributes::createChannelAttributes
static IChannelAttributes * createChannelAttributes()
agora::rtm::LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:206
agora::rtm::LOGIN_ERR_TIMEOUT
@ LOGIN_ERR_TIMEOUT
Definition: IAgoraRtmService.h:64
agora::rtm::IChannelEventHandler::~IChannelEventHandler
virtual ~IChannelEventHandler()
Definition: IAgoraRtmService.h:443
agora::rtm::JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
@ JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
Definition: IAgoraRtmService.h:161
agora::rtm::IChannelMember::getMemberId
virtual const char * getMemberId() const =0
agora::rtm::CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:260
agora::rtm::IChannelMember
Definition: IAgoraRtmService.h:363
agora::rtm::CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
@ CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:255
agora::rtm::IChannel::setEventHandler
virtual void setEventHandler(IChannelEventHandler *eventHandler)=0
agora::rtm::IMessage::getMessageType
virtual int getMessageType() const =0
agora::rtm::CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
@ CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:250
agora::rtm::LOGIN_ERR_TOKEN_EXPIRED
@ LOGIN_ERR_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:56
agora::rtm::IChannel::updateAttributes
virtual int updateAttributes(IChannelAttributes *attributes, int64_t &requestId)=0
agora::rtm::IMessage::getRawMessageLength
virtual int getRawMessageLength() const =0
agora::rtm::LOGIN_ERR_INVALID_APP_ID
@ LOGIN_ERR_INVALID_APP_ID
Definition: IAgoraRtmService.h:48
agora::rtm::PEER_MESSAGE_FAILURE
@ PEER_MESSAGE_FAILURE
Definition: IAgoraRtmService.h:19
agora::rtm::CHANNEL_MESSAGE_ERR_TOO_OFTEN
@ CHANNEL_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:245
agora::rtm::LEAVE_CHANNEL_REASON_QUIT
@ LEAVE_CHANNEL_REASON_QUIT
Definition: IAgoraRtmService.h:216
agora::rtm::LEAVE_CHANNEL_REASON_KICKED
@ LEAVE_CHANNEL_REASON_KICKED
Definition: IAgoraRtmService.h:220
agora::rtm::IChannelAttributes::addAttribute
virtual int addAttribute(const char *key, const char *value)=0
agora::rtm::IMessage::getRawMessageData
virtual const unsigned char * getRawMessageData() const =0
agora::rtm::IChannelEventHandler::onSendMessageState
virtual void onSendMessageState(int64_t messageId, CHANNEL_MESSAGE_STATE state)
Definition: IAgoraRtmService.h:468
agora::rtm::PEER_MESSAGE_INIT
@ PEER_MESSAGE_INIT
Definition: IAgoraRtmService.h:18
agora::rtm::LEAVE_CHANNEL_ERR_OK
@ LEAVE_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:181
agora::rtm::LOGIN_ERR_OK
@ LOGIN_ERR_OK
Definition: IAgoraRtmService.h:31
agora::rtm::JOIN_CHANNEL_ERR_OK
@ JOIN_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:121
agora::rtm::IChannel::release
virtual int release()=0
agora::rtm::LOGOUT_ERR_OK
@ LOGOUT_ERR_OK
Definition: IAgoraRtmService.h:73
agora::rtm::JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:171
agora::rtm::CHANNEL_MESSAGE_STATE
CHANNEL_MESSAGE_STATE
Definition: IAgoraRtmService.h:103
agora::rtm::CHANNEL_MESSAGE_ERR_CODE
CHANNEL_MESSAGE_ERR_CODE
Error codes related to sending a channel message.
Definition: IAgoraRtmService.h:225
agora::rtm::CHANNEL_MESSAGE_SENT_TIMEOUT
@ CHANNEL_MESSAGE_SENT_TIMEOUT
Definition: IAgoraRtmService.h:112
agora::rtm::MESSAGE_TYPE_BINARY
@ MESSAGE_TYPE_BINARY
Definition: IAgoraRtmService.h:288
agora::rtm::IChannelEventHandler::onMemberJoined
virtual void onMemberJoined(IChannelMember *member)
Definition: IAgoraRtmService.h:480
agora::rtm::PEER_MESSAGE_STATE
PEER_MESSAGE_STATE
Definition: IAgoraRtmService.h:17
agora::rtm::MESSAGE_TYPE_CONVERGE
@ MESSAGE_TYPE_CONVERGE
Definition: IAgoraRtmService.h:292
agora::rtm::PEER_MESSAGE_PEER_UNREACHABLE
@ PEER_MESSAGE_PEER_UNREACHABLE
Definition: IAgoraRtmService.h:20
agora::rtm::IRtmService::login
virtual int login(const char *token, const char *userId)=0
agora::rtm::IRtmServiceEventHandler::~IRtmServiceEventHandler
virtual ~IRtmServiceEventHandler()
Definition: IAgoraRtmService.h:602
agora::rtm::LOGIN_ERR_REJECTED
@ LOGIN_ERR_REJECTED
Definition: IAgoraRtmService.h:40
agora::rtm::IChannelEventHandler
Definition: IAgoraRtmService.h:441
agora::rtm::IChannelEventHandler::onMemberLeft
virtual void onMemberLeft(IChannelMember *member)
Definition: IAgoraRtmService.h:485
agora::rtm::IRtmServiceEventHandler::onLoginSuccess
virtual void onLoginSuccess()
Definition: IAgoraRtmService.h:607
agora::rtm::CHANNEL_MESSAGE_ERR_FAILURE
@ CHANNEL_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:235
agora::rtm::CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
@ CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:240
agora::rtm::IChannelAttributes::removeAttribute
virtual int removeAttribute(const char *key)=0
agora::rtm::PEER_MESSAGE_SENT_TIMEOUT
@ PEER_MESSAGE_SENT_TIMEOUT
Definition: IAgoraRtmService.h:22
agora::rtm::MESSAGE_TYPE
MESSAGE_TYPE
Definition: IAgoraRtmService.h:276
agora::rtm::LOGOUT_ERR_CODE
LOGOUT_ERR_CODE
Definition: IAgoraRtmService.h:69
agora::rtm::IChannelEventHandler::onAttributesDeleted
virtual void onAttributesDeleted(const IChannelAttributes *attributes)
Definition: IAgoraRtmService.h:507
agora::rtm::JOIN_CHANNEL_ERR_NOT_INITIALIZED
@ JOIN_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:166
agora::rtm::JOIN_CHANNEL_ERR_REJECTED
@ JOIN_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:131
agora::rtm::LEAVE_CHANNEL_ERR_FAILURE
@ LEAVE_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:186
agora::rtm::RESPONSE_CODE
RESPONSE_CODE
Definition: IAgoraRtmService.h:266
agora::rtm::LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
@ LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:196
agora::rtm::IChannelEventHandler::onJoinFailure
virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:452
agora::rtm::IChannelAttributes::getAttributesSize
virtual int getAttributesSize() const =0
agora::rtm::MESSAGE_TYPE_UNDEFINED
@ MESSAGE_TYPE_UNDEFINED
Definition: IAgoraRtmService.h:280
agora::rtm::IRtmServiceEventHandler::onSendMessageState
virtual void onSendMessageState(int64_t messageId, PEER_MESSAGE_STATE state)
Definition: IAgoraRtmService.h:627
agora::rtm::IChannelEventHandler::onLeave
virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:457
agora::rtm::CONNECTION_STATE_ABORTED
@ CONNECTION_STATE_ABORTED
Definition: IAgoraRtmService.h:97
agora::rtm::IChannelAttributes::getAttributes
virtual void getAttributes(int size, char **key, char **value) const =0
agora::rtm::LOGIN_ERR_CODE
LOGIN_ERR_CODE
Definition: IAgoraRtmService.h:27
agora::rtm::IRtmServiceEventHandler
Definition: IAgoraRtmService.h:600
agora::rtm::IRtmService::sendMessageToPeer
virtual int sendMessageToPeer(const char *peerId, const IMessage *message)=0