interface.uts 1.9 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 2 3 4 5 6 7
/**
 * uni.exit成功回调参数
 */
export type ExitSuccess = {
  errMsg: string
}

DCloud-yyl's avatar
DCloud-yyl 已提交
8 9 10
/**
 * 错误码
 */
DCloud-yyl's avatar
DCloud-yyl 已提交
11 12 13 14 15 16 17 18
export type ExitErrorCode =
/**
 * 系统不支持
 */
12001 |
/**
 * 未知错误
 */
DCloud-yyl's avatar
DCloud-yyl 已提交
19 20 21 22 23
12002 |
/**
 * iOS平台,仅在uni-app x SDK模式中支持应用退出
 */
12003
DCloud-yyl's avatar
DCloud-yyl 已提交
24 25 26 27 28 29 30 31 32

/**
 * uni.exit失败回调参数
 */
export interface IExitError extends IUniError {
	errCode: ExitErrorCode
}
export type ExitFail = IExitError

DCloud-yyl's avatar
DCloud-yyl 已提交
33 34 35 36 37 38 39
/**
 * uni.exit成功回调函数定义
 */
export type ExitSuccessCallback = (res: ExitSuccess) => void
/**
 * uni.exit失败回调函数定义
 */
DCloud-yyl's avatar
DCloud-yyl 已提交
40
export type ExitFailCallback = (res: ExitFail) => void
DCloud-yyl's avatar
DCloud-yyl 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * uni.exit完成回调函数定义
 */
export type ExitCompleteCallback = (res: any) => void

/**
 * uni.exit参数定义
 */
export type ExitOptions = {
  /**
   * 接口调用成功的回调函数
   */
  success?: ExitSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ExitFailCallback | null,
  /**
   * 接口调用结束的回调函数(调用成功、失败都会执行)
   */
  complete?: ExitCompleteCallback | null
}


export interface Uni {

  /**
   * 退出当前应用
DCloud-yyl's avatar
DCloud-yyl 已提交
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
   * @uniPlatform 
    {
      "app": {
        "android": {
          "osVer": "5.0",
          "uniVer": "3.8.15",
          "uniUtsPlugin": "3.91",
          "unixVer": "3.91",
          "unixUtsPlugin": "3.91"
        },
        "ios": {
          "osVer": "x",
          "uniVer": "x",
          "uniUtsPlugin": "x",
          "unixVer": "4.33",
          "unixUtsPlugin": "4.33"
        },
        "harmony": {
          "osVer": "3.0",
          "uniVer": "4.23",
          "unixVer": "x"
        }
      },
      "web": {
        "uniVer": "x",
        "unixVer": "x"
      }
    }
DCloud-yyl's avatar
DCloud-yyl 已提交
97 98 99 100 101 102
   * @uniVueVersion 2,3  //支持的vue版本
   */
  exit(options?: ExitOptions | null):void;
}

export type Exit = (options?: ExitOptions | null) => void;