地理围栏

接口声明

在manifest.json文件的 features属性中增加如下配置。

{ "name": "service.awareness" }

导入模块

在调用接口页面的<script>部分增加如下配置。

import awareness from '@service.awareness'

或

var awareness = require('@service.awareness')

使用限制

接口定义

[h2]awareness.getProvider()

描述

获取服务提供商。

返回值

字符串，服务提供商的代号，如厂商的英文品牌名称，如果无此服务则返回空字符串。返回空字符串时，请勿调用该服务其他接口，否则将抛出异常。

示例代码

awareness.getProvider();

[h2]awareness.addBarrier(OBJECT)

描述

添加围栏，该接口只有在获得用户同意获得位置信息后才可以使用。

OBJECT参数

fail返回错误代码

示例代码

awareness.addBarrier({
  appId: "101449471",
  key: "enterLocationBarrier",
  autoRemove: true,
  success: function (data) {
    console.log(JSON.stringify(data));
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ", code = " + code));
  }
})

[h2]awareness.deleteBarrier(OBJECT)

描述

删除围栏。

OBJECT参数

fail返回错误代码

示例代码

awareness.deleteBarrier({
  appId: "101449471",
  key: "enterLocationBarrier",
  success: function (data) {
    console.log(JSON.stringify(data));
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ", code = " + code));
  }
})

[h2]awareness.getBarrierLastStatus(OBJECT)

描述

查询围栏状态。

OBJECT参数

success返回值

fail返回错误代码

示例代码

awareness.getBarrierLastStatus({
  appId: '101449471',
  key: 'enterLocationBarrier',
  success: function (data) {
    console.log(data.status);
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ', code = ' + code));
  }
})

[h2]awareness.enterLocationBarrier(OBJECT)

描述

进入围栏。

OBJECT参数

notification说明

clickAction说明

fail返回错误代码

示例代码

awareness.enterLocationBarrier({
  notification: {
    contentTitle: 'title',
    contentText: 'content',
    clickAction: {
      uri: '/index.html?index=1'
    }
  },
  key: "enterLocationBarrier",
  latitude: "31.976427",
  longitude: "118.75277",
  radius: "200",
  success: function (data) {
    console.log(JSON.stringify(data));
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ", code = " + code));
  }
})

[h2]awareness.exitLocationBarrier(OBJECT)

描述

离开围栏。

OBJECT参数

fail返回错误代码

示例代码

awareness.exitLocationBarrier({
  notification: {
    contentTitle: 'title',
    contentText: 'content',
    clickAction: {
      uri: '/index.html?index=1'
    }
  },
  key: "exitLocationBarrier",
  latitude: "31.976427",
  longitude: "118.75277",
  radius: "200",
  success: function (data) {
    console.log(JSON.stringify(data));
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ", code = " + code));
  }
})

[h2]awareness.stayLocationBarrier(OBJECT)

描述

停留在围栏中。添加围栏后，如果用户处于此围栏中，则围栏状态为true；如果用于处于围栏外，然后进入围栏中停留超过指定时间，则围栏状态也为true，并触发停留围栏事件。

OBJECT参数

fail返回错误码

示例代码

awareness.stayLocationBarrier({
 notification: {
    contentTitle: 'title',
    contentText: 'content',
    clickAction: {
      uri: '/index.html?index=1'
    }
  },
  key: "stayLocationBarrier",
  latitude: "31.976427",
  longitude: "118.75277",
  radius: "200",
  timeOfDuration: "30000",
  success: function (data) {
    console.log(JSON.stringify(data));
  },
  fail: function (data, code) {
    console.log(JSON.stringify(data + ", code = " + code));
  }
})

Tips

各接口存在调用的顺序关系，一般先调用 awareness.enterLocationBarrier 准备好进入围栏的信息，待接口返回成功后，调用 awareness.addBarrier 添加围栏（addBarrier传入的key值必须与enterLocationBarrier的key值保持一致），添加完围栏后，可以再删除或者查询对应的围栏。