Response

功能介绍

信息

uni-app、JS SDK Promise 函数回调通用参数说明。

uni-app

CatchResponse

类型

type CatchResponse = {
  errCode: number;
  errMsg: string;
};

字段说明

字段名称	字段类型	描述
errCode	number	调用失败时的错误码
errMsg	string	调用失败时的错误描述信息

Browser/Electron/MiniProgram

OpenIMApiError

类型

export class OpenIMApiError extends Error {
  name: string = 'OpenIMApiError';
  code: number;
  message: string;
  operationID: string;

  constructor(code: number, message: string, operationID: string) {
    super(message);
    this.code = code;
    this.message = message;
    this.operationID = operationID;
  }
}

字段说明

字段名称	字段类型	描述
name	string	错误名称
code	number	调用失败时的错误码
message	string	调用失败时的错误描述信息
operationID	string	调用时传入的 operationID

React-Native

WsResponse

类型

type WsResponse<T = unknown> = {
  errCode: number;
  errMsg: string;
  data: T;
  operationID: string;
};

字段说明

字段名称	字段类型	描述
errCode	number	调用失败时的错误码
errMsg	string	调用失败时的错误描述信息
operationID	string	调用时传入的 operationID
data	T	调用成功时的返回结果，作为泛型

WSEvent

类型

type WSEvent<T = unknown> = {
  event: CbEvents;
  data: T;
  errCode: number;
  errMsg: string;
  operationID: string;
};

字段说明

字段名称	字段类型	描述
event	CbEvents	监听事件
data	T	回调结果，作为泛型
errCode	number	错误码
errMsg	string	错误描述信息
operationID	string	唯一操作 id