通过阅读本文,您可以了解Android互动SDK的API。

API列表

API 描述 所属类及描述
getRoomService 服务类:获取房间服务。 InteractionModule
enterRoom 进入房间。 InteractionRoomServiceInterface
getRoomDetail 查询房间详情。
publishRoomNotice 发布房间公告。
leaveRoom 离开房间。
getMessageService 服务类:获取消息服务。 InteractionModule
sendLikes 点赞。 InteractionMessageServiceInterface
sendComment 发文本消息。
sendCustomMessage 发自定义消息。

InteractionModule

getRoomService:获取房间服务。
void getRoomService();
回调说明

调用成功后,发生如下事件会产生对应回调:

  • 房间数量发生变化时,会调用void onViewersCountNtf(DPSUserId dpsUserId, String var2, InteractionRoomViewerCountNtf var3)方法。
  • 房间公告发生变化时,会调用void onRoomNoticeNtf(DPSUserId dpsUserId, String var2, InteractionRoomNoticeNtf var3)方法。

InteractionRoomServiceInterface

  • enterRoom:进入房间。
    void enterRoom(InteractionEnterRoomReq request, InteractionCommonCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    nick String 用户昵称。
    callback InteractionCommonCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess()方法。
    • 调用失败后,会调用void onFailure(DPSError error) 方法。
  • getRoomDetail:查询房间详情。
    void getRoomDetail(InteractionGetRoomDetailReq request, InteractionGetRoomDeitalCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    callback InteractionGetRoomDeitalCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess()方法。
    • 调用失败后,会调用void onFailure(DPSError error) 方法。
  • publishRoomNotice:发布房间公告。
    void publishRoomNotice(InteractionPublishNoticeReq request, InteractionCommonCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    notice String 公告内容。
    callback InteractionCommonCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess()方法。
    • 调用失败后,会调用void onFailure(DPSError error) 方法。
  • leaveRoom:离开房间。
    void leaveRoom(InteractionLeaveRoomReq request, InteractionCommonCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    callback InteractionCommonCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess()方法。
    • 调用失败后,会调用void onFailure(DPSError error) 方法。

InteractionModule

getMessageService:获取消息服务。
void getMessageService();
回调说明

调用成功后,发生如下事件会产生对应回调:

  • 接收评论时,会调用void onCommentNtf(DPSUserId dpsUserId, String var2, InteractionCommentNtf var3)方法。
  • 接收点赞时,会调用void onLikesCountNtf(DPSUserId dpsUserId, String var2, InteractionLikesNtf var3)方法。
  • 接收自定义消息时,会调用void onCustomMessageNtf(DPSUserId dpsUserId, String var2, InteractionCustomMsgNtf var3)方法。

InteractionMessageServiceInterface

  • sendLikes:点赞。
    void sendLikes(InteractionSendLikesReq request, InteractionCommonCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    count Integer 点赞数。
    callback InteractionCommonCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess(InteractionSendLikesRsp data) 方法。
    • 调用失败后,会调用void onFailure(DPSError error)方法。
  • sendComment:发文本消息。
    void sendComment(InteractionSendCommentReq request, InteractionSendCommentCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    content normalMessageText 文本消息内容。
    callback InteractionSendCommentCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess(InteractionSendCommentRsp data)方法。
    • 调用失败后,会调用void onFailure(DPSError error)方法。
  • sendCustomMessage:发自定义消息。
    void sendCustomMessage(InteractionSendCustomMessageReq request, InteractionSendCustomMessageCb callback);
    参数说明
    参数 类型 说明
    request Object 请求参数。
    roomId String 房间ID。
    subType customMessageSubType 消息类型。
    body customMessageText 自定义消息内容。
    callback InteractionSendCustomMessageCb 回调函数,请参见下文回调说明。
    回调说明
    • 调用成功后,会调用void onSuccess(InteractionSendCustomMessageRsp data)方法。
    • 调用失败后,会调用void onFailure(DPSError error)方法。