Signaling (previously RTM) SDK v1.5.0 API Reference for Windows (C++)
Public Member Functions | Protected Member Functions | List of all members
agora::rtm::ILocalCallInvitation Class Referenceabstract

#include <IAgoraRtmCallManager.h>

Public Member Functions

virtual const char *  getCalleeId () const =0
 
virtual void  setContent (const char *content)=0
 
virtual const char *  getContent () const =0
 
virtual void  setChannelId (const char *channelId)=0
 
virtual const char *  getChannelId () const =0
 
virtual const char *  getResponse () const =0
 
virtual LOCAL_INVITATION_STATE  getState () const =0
 
virtual void  release ()=0
 

Protected Member Functions

virtual  ~ILocalCallInvitation ()
 

Detailed Description

The class allowing the caller to retrieve the attributes of an outgoing call invitation.

Constructor & Destructor Documentation

◆ ~ILocalCallInvitation()

virtual agora::rtm::ILocalCallInvitation::~ILocalCallInvitation ( )
inlineprotectedvirtual

Member Function Documentation

◆ getCalleeId()

virtual const char * agora::rtm::ILocalCallInvitation::getCalleeId ( ) const
pure virtual

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

◆ setContent()

virtual void agora::rtm::ILocalCallInvitation::setContent ( const char *  content )
pure virtual

Allows the caller to set the call invitation content.

Parameters
content The content of the call invitation. The content must not exceed 8 KB in length if encoded in UTF-8.

◆ getContent()

virtual const char * agora::rtm::ILocalCallInvitation::getContent ( ) const
pure virtual

Allows the caller to get the call invitation content.

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

◆ setChannelId()

virtual void agora::rtm::ILocalCallInvitation::setChannelId ( const char *  channelId )
pure virtual

Sets the channel ID.

Note
To intercommunicate with the legacy Agora Signaling SDK, you MUST set the channel ID. However, even if the callee successfully accepts the call invitation, the Agora RTM SDK does not join the channel of the specified channel ID.
Parameters
channelId The channel ID to be set.

◆ getChannelId()

virtual const char * agora::rtm::ILocalCallInvitation::getChannelId ( ) const
pure virtual

Gets the channel ID.

◆ getResponse()

virtual const char * agora::rtm::ILocalCallInvitation::getResponse ( ) const
pure virtual

Allows the caller to get the callee's response to the call invitation.

Note
The callee sets his/her response using the setResponse method.

◆ getState()

virtual LOCAL_INVITATION_STATE agora::rtm::ILocalCallInvitation::getState ( ) const
pure virtual

Allows the caller to get the state of the outgoing call invitation.

Returns
State of the outgoing call invitation. See: LOCAL_INVITATION_STATE.

◆ release()

virtual void agora::rtm::ILocalCallInvitation::release ( )
pure virtual

Releases all resources used by the ILocalCallInvitation instance.