pinConversation
Feature Introduction
Description
Pin or unpin a conversation.
Note
Related Callback:
onConversationChanged
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
Function Prototype
Future pinConversation({
required String conversationID,
required bool isPinned,
String? operationID,
})
Input Parameters
Parameter Name | Data Type | Mandatory | Description |
---|---|---|---|
conversationID | String | Yes | Conversation ID |
isPinned | bool | Yes | Pin status |
Return Result
Name | Type | Description |
---|---|---|
~ | ~ | Successful if no exception thrown |
Code Example
await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned);
//todo
Function Prototype
- (void)pinConversation:(NSString *)conversationID
isPinned:(BOOL)isPinned
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
Input Parameters
Parameter Name | Data Type | Mandatory | Description |
---|---|---|---|
conversationID | NSString | Yes | Conversation ID |
isPinned | BOOL | Yes | Pin status |
Return Result
Name | Type | Description |
---|---|---|
onSuccess | OIMSuccessCallback | Success return |
onFailure | OIMFailureCallback | Failure return |
Code Example
[OIMManager.manager pinConversation:@""
isPinned:YES
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
Function Prototype
public void pinConversation(OnBase<String> callBack, String conversationID, boolean isPinned)
Input Parameters
Parameter Name | Data Type | Mandatory | Description |
---|---|---|---|
callBack | OnBase<String> | Yes | Callback interface |
conversationID | String | Yes | Conversation ID |
isPinned | bool | Yes | Pin status |
Code Example
OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase<String>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(String data) {
}
},conversationID,isPinned);
Function Prototype
IMSDK.pinConversation({
conversationID: string;
isPinned: boolean;
},operationID?: string): Promise<WsResponse>
Input Parameters
Parameter Name | Data Type | Mandatory | Description |
---|---|---|---|
conversationID | string | Yes | Conversation ID |
isPinned | boolean | Yes | Pin status |
Return Result
Parameter Name | Data Type | Description |
---|---|---|
Promise.then() | Promise<WsResponse> | Success callback |
Promise.catch() | Promise<WsResponse> | Failure callback |
Code Example
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 }) => {
// Successful call
})
.catch(({ errCode, errMsg }) => {
// Failed call
});
Function Prototype
ts showLineNumbers
IMSDK.asyncApi('pinConversation', operationID: string, {
conversationID: string;
isPinned: boolean;
}): Promise<void>
Input Parameters
Parameter Name | Data Type | Mandatory | Description |
---|---|---|---|
operationID | string | Yes | Operation ID, used for troubleshooting. Suggested to use current time and random number |
conversationID | string | Yes | Conversation ID |
isPinned | boolean | Yes | Pin status |
Return Result
Use the
openim-uniapp-polyfill
package to Promise the function. When calling, usethen
andcatch
to judge and handle success and failure callbacks.
Parameter Name | Data Type | Description |
---|---|---|
Promise.then() | Promise<void> | Success callback |
Promise.catch() | Promise<CatchResponse> | Failure callback |
Code Example
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('pinConversation', IMSDK.uuid(), {
conversationID: 'conversationID',
isPinned: true,
})
.then(() => {
// Successful call
})
.catch(({ errCode, errMsg }) => {
// Failed call
});
Function Prototype
OpenIMSDKRN.pinConversation({
conversationID: string,
isPinned: boolean,
},operationID: string): Promise<void>
Input Parameters
Parameter Name | Parameter Type | Mandatory | Description |
---|---|---|---|
conversationID | string | Yes | Conversation ID |
isPinned | boolean | Yes | Whether pin |
operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number |
Return Result
Parameter Name | Parameter Type | Description |
---|---|---|
Promise.then() | Promise<void> | Callback on successful call |
Promise.catch() | Promise<CatchResponse> | Callback on failed call |
Code Example
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.pinConversation({
conversationID: 'conversationID',
isPinned: true,
}, 'operationID')
.then(() => {
// Successful call
})
.catch(({ errCode, errMsg }) => {
// Failed call
});
Function Prototype
public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned)
Input Parameter
Parameter Name | Parameter Type | Mandatory | Description |
---|---|---|---|
cb | OnSucOrError | Yes | Callback |
conversationID | string | Yes | Conversation ID |
isPinned | bool | Yes | Whether pin |
Code Example
IMSDK.((suc,errCode,errMsg)=>{
},conversationID,isPinned);