浏览 SDKs · uni-app / uni-app x
SDKsuni-app

按目标查询会话

按目标 ID 和会话类型查询一个会话。

复制

getOneConversation() 使用目标 ID 和 OpenIMSessionType 查询单个会话,返回 OpenIMConversationItem | null

参数说明

参数类型是否必填说明
sourceIDstring会话目标 ID:单聊为对方 userID,群聊为 groupID
sessionTypeOpenIMSessionType会话类型,使用插件导出的 OpenIMSessionTypeSingle、群聊等常量。
import {
  OpenIMSessionTypeSingle,
  getOneConversation,
} from '@/uni_modules/unix-openim-sdk'

const conversation = await getOneConversation({
  sourceID: 'user_b',
  sessionType: OpenIMSessionTypeSingle,
})

同一个字符串在不同 sessionType 下可能表示不同目标,必须同时传入正确类型。不要直接写数字,也不要把 conversationID 当成 sourceID 传入;已经知道会话 ID 时使用按会话 ID 查询 API。

Promise 成功直接返回 OpenIMConversationItem | nullnull 可能表示本地尚无该会话;发送首条消息或收到消息后,会话可由事件创建。查询本身不会创建会话,也不会触发会话事件。

返回值按 conversationID 合并到 store,不要用 sourceID 直接覆盖其他会话类型。