agora_rtm.RtmChannel Class Reference

Inherits IDisposable.

Public Member Functions
	RtmChannel (IntPtr rtmChannelPtr, RtmChannelEventHandler rtmChannelEventHandler)
int	Join ()
int	Leave ()
int	SendMessage (IMessage message)
int	SendMessage (IMessage message, SendMessageOptions options)
int	GetId ()
int	GetMembers ()
void	Dispose ()

Constructor & Destructor Documentation

RtmChannel()

agora_rtm.RtmChannel.RtmChannel ( IntPtr  rtmChannelPtr, RtmChannelEventHandler  rtmChannelEventHandler  )

inline

Member Function Documentation

Dispose()

void agora_rtm.RtmChannel.Dispose ( )

inline

Releases all resources used by the RtmChannel instance.

GetId()

int agora_rtm.RtmChannel.GetId ( )

inline

Retrieves the channel ID.

Returns

The channel ID of the channel.

GetMembers()

int agora_rtm.RtmChannel.GetMembers ( )

inline

Retrieves a member list of the channel. The OnGetMembersHandler callback returns the result of this method call.

Note

You can call this method at a maximum frequency of five calls every two seconds. This method returns a maximum of 512 members. If the number of channel members exceed 512, the method returns 512 members randomly.

Returns

• 0: Success.
• ≠0: Failure. See GET_MEMBERS_ERR for the error codes.

Join()

int agora_rtm.RtmChannel.Join ( )

inline

Joins a channel.

Note

You can join a maximum of 20 RTM channels at the same time. When the number of the channels you join exceeds the limit, you receive the JOIN_CHANNEL_ERR error code.

• If this method call succeeds:
  • The local user receives the OnJoinSuccessHandler callback.
  • All remote users receive the OnMemberJoinedHandler callback.
• If this method call fails, the local user receives the OnJoinFailureHandler callback. See JOIN_CHANNEL_ERR for the error codes.

Returns

• 0: Success.
• ≠0: Failure. See JOIN_CHANNEL_ERR for the error codes.

Leave()

int agora_rtm.RtmChannel.Leave ( )

inline

Leaves a channel.

• If this method call succeeds:
  • The local user receives the OnLeaveHandler callback with the LEAVE_CHANNEL_ERR_OK state.
  • All remote users receive the OnMemberLeftHandler callback.
• If this method call fails, the local user receives the OnLeaveHandler callback with an error code. See LEAVE_CHANNEL_ERR for the error codes.

Returns

• 0: Success.
• ≠0: Failure. See LEAVE_CHANNEL_ERR for the error codes.

SendMessage() [1/2]

int agora_rtm.RtmChannel.SendMessage ( IMessage  message )

inline

Agora does not recommend using this method to send a channel message. Use SendMessage instead. If this method call succeeds:

• The OnSendMessageResultHandler callback returns the result.
• All remote users in the channel receive the OnMessageReceivedHandler callback.

Parameters

message

The message to be sent. See IMessage.

Returns

• 0: Success.
• ≠0: Failure. See CHANNEL_MESSAGE_ERR_CODE for the error codes.

SendMessage() [2/2]

int agora_rtm.RtmChannel.SendMessage ( IMessage  message, SendMessageOptions  options  )

inline

Allows a channel member to send a message to all members in the channel. If this method call succeeds:

• The OnSendMessageResultHandler callback returns the result.
• All remote users in the channel receive the OnMessageReceivedHandler callback.

  Note

  You can send messages, including peer-to-peer and channel messages, at a maximum frequency of 180 calls every three seconds.

Parameters

message	The message to be sent. See IMessage.
options	Options when sending the channel message. See SendMessageOptions.

Returns

• 0: Success.
• ≠0: Failure. See CHANNEL_MESSAGE_ERR_CODE for the error codes.

---

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

• RtmChannel.cs