interface.uts 8.4 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 2 3 4
/**
 * 错误码
 */
export type ChooseLocationErrorCode =
DCloud-yyl's avatar
DCloud-yyl 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
  /**
   * 取消
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.34"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.34"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "x",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.34"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
30 31
   */
  1 |
DCloud-yyl's avatar
DCloud-yyl 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
  /**
   * 框架内部错误
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.34"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.34"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "x",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.34"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
57 58
   */
  4;
DCloud-yyl's avatar
DCloud-yyl 已提交
59

DCloud-yyl's avatar
DCloud-yyl 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
export interface ChooseLocationSuccess extends AsyncApiSuccessResult {
  name : string,
  address : string,
  latitude : number,
  longitude : number
}
type ChooseLocationSuccessCallback = (result : ChooseLocationSuccess) => void

export interface ChooseLocationFail extends IUniError {
  errCode : ChooseLocationErrorCode
}
type ChooseLocationFailCallback = (result : ChooseLocationFail) => void

export type ChooseLocationComplete = AsyncApiResult
type ChooseLocationCompleteCallback = (result : ChooseLocationComplete) => void

/**
 * uni.chooseLocation函数参数定义
 */
export type ChooseLocationOptions = {
DCloud-yyl's avatar
DCloud-yyl 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
  /**
   * 指示位置的经度
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
105 106
   */
  latitude ?: number | null,
DCloud-yyl's avatar
DCloud-yyl 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
  /**
   * 指示位置的纬度
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
132 133
   */
  longitude ?: number | null,
DCloud-yyl's avatar
DCloud-yyl 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
  /**
   * 指示位置的名称
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
159
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  keyword ?: string | null,
  /**
   * 用户自定义参数
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.35"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.35"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.35"
   *    }
   * } 
   */
  payload ?: UTSJSONObject | null,
  /**
   * 接口调用成功的回调函数
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
213 214
   */
  success ?: ChooseLocationSuccessCallback | null,
DCloud-yyl's avatar
DCloud-yyl 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
  /**
   * 接口调用失败的回调函数
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
240 241
   */
  fail ?: ChooseLocationFailCallback | null,
DCloud-yyl's avatar
DCloud-yyl 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
  /**
   * 接口调用结束的回调函数(调用成功、失败都会执行)
   * @uniPlatform {
   *    "app": {
   *      "android": {
   *        "osVer": "5.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "ios": {
   *        "osVer": "12.0",
   *        "uniVer": "√",
   *        "unixVer": "4.33"
   *      },
   *      "harmony": {
   *        "osVer": "3.0",
   *        "uniVer": "4.23",
   *        "unixVer": "x"
   *      }
   *    },
   *    "web": {
   *      "uniVer": "√",
   *      "unixVer": "4.0"
   *    }
   * } 
DCloud-yyl's avatar
DCloud-yyl 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279 280
   */
  complete ?: ChooseLocationCompleteCallback | null
};

/**
 * 打开地图选择位置
 *
 * @param {ChooseLocationOptions} options
 * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/prompt.html#chooselocation
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
DCloud-yyl's avatar
DCloud-yyl 已提交
281
 *            "unixVer": "4.33"
DCloud-yyl's avatar
DCloud-yyl 已提交
282 283 284 285
 *        },
 *        "ios": {
 *            "osVer": "12.0",
 *            "uniVer": "√",
DCloud-yyl's avatar
DCloud-yyl 已提交
286 287
 *            "unixVer": "4.33"
 *        },
DCloud-yyl's avatar
DCloud-yyl 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
 *    "harmony": {
 *      "osVer": "3.0",
 *      "uniVer": "4.23",
 *      "unixVer": "x"
 *    }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type ChooseLocation = (options : ChooseLocationOptions) => void;

export interface Uni {
  /**
   * @description 打开地图选择位置
   * @example
   * ```typescript
    uni.chooseLocation({
      success: (res) => {
        console.log('res: ', res)
      },
      fail: (err) => {
        console.log('err: ', err)
      },
      complete: (res) => {
        console.log('complete: ', res)
      }
    });
   * ```
   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/choose-location.html
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "4.33"
   *        },
   *        "ios": {
   *            "osVer": "12.0",
   *            "uniVer": "√",
   *            "unixVer": "4.33"
   *        },
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  chooseLocation(options : ChooseLocationOptions) : void;
}
// #ifdef APP-ANDROID
// @ts-expect-error
export class ChooseLocationSuccessImpl extends AsyncApiSuccessResult implements ChooseLocationSuccess {
  name : string
  address : string
  latitude : number
  longitude : number
  // @ts-expect-error
  override errMsg : string
  constructor(name : string, address : string, latitude : number, longitude : number, errMsg : string = 'chooseLocation:ok') {
    super()
    this.errMsg = errMsg
    this.name = name
    this.address = address
    this.latitude = latitude
    this.longitude = longitude
  }
DCloud-yyl's avatar
DCloud-yyl 已提交
363
}
DCloud-yyl's avatar
DCloud-yyl 已提交
364 365
export class ChooseLocationFailImpl extends UniError implements ChooseLocationFail {
  override errCode : ChooseLocationErrorCode
DCloud-yyl's avatar
DCloud-yyl 已提交
366 367 368 369
  constructor(errMsg : string = 'chooseLocation:fail cancel', errCode : ChooseLocationErrorCode = 1) {
    super()
    this.errCode = errCode
    this.errMsg = errMsg
DCloud-yyl's avatar
DCloud-yyl 已提交
370 371 372
  }
}
// #endif