uploadLogs

功能介绍

说明

上传SDK日志到服务器用于问题分析定位，line为上传行数，当line为0时上传所有日志。

注意

该接口待更新。

iOS

函数原型

   Future uploadLogs({
    String? ex,
    int line = 0,
    String? operationID,
  })

输入参数

无

返回结果

参数名称	参数类型	描述
~	~	无异常抛出则返回成功

代码示例

    await OpenIM.iMManager.uploadLogs();
    // todo

Android

函数原型

- (void)uploadLogsWithProgress:(OIMUploadProgressCallback)onProgress
                          line:(NSInteger )line
                            ex:(NSString *)ex
                     onSuccess:(OIMSuccessCallback)onSuccess
                     onFailure:(OIMFailureCallback)onFailure;

输入参数

无

返回结果

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

代码示例

[OIMManager.manager uploadLogsWithProgress:^(NSInteger saveBytes, NSInteger currentBytes, NSInteger totalBytes) {
            
} line:0 ex:nil onSuccess:^(NSString * _Nullable data) {
    
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
    
}];

Flutter

函数原型

public void getSelfUserInfo(OnBase<UserInfo> callBack)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<UserInfo>	是	回调接口

返回结果

代码示例

OpenIMClient.getInstance().friendshipManager.getSelfUserInfo(new OnBase<UserInfo>(){…})

uni-app

注意

@openim/client-sdk 和 @openim/wasm-client-sdk 不提供该方法。只有在electron中引入 @openim/electron-client-sdk 采用了 ffi 的方式，才可以调用。

函数原型

IMSDK.uploadLogs({
  line: number,
  ex: string,
}, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
line	number	是	从后往前上传的行数
ex	string	是	额外字段
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

// use in electron with ffi
import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
const { instance: IMSDK } = getWithRenderProcess();

IMSDK.uploadLogs({ line: 10000, ex: "" })
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron

函数原型

IMSDK.asyncApi('uploadLogs', operationID: string, {
  line: number,
  ex: string,
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
line	number	是	从后往前上传的行数
ex	string	是	额外字段
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('uploadLogs', IMSDK.uuid(), { line: 10000, ex: "" })
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.uploadLogs({
  line: number,
  ex: string,
}, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
line	number	是	从后往前上传的行数
ex	string	是	额外字段
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDKRN.uploadLogs({ line: 10000, ex: "" }, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });