DingRtmClient

接口说明

目录

RTM服务接口。

接口详情

• SetListener：设置消息服务的回调。

  void SetListener (RtmEventListener *listener)=0

  参数	类型	描述

  参数	类型	描述
  listener	RtmEventListener *	用于接收来自RTM服务的回调事件。

  重要

  需要在入会前设置监听，否则可能丢失部分RTM事件回调。

• JoinSession：加入Session。如果之前存在此Session，直接加入；否则会先创建Session并加入。

  int JoinSession (const String &sessionId)=0

  参数	类型	描述

  参数	类型	描述
  sessionId	const ding::rtc::String &	SessionID。只允许[A-Za-z0-9_-]，不超过64个字符。

  返回说明

  0：成功；<0：失败。

  重要

  自己会收到OnJoinSessionResult回调，Session里的其他用户会收到OnSessionRemoteUserJoin回调。

• LeaveSession：离开Session。

  int LeaveSession (const String &sessionId)=0

  参数	类型	描述

  参数	类型	描述
  sessionId	const ding::rtc::String &	SessionID。

  返回说明

  0：成功；<0：失败。

  重要

  自己会收到OnLeaveSessionResult回调，Session里的其他用户会收到OnSessionRemoteUserLeave回调。

• CloseSession：关闭Session。

  int CloseSession (const String &sessionId)=0

  参数	类型	描述

  参数	类型	描述
  sessionId	const ding::rtc::String &	SessionID。

  返回说明

  0：成功；<0：失败。

  重要

  自己会收到OnCloseSessionResult回调，Session里的所有用户都会收到OnSessionClose回调，Session关闭后不再可用。

• SendData：发送消息给Session里的指定用户。

  int SendData (const String &sessionId, const String &toUid, const RtmData &data)=0

  参数	类型	描述

  参数	类型	描述
  sessionId	const ding::rtc::String &	SessionID。
  toUid	const ding::rtc::String &	消息接收方用户ID。
  data	const RtmData &	消息数据。

  返回说明

  0：成功；<0：失败。

• BroadcastData：广播消息给Session里的所有用户。

  int BroadcastData (const String &sessionId, const RtmData &data)=0

  参数	类型	描述

  参数	类型	描述
  sessionId	const ding::rtc::String &	SessionID。
  data	const RtmData &	消息数据。

  返回说明

  0：成功；<0：失败。