zhizhi/node_modules/dingtalk-jsapi/api/biz/map/search.d.ts

51 lines
1.5 KiB
TypeScript
Raw Normal View History

/**
*
* @apiName biz.map.search
*/
export interface IBizMapSearchParams {
/** 非必须字段需要和longitude组合成合法经纬度高德坐标 */
latitude: number;
/** 非必须字段需要和latitude组合成合法经纬度高德坐标 */
longitude: number;
/** 搜索范围建议不要设置过低否则可能搜索不到POI */
scope: number;
}
/**
*
* @apiName biz.map.search
*/
export interface IBizMapSearchResult {
/** POI所在省会可能为空 */
province: string;
/** POI所在省会编码可能为空 */
provinceCode: string;
/** POI所在城市可能为空 */
city: string;
/** POI所在城市的编码可能为空 */
cityCode: string;
/** POI所在区可能为空 */
adName: string;
/** POI所在区的编码可能为空 */
adCode: string;
/** POI与设备位置的距离 */
distance: string;
/** POI的邮编可能为空 */
postCode: string;
/** POI的街道地址可能为空 */
snippet: string;
/** POI的名称 */
title: string;
/** POI的纬度高德坐标 */
latitude: number;
/** POI的经度高德坐标 */
longitude: number;
}
/**
*
* POI
* @apiName biz.map.search
* @supportVersion ios: 2.4.0 android: 2.4.0
*/
export declare function search$(params: IBizMapSearchParams): Promise<IBizMapSearchResult>;
export default search$;