agora::rtm::IRemoteCallInvitation Class Reference

#include <IAgoraRtmCallManager.h>

Public Member Functions
virtual const char *	getCallerId () const =0
virtual const char *	getContent () const =0
virtual void	setResponse (const char *response)=0
virtual const char *	getResponse () const =0
virtual const char *	getChannelId () const =0
virtual REMOTE_INVITATION_STATE	getState () const =0
virtual void	release ()=0

Protected Member Functions
virtual	~IRemoteCallInvitation ()

Detailed Description

The class allowing the callee to retrieve the attributes of an incoming call invitation.

Constructor & Destructor Documentation

~IRemoteCallInvitation()

virtual agora::rtm::IRemoteCallInvitation::~IRemoteCallInvitation ( )

inlineprotectedvirtual

Member Function Documentation

getCallerId()

virtual const char * agora::rtm::IRemoteCallInvitation::getCallerId ( ) const

pure virtual

Allows the callee to get the User ID of the caller.

getContent()

virtual const char * agora::rtm::IRemoteCallInvitation::getContent ( ) const

pure virtual

Allows the callee to get the call invitation content set by the caller.

Note

The caller sets the call invitation content using the setContent method.

setResponse()

virtual void agora::rtm::IRemoteCallInvitation::setResponse ( const char *  response )

pure virtual

Allows the callee to set a response to the call invitation.

Parameters

response

The callee's response to the call invitation. The response must not exceed 8 KB in length if encoded in UTF-8.

getResponse()

virtual const char * agora::rtm::IRemoteCallInvitation::getResponse ( ) const

pure virtual

Allows the callee to get his/her response to the incoming call invitation.

Note

The callee sets a response to the incoming call invitation using the setResponse method.

getChannelId()

virtual const char * agora::rtm::IRemoteCallInvitation::getChannelId ( ) const

pure virtual

Gets the channel ID.

getState()

virtual REMOTE_INVITATION_STATE agora::rtm::IRemoteCallInvitation::getState ( ) const

pure virtual

Allows the callee to get the state of the incoming call invitation.

Returns

The state of the incoming call invitation See: REMOTE_INVITATION_STATE.

release()

virtual void agora::rtm::IRemoteCallInvitation::release ( )

pure virtual

Releases all resources used by the IRemoteCallInvitation instance.