typingStatusUpdate
功能介绍
说明
发送正在输入状态,此时对方IM在线才会收到。
注意
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future typingStatusUpdate({
required String userID,
String? msgTip,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userID | String | 是 | 接收者的 ID |
msgTip | String | 是 | 自定义内容提示 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常则操作成功 |
代码示例
await OpenIM.iMManager.messageManager.typingStatusUpdate(userID: '',msgTip: 'typing');
// todo
函数原型
- (void)typingStatusUpdate:(NSString *)recvID
msgTip:(NSString *)msgTip
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
recvID | NSString | 是 | 接收者的 ID |
msgTip | NSString | 是 | 自定义内容提示 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager typingStatusUpdate:@""
msgTip:@""
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void typingStatusUpdate(OnBase<String> base, String userID, String msgTip)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
base | OnBase<String> | 是 | 回调接口 |
userID | String | 是 | 接收者的 ID |
msgTip | String | 是 | 自定义的提示信息 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常则操作成功 |
代码示例
OpenIMClient.getInstance().messageManager.typingStatusUpdate(new OnBase<String>() {
public void onError(int code, String error) {
}
public void onSuccess(String data) {
}
},userID, msgTip);
函数原型
IMSDK.typingStatusUpdate({
recvID: string;
msgTip: string;
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
recvID | string | 是 | 接收者 ID |
msgTip | string | 是 | 自定义内容提示 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
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 { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.typingStatusUpdate({
recvID: 'recvID',
msgTip: 'yes',
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('typingStatusUpdate', operationID: string, {
recvID: string;
msgTip: string;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
recvID | string | 是 | 接收者 ID |
msgTip | string | 是 | 自定义内容提示 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('typingStatusUpdate', IMSDK.uuid(), {
recvID: 'recvID',
msgTip: 'yes',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.typingStatusUpdate({
recvID: string,
msgTip: string,
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
recvID | string | 是 | 接收者 ID |
msgTip | string | 是 | 自定义内容提示 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.typingStatusUpdate({
recvID: 'recvID',
msgTip: 'yes',
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});