getConversationIDBySessionType
功能介绍
说明
根据会话类型获取会话 ID。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> getConversationIDBySessionType({
required String sourceID,
required int sessionType,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
sessionType | int | 是 | 会话类型 |
sourceID | String | 是 | 单聊为用户 ID,群聊为群ID |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | String | 成功返回 |
代码示例
final conversationID = await OpenIM.iMManager.conversationManager.getConversationIDBySessionType(sourceID: sourceID, sessionType: sessionType);
//todo
函数原型
- (NSString *)getConversationIDBySessionType:(OIMConversationType)sessionType
sourceID:(NSString *)sourceID;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
sessionType | OIMConversationType | 是 | 会话类型 |
sourceID | NSString | 是 | 单聊为用户 ID,群聊为群ID |
返回结果
名称 | 类型 | 描述 |
---|---|---|
conversationID | NSString | 成功返回 |
代码示例
NSString *conversationID = [OIMManager.manager getConversationIDBySessionType:OIMConversationTypeC2C sourceID:@""];
函数原型
public String getConversationIDBySessionType(String sourceId, int sessionType)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
sessionType | OIMConversationType | 是 | 会话类型 |
sourceID | String | 是 | 单聊为用户 ID,群聊为群ID |
返回结果
名称 | 类型 | 描述 |
---|---|---|
conversationID | String | 成功返回 |
代码示例
String conversationID=OpenIMClient.getInstance().conversationManager.getConversationIDBySessionType(sourceID,sessionType)
函数原型
IMSDK.getConversationIDBySessionType({
sourceID: string;
sessionType: SessionType;
},operationID?: string): Promise<WsResponse<string>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) |
sessionType | SessionType | 是 | 会话类型 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<string>> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.getConversationIDBySessionType({
sourceID: 'user1',
sessionType: 1,
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('getConversationIDBySessionType', operationID: string, {
sourceID: string;
sessionType: SessionType;
}): Promise<string>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) |
sessionType | SessionType | 是 | 会话类型 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<string> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('getConversationIDBySessionType', IMSDK.uuid(), {
sourceID: 'user1',
sessionType: 1,
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.getConversationIDBySessionType({
sourceID: string,
sessionType: number,
}, operationID: string): Promise<string>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) |
sessionType | SessionType | 是 | 会话类型 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<string> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.getConversationIDBySessionType({
sourceID: 'user1',
sessionType: 1,
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
public static string GetConversationIdBySessionType(string sourceId, int sessionType)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
sourceId | string | 是 | 单聊为用户 ID,群聊为群ID |
sessionType | ConversationType | 是 | 会话类型 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
conversationId | string | 成功返回 |
代码示例
var conversationID =IMSDK.GetConversationIDBySessionType(sourceID,sessionType);