Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
agora::rtm::IRtmServiceEventHandler Class Reference

#include <IAgoraRtmService.h>

Public Member Functions

virtual ~IRtmServiceEventHandler ()
 
virtual void onLoginSuccess ()
 
virtual void onLoginFailure (LOGIN_ERR_CODE errorCode)
 
virtual void onLogout ()
 
virtual void onConnectionStateChanged (CONNECTION_STATE state)
 
virtual void onSendMessageState (int64_t messageId, PEER_MESSAGE_STATE state)
 
virtual void onMessageReceivedFromPeer (const char *peerId, const IMessage *message)
 

Detailed Description

Constructor & Destructor Documentation

◆ ~IRtmServiceEventHandler()

virtual agora::rtm::IRtmServiceEventHandler::~IRtmServiceEventHandler ( )
inlinevirtual

Member Function Documentation

◆ onLoginSuccess()

virtual void agora::rtm::IRtmServiceEventHandler::onLoginSuccess ( )
inlinevirtual

Occurs when the user successfully logs in the RTM service.

◆ onLoginFailure()

virtual void agora::rtm::IRtmServiceEventHandler::onLoginFailure ( LOGIN_ERR_CODE errorCode)
inlinevirtual

Occurs when the user fails to log in the RTM service.

Parameters
errorCodeThe reason for the login failure: LOGIN_ERR_CODE.

◆ onLogout()

virtual void agora::rtm::IRtmServiceEventHandler::onLogout ( )
inlinevirtual

Occurs when the user successfully logs out of the RTM service.

◆ onConnectionStateChanged()

virtual void agora::rtm::IRtmServiceEventHandler::onConnectionStateChanged ( CONNECTION_STATE state)
inlinevirtual

Occurs when the connection state of the local user has changed.

Parameters
stateThe current connection state: CONNECTION_STATE.

◆ onSendMessageState()

virtual void agora::rtm::IRtmServiceEventHandler::onSendMessageState ( int64_t messageId,
PEER_MESSAGE_STATE state )
inlinevirtual

Reports the state of sending a message.

Parameters
messageIdID of the message.
stateThe current state of the message: PEER_MESSAGE_STATE.

◆ onMessageReceivedFromPeer()

virtual void agora::rtm::IRtmServiceEventHandler::onMessageReceivedFromPeer ( const char * peerId,
const IMessage * message )
inlinevirtual

Occurs when the local user receives a message from a remote user.

Parameters
peerIdID of the remote user that sends the message.
messageThe pointer to the message: IMessage.