更新记录

1.0.1（2025-04-03）

增加Android和iOS端定位功能接口。

1.0.0（2025-03-21）

新版发布

平台兼容性

高德定位UTS插件接口文档

1. 高德定位UTS插件

<script>

    //高德定位UTS插件
    import * as AMapLoc from "@/uni_modules/Lizii-AMapLoc";

    export default {
    }

</script>

2. 设置高德key(必须)

<script>

    //高德定位UTS插件
    import * as AMapLoc from "@/uni_modules/Lizii-AMapLoc";

    export default {

        onLoad() {

            //设置高德key
            let apiKey = "xxx";
            AMapLoc.setApiKey(apiKey);
        }
    }

</script>

3. 隐私合规检查接口(必须)

<script>

    //高德定位UTS插件
    import * as AMapLoc from "@/uni_modules/Lizii-AMapLoc";

    export default {

        onLoad() {

            //设置高德key
            let apiKey = "xxx";
            AMapLoc.setApiKey(apiKey);

            //隐私合格检查接口
            let isContains = true;
            let isShow = true;
            AMapLoc.updatePrivacyShow(isContains, isShow);
            let isAgree = true;
            AMapLoc.updatePrivacyAgree(isAgree);
        }
    }

</script>

4. 检查定位服务是否打开

//检查定位服务是否打开
var enable = AMapLoc.locationServicesEnabled();//true:定位服务打开 false:定位服务关闭

5. 进入打开定位服务界面

//进入打开定位服务界面
AMapLoc.openLocationSetting();

6. 检查定位权限

//检查定位权限是否授权，并申请定位权限
AMapLoc.checkLocationPermission(function(res){
    console.log(res);
    if (res.result == true) {

    } else {
        //打开app设置界面 设置始终定位权限
        AMapLoc.openAppSetting();
    }
});

7. 检查始终允许后台定位权限

//检查始终允许后台定位权限
AMapLoc.checkAlwaysLocationPermission(function(res){
    console.log(res);
    if (res.result == true) {

    } else {
        //打开app设置界面 设置始终允许后台定位
        AMapLoc.openAppSetting();
    }
});

8. 打开app设置界面

打开app设置界面
AMapLoc.openAppSetting();

9. 单次定位

//单次定位
AMapLoc.getLocation({
    needAddress:true//是否需要解析地址
}, function(res){
    console.log(res);
    if (res.type == "onLocationData") {
        let latitude = res.data.latitude;//纬度
        let longitude = res.data.longitude;//经度
        let altitude = res.data.altitude;//海拔
        let speed = res.data.speed;//速度
        let bearing = res.data.bearing;//方向
        let time = res.data.time;//方向
        //逆地址信息，当needAddress:true返回以下信息
        let address = res.data.address;//地址
        let country = res.data.country;//国家
        let province = res.data.province;//省/直辖市
        let city = res.data.city;//城市
        let cityCode = res.data.cityCode;//城市编码
        let district = res.data.district;//区
        let adCode = res.data.adCode;//区编码
        let street = res.data.street;//街道名称
        let streetNum = res.data.streetNum;//门牌号
        let aoiName = res.data.aoiName;//所属兴趣点名称
        let poiName = res.data.poiName;//兴趣点名称
    } else if (res.type == "onLocationError") {
        let errorCode = res.data.errorCode;//错误码
        let errorInfo = res.data.errorInfo;//错误消息
    }
});

10. 开启持续定位

//开启持续定位
AMapLoc.startLocation({
    needAddress:true,//是否需要解析地址
    allowsBackgroundLocationUpdates:true,//是否允许后台定位，仅iOS和鸿蒙支持
    interval:2000,//定位时间间隔 单位是毫秒，仅Android和鸿蒙支持
    distanceFilter:0//位置报告距离间隔 单位是米
}, function(res){
    console.log(res);
    if (res.type == "onLocationChanged") {
        let latitude = res.data.latitude;//纬度
        let longitude = res.data.longitude;//经度
        let altitude = res.data.altitude;//海拔
        let speed = res.data.speed;//速度
        let bearing = res.data.bearing;//方向
        let time = res.data.time;//方向
        //逆地址信息，当needAddress:true返回以下信息
        let address = res.data.address;//地址
        let country = res.data.country;//国家
        let province = res.data.province;//省/直辖市
        let city = res.data.city;//城市
        let cityCode = res.data.cityCode;//城市编码
        let district = res.data.district;//区
        let adCode = res.data.adCode;//区编码
        let street = res.data.street;//街道名称
        let streetNum = res.data.streetNum;//门牌号
        let aoiName = res.data.aoiName;//所属兴趣点名称
        let poiName = res.data.poiName;//兴趣点名称
    } else if (res.type == "onLocationError") {
        let errorCode = res.data.errorCode;//错误码
        let errorInfo = res.data.errorInfo;//错误消息
    }
});

11. 停止持续定位

//停止持续定位
AMapLoc.stopLocation();

12. 开启后台定位任务，该接口仅Android和鸿蒙支持

startBackgroundLocationTask() {
    if (uni.getSystemInfoSync().platform == 'android') {
        //检查是否允许通知，oppo vivo等部分手机默认不允许通知
        if (AMapLoc.areNotificationsEnabled()) {
            //是否忽略电池优化，vivo部分手机需要忽略电池优化，保活才不被杀掉
            if (AMapLoc.isIgnoringBatteryOptimizations()) {
                AMapLoc.enableBackgroundLocation({
                    contentTitle:"默认app名称",
                    contentText:"正在后台运行"
                });
                //部分机型需要app打开自启动或允许后台实时活动
                //AMapLoc.openAutoStartSetting();
            } else {
                //请求忽略电池优化
                AMapLoc.requestIgnoreBatteryOptimizations();
            }
        } else {
            //打开设置通知
            AMapLoc.openNotifySetting();
        }
    } else if (uni.getSystemInfoSync().platform == 'harmonyos') {
        //开启后台定位任务
        //如需在后台定位（后台定位需后台定位、后台运行权限），则要在应用切入后台前调用开启后台定位任务，
        AMapLoc.startContinuousTask();
    }
}

13. 停止后台定位任务，该接口仅Android和鸿蒙支持

stopBackgroundLocationTask() {
    if (uni.getSystemInfoSync().platform == 'android') {
        //停止后台保活定位服务
        var removeNotification = true;
        AMapLoc.disableBackgroundLocation(removeNotification);
    } else if (uni.getSystemInfoSync().platform == 'harmonyos') {
        //停止后台定位任务
        //回到前台可以停止后台任务
        AMapLoc.stopContinuousTask();
    }
}