changeInputStates

功能介绍

说明

改变输入状态

注意

输入结束时，需要将focus值为false

iOS

函数原型

Future changeInputStates({
    required String conversationID,
    required bool focus,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
conversationID	String	是	会话 ID
focus	bool	是	是否正在输入

返回结果

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

代码示例

    await OpenIM.iMManager.conversationManager.changeInputStates(conversationID: conversationID, focus: focus);
    //todo

Android

函数原型

- (void)changeInputStates:(NSString *)conversationID
                    focus:(BOOL)focus
                 onSuccess:(nullable OIMSuccessCallback)onSuccess
                 onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
conversationID	NSString	是	会话 ID
focus	BOOL	是	是否正在输入

返回结果

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

代码示例

[OIMManager.manager changeInputStates:@"" 
                                focus:
                           onSuccess:^(NSString * _Nullable data) {

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

}];

Flutter

函数原型

public void changeInputState(OnBase<String> base, String conversionId, boolean focus)

输入参数

参数名称	参数类型	是否必填	描述
conversationID	String	是	会话 ID
focus	boolean	是	是否正在输入

返回结果

代码示例

OpenIMClient.getInstance().conversationManager.changeInputState(new OnBase<String>() {
    @Override
    public void onError(int code, String error) {
        // todo: 处理错误信息
    }
    @Override
    public void onSuccess(String data) {
        // todo: 请求成功
    }
}, conversationID , focus);

uni-app

函数原型

IMSDK.changeInputStates({
  conversationID: string,
  focus: boolean,
}, operationID?: string): Promise<WsResponse>

输入参数

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

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

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

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('changeInputStates', operationID: string, {
  conversationID: string,
  focus: boolean,
}): Promise<void>

输入参数

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

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

### 函数原型

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

输入参数

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

返回结果

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

代码示例

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

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

Unity

注意

未实现