pinConversation

功能介绍

说明

置顶会话或取消置顶。

注意

相关回调：
onConversationChanged

iOS

函数原型

Future pinConversation({
    required String conversationID,
    required bool isPinned,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
conversationID	String	是	会话 ID
isPinned	bool	是	是否置顶

返回结果

名称	类型	描述
~	~	无异常抛出则操作成功

代码示例

    await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned);
    //todo

Android

函数原型

- (void)pinConversation:(NSString *)conversationID
               isPinned:(BOOL)isPinned
              onSuccess:(nullable OIMSuccessCallback)onSuccess
              onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
conversationID	NSString	是	会话 ID
isPinned	BOOL	是	是否置顶

返回结果

名称	类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager pinConversation:@""
                           isPinned:YES
                          onSuccess:^(NSString * _Nullable data) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

函数原型

public void pinConversation(OnBase<String> callBack, String conversationID, boolean isPinned)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<String>	是	回调接口
conversationID	String	是	会话 ID
isPinned	bool	是	是否置顶

代码示例

        OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase<String>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(String data) {

            }
        },conversationID,isPinned);

uni-app

函数原型

IMSDK.pinConversation({
    conversationID: string;
    isPinned: boolean;
},operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
conversationID	string	是	会话 ID
isPinned	boolean	是	是否置顶

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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.pinConversation({
  conversationID: 'conversationID',
  isPinned: true,
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('pinConversation', operationID: string, {
  conversationID: string;
  isPinned: boolean;
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
conversationID	string	是	会话 ID
isPinned	boolean	是	是否置顶

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('pinConversation', IMSDK.uuid(), {
  conversationID: 'conversationID',
  isPinned: true,
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.pinConversation({
  conversationID: string,
  isPinned: boolean,
},operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
conversationID	string	是	会话 ID
isPinned	boolean	是	是否置顶
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.pinConversation({
  conversationID: 'conversationID',
  isPinned: true,
}, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnSucOrError	是	回调接口
conversationID	string	是	会话 ID
isPinned	bool	是	是否置顶

代码示例

IMSDK.((suc,errCode,errMsg)=>{

},conversationID,isPinned);