DingRtmClient接口

接口说明

目录

接口详情

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

   void setDelegate (id< DingRtmClientDelegate >_Nullable delegate)

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

  重要

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

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

   int joinSession (NSString *sessionId)

  参数	类型	描述
  sessionId	NSString *	SessionID。只允许[A-Za-z0-9_-]，不超过64个字符。

  返回说明

  • 0：成功；
  • <0：失败。
  重要

  自己会收到DingRtmClientDelegate::onJoinSessionResult回调，Session里的其他用户会收到DingRtmClientDelegate::onSessionRemoteUserJoin通知。

• leaveSession： 离开Session。

   int leaveSession (NSString *sessionId)

  参数	类型	描述
  sessionId	NSString *	SessionID。

  返回说明

  • 0：成功；
  • <0：失败。
  重要

  自己会收到DingRtmClientDelegate::onLeaveSessionResult回调，Session里的其他用户会收到DingRtmClientDelegate::onSessionRemoteUserLeave通知。

• closeSession： 关闭Session。

   int closeSession (NSString *sessionId)

  参数	类型	描述
  sessionId	NSString *	SessionID。

  返回说明

  • 0：成功；
  • <0：失败。
  重要

  自己会收到DingRtmClientDelegate::onCloseSessionResult回调，Session里的所有用户都会收到DingRtmClientDelegate::onSessionClose通知，Session关闭后不再可用。

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

   int sendData (NSString *sessionId,[uid] NSString *uid,[data] NSData *data)

  参数	类型	描述
  sessionId	NSString *	SessionID。
  toUid		消息接收方用户ID。
  data	NSData *	消息数据，支持UTF-8编码的字符串和二进制数据。

  返回说明

  • 0：成功；
  • <0：失败。

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

   int broadcastData (NSString *sessionId,[data] NSData *data)

  参数	类型	描述
  sessionId	NSString *	SessionID。
  data	NSData *	消息数据，支持UTF-8编码的字符串和二进制数据。

  返回说明

  • 0：成功；
  • <0：失败。