agora_rtm.LocalInvitation Class Reference

Inherits IDisposable.

Public Member Functions
	LocalInvitation (IntPtr localInvitationPtr, bool needRelease=true)
string	GetCalleeId ()
void	SetContent (string content)
string	GetContent ()
void	SetChannelId (string channelId)
string	GetChannelId ()
string	GetResponse ()
LOCAL_INVITATION_STATE	GetState ()
void	Dispose ()

Constructor & Destructor Documentation

LocalInvitation()

agora_rtm.LocalInvitation.LocalInvitation ( IntPtr  localInvitationPtr, bool  needRelease = true  )

inline

Member Function Documentation

Dispose()

void agora_rtm.LocalInvitation.Dispose ( )

inline

Releases all resources used by the LocalInvitation instance.

GetCalleeId()

string agora_rtm.LocalInvitation.GetCalleeId ( )

inline

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

GetChannelId()

string agora_rtm.LocalInvitation.GetChannelId ( )

inline

Gets the channel ID.

GetContent()

string agora_rtm.LocalInvitation.GetContent ( )

inline

Allows the caller to get the call invitation content.

Note

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

GetResponse()

string agora_rtm.LocalInvitation.GetResponse ( )

inline

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()

LOCAL_INVITATION_STATE agora_rtm.LocalInvitation.GetState ( )

inline

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

Returns

State of the outgoing call invitation. See: LOCAL_INVITATION_STATE.

SetChannelId()

void agora_rtm.LocalInvitation.SetChannelId ( string  channelId )

inline

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.

SetContent()

void agora_rtm.LocalInvitation.SetContent ( string  content )

inline

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.

---

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

• LocalInvitation.cs