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

API列表

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

InteractionModule

getRoomService:获取房间服务。
- (void)getRoomService;

InteractionRoomServiceInterface

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

InteractionModule

getMessageService:获取消息服务。
- (void)getMessageService;

InteractionMessageServiceInterface

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