查询置顶 | JuggleIM

Android
iOS
JavaScript

接口定义

/**
 * 获取置顶消息
 * @param conversation 会话标识
 * @param callback 结果回调
 */
void getTopMessage(Conversation conversation, IGetTopMessageCallback callback);

接口定义

/// 获取置顶消息
/// - Parameters:
///   - conversation: 会话标识
///   - successBlock: 成功回调
///   - errorBlock: 失败回调
- (void)getTopMessage:(JConversation *)conversation
              success:(void (^)(JMessage *message, JUserInfo *userInfo, long long timestamp))successBlock
                error:(void (^)(JErrorCode code))errorBlock;

查询指定会话的置顶消息，点击进入会话页面后请调用查询置顶消息接口获取当前会话的置顶消息。

参数说明

名称	类型	必填	描述	版本
message	Object	是	消息对象	1.0.0
message.conversationType	Number	是	会话类型	1.0.0
message.conversationId	String	是	会话 Id，会话类型是 `PRIVATE` 时，会话 Id 是接收方的 userId，会话类型是 `GROUP` 时是群组 Id	1.0.0

成功回调

名称	类型	描述	版本
result	Object		1.0.0
result.message	Object	被置顶的消息对象	1.0.0
result.isTop	Boolean	是否置顶	1.0.0
result.operator	Object	操作人	1.0.0
result.createdTime	Number	操作置顶时间	1.0.0

失败回调

名称	类型	描述	版本
error	Object	发送失败后会有对应的状态码，可以直接查看 `error.msg`，或者查看状态码	1.0.0

示例代码

let { ConversationType } = JIM;

let conversation = {
  conversationType: ConversationType.GROUP,
  conversationId: 'groupid1',
};

jim.getTopMessage(conversation).then((result) => {

  let { message, isTop, operator, createdTime } = result;
  
  // message => 被置顶或取消置顶的原始消息，想系可查看 Message 对象
  
  // isTop => 是否置顶
  
  // operator => 操作人 { id: '', name: '', portrait: '' }
  
  // createdTime => 操作时间
  
}, (error) => {
  console.log(error)
});