unsubscribeUsersStatus
功能介绍
说明
取消订阅指定用户的在线状态。
注意
取消后,对方的上下线不再通知。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future unsubscribeUsersStatus(
List<String> userIDs, {
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userIDs | List<String> | 是 | 用户 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
then | void | 调用成功回调 |
onError | Function | 调用失败回调 |
代码示例
await OpenIM.iMManager.userManager.unsubscribeUsersStatus([]);
// todo
函数原型
- (void)unsubscribeUsersStatus:(NSArray<NSString *> *)userIDs
onSuccess:(nullable OIMUserStatusInfosCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userIDs | NSArray<NSString *> | 是 | 用户 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager unsubscribeUsersStatus:@[]
onSuccess:^(NSString * _Nullable result) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void unsubscribeOnlineUsersStatus(OnBase<String> callBack, List<String> uid)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | OnBase<List<UsersOnlineStatus>> | 是 | 用户 ID |
ids | List<String> | 是 | 用户 ID |
代码示例
OpenIMClient.getInstance().userInfoManager.unsubscribeOnlineUsersStatus(new OnBase<List<UsersOnlineStatus>>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(List<UsersOnlineStatus> data) {
}
},ids);
// todo
函数原型
IMSDK.unsubscribeUsersStatus(userIDList: string[], operationID?: string): Promise<WsResponse<UserOnlineState[]>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userIDList | string[] | 是 | 用户 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<UserOnlineState[]>> | 用户在线状态详情列表 |
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.unsubscribeUsersStatus()
.then(({ data }) => {
// data: 用户在线状态详情列表
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('unsubscribeUsersStatus', operationID: string, userIDList: string[]): Promise<UserOnlineState[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
userIDList | string[] | 是 | 用户 ID 列表 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<UserOnlineState[]> | 用户在线状态详情列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('unsubscribeUsersStatus', IMSDK.uuid())
.then((data) => {
// data: 用户在线状态详情列表
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID: string): Promise<UserOnlineState[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userIDList | string[] | 是 | 用户 ID 列表 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<UserOnlineState[]> | 用户在线状态详情列表 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.unsubscribeUsersStatus(userIDList, 'operationID');
.then((data) => {
// data: 用户在线状态详情列表
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});