agora::rtm::IRtmCallEventHandler Class Reference

#include <IAgoraRtmCallManager.h>

Public Member Functions
virtual	~IRtmCallEventHandler ()
virtual void	onLocalInvitationReceivedByPeer (ILocalCallInvitation *localInvitation)
virtual void	onLocalInvitationCanceled (ILocalCallInvitation *localInvitation)
virtual void	onLocalInvitationFailure (ILocalCallInvitation *localInvitation, LOCAL_INVITATION_ERR_CODE errorCode)
virtual void	onLocalInvitationAccepted (ILocalCallInvitation *localInvitation, const char *response)
virtual void	onLocalInvitationRefused (ILocalCallInvitation *localInvitation, const char *response)
virtual void	onRemoteInvitationRefused (IRemoteCallInvitation *remoteInvitation)
virtual void	onRemoteInvitationAccepted (IRemoteCallInvitation *remoteInvitation)
virtual void	onRemoteInvitationReceived (IRemoteCallInvitation *remoteInvitation)
virtual void	onRemoteInvitationFailure (IRemoteCallInvitation *remoteInvitation, REMOTE_INVITATION_ERR_CODE errorCode)
virtual void	onRemoteInvitationCanceled (IRemoteCallInvitation *remoteInvitation)

Detailed Description

Callbacks for the call invitation methods.

Constructor & Destructor Documentation

~IRtmCallEventHandler()

virtual agora::rtm::IRtmCallEventHandler::~IRtmCallEventHandler ( )

inlinevirtual

Member Function Documentation

onLocalInvitationReceivedByPeer()

virtual void agora::rtm::IRtmCallEventHandler::onLocalInvitationReceivedByPeer ( ILocalCallInvitation *  localInvitation )

inlinevirtual

Callback to the caller: occurs when the callee receives the call invitation.

Parameters

localInvitation

An ILocalCallInvitation object.

onLocalInvitationCanceled()

virtual void agora::rtm::IRtmCallEventHandler::onLocalInvitationCanceled ( ILocalCallInvitation *  localInvitation )

inlinevirtual

Callback to the caller: occurs when the caller cancels a call invitation.

Parameters

localInvitation

An ILocalCallInvitation object.

onLocalInvitationFailure()

virtual void agora::rtm::IRtmCallEventHandler::onLocalInvitationFailure ( ILocalCallInvitation *  localInvitation, LOCAL_INVITATION_ERR_CODE  errorCode  )

inlinevirtual

Callback to the caller: occurs when the life cycle of the outgoing call invitation ends in failure.

Parameters

localInvitation	An ILocalCallInvitation object.
errorCode	The error code. See LOCAL_INVITATION_ERR_CODE.

onLocalInvitationAccepted()

virtual void agora::rtm::IRtmCallEventHandler::onLocalInvitationAccepted ( ILocalCallInvitation *  localInvitation, const char *  response  )

inlinevirtual

Callback to the caller: occurs when the callee accepts the call invitation.

Parameters

localInvitation	An ILocalCallInvitation object.
response	The callee's response to the call invitation.

onLocalInvitationRefused()

virtual void agora::rtm::IRtmCallEventHandler::onLocalInvitationRefused ( ILocalCallInvitation *  localInvitation, const char *  response  )

inlinevirtual

Callback to the caller: occurs when the callee refuses the call invitation.

Parameters

localInvitation	An ILocalCallInvitation object.
response	The callee's response to the call invitation.

onRemoteInvitationRefused()

virtual void agora::rtm::IRtmCallEventHandler::onRemoteInvitationRefused ( IRemoteCallInvitation *  remoteInvitation )

inlinevirtual

Callback for the callee: occurs when the callee refuses a call invitation.

Parameters

remoteInvitation

An IRemoteCallInvitation object.

onRemoteInvitationAccepted()

virtual void agora::rtm::IRtmCallEventHandler::onRemoteInvitationAccepted ( IRemoteCallInvitation *  remoteInvitation )

inlinevirtual

Callback to the callee: occurs when the callee accepts a call invitation.

Parameters

remoteInvitation

An IRemoteCallInvitation object.

onRemoteInvitationReceived()

virtual void agora::rtm::IRtmCallEventHandler::onRemoteInvitationReceived ( IRemoteCallInvitation *  remoteInvitation )

inlinevirtual

Callback to the callee: occurs when the callee receives a call invitation.

Parameters

remoteInvitation

An IRemoteCallInvitation object.

onRemoteInvitationFailure()

virtual void agora::rtm::IRtmCallEventHandler::onRemoteInvitationFailure ( IRemoteCallInvitation *  remoteInvitation, REMOTE_INVITATION_ERR_CODE  errorCode  )

inlinevirtual

Callback to the callee: occurs when the life cycle of the incoming call invitation ends in failure.

Parameters

remoteInvitation	An IRemoteCallInvitation object.
errorCode	The error code. See REMOTE_INVITATION_ERR_CODE.

onRemoteInvitationCanceled()

virtual void agora::rtm::IRtmCallEventHandler::onRemoteInvitationCanceled ( IRemoteCallInvitation *  remoteInvitation )

inlinevirtual

Callback to the callee: occurs when the caller cancels the call invitation.

Parameters

remoteInvitation

An IRemoteCallInvitation object.