Signaling (previously RTM) v1.4.8 API Reference for Unity
Public Member Functions | List of all members
agora_rtm.RemoteInvitation Class Reference

Inherits IDisposable.

Public Member Functions

 RemoteInvitation (IntPtr remoteInvitationPtr, bool needDispose=true)
 
string GetCallerId ()
 
string GetContent ()
 
void SetResponse (string response)
 
string GetResponse ()
 
string GetChannelId ()
 
REMOTE_INVITATION_STATE GetState ()
 
void Dispose ()
 

Constructor & Destructor Documentation

◆ RemoteInvitation()

agora_rtm.RemoteInvitation.RemoteInvitation ( IntPtr  remoteInvitationPtr,
bool  needDispose = true 
)
inline

Member Function Documentation

◆ Dispose()

void agora_rtm.RemoteInvitation.Dispose ( )
inline

Releases all resources used by the RemoteInvitation instance.

◆ GetCallerId()

string agora_rtm.RemoteInvitation.GetCallerId ( )
inline

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

Returns
CallId

◆ GetChannelId()

string agora_rtm.RemoteInvitation.GetChannelId ( )
inline

Gets the channel ID.

◆ GetContent()

string agora_rtm.RemoteInvitation.GetContent ( )
inline

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

Returns
The content.

◆ GetResponse()

string agora_rtm.RemoteInvitation.GetResponse ( )
inline

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.

◆ GetState()

REMOTE_INVITATION_STATE agora_rtm.RemoteInvitation.GetState ( )
inline

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

Returns
The state of the incoming call invitation. See: REMOTE_INVITATION_STATE.

◆ SetResponse()

void agora_rtm.RemoteInvitation.SetResponse ( string  response)
inline

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

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

The documentation for this class was generated from the following file: