API 接口文档

API 接口文档

接口类说明

本文档所有接口所涉及的相关类及说明如下:

接口 说明
OneID SDK 功能接口类,用于调用SDK相关功能

初始化

类名 OneID
接口 function init(obj: {appId: string,onSuccess: (res: any) => void,onFailure: (res: any) => void}): void

说明:

初始化SDK,获取OneID。

参数:

appId:应用的 个推appId
onSuccess: 初始化成功回调结果
onFailure: 初始化失败回调结果

获取版本号

类名 OneID
接口 function getVersion(): string

说明:

获取当前SDK版本

场景查询

类名 OneID
接口 function queryLBS(timeout: number, obj: {onSuccess: (res: any) => void,onFailure: (res: any) => void}): void

说明:

场景查询

参数:

timeout: GPS定位超时时间设置,单位秒,最低可设置5,建议设置20
onSuccess: 查询成功回调结果
onFailure: 查询失败回调结果

说明:

  • H5平台下,timeout建议设置久一些,需要预留时间给用户点击授权弹窗。
  • H5平台下,SDK会主动获取定位权限;其他平台下SDK不会主动获取定位权限,需要开发者发起定位授权,SDK会根据当前用户的授权状态来进行查询。
  • 未授权定位\定位失败\定位超时等,都将使用ip进行场景查询。

回调参数:

requestId:单次请求ID
sceneInfo:场景信息
coarseAddress:粗略位置
addressCode:位置代码

{
  "requestId": "xxxxxxxxf0eb4432897d6be2xxxxxxxx",
  "poiSceneInfoList": [  //POI场景信息列表
    {
      "sceneTypeList": [
        {   //一级分类,指该位置所属的场景的类型,如:交通设施服务、购物服务、餐饮服务等。
          "st1": "餐饮服务"
        }
      ]
    }
  ],
  "aoiSceneInfoList": [  //AOI场景信息列表
    {
      "sceneTypeList": [
        {   //一级分类,指该位置所属的场景的类型,如:交通设施服务、购物服务、餐饮服务等。
          "st1": "购物服务"
        }
      ]
    }
  ],
  "sceneInfoList": [ //场景信息列表(POI场景信息列表和AOI场景信息列表都为空时,才会返回此项,准确度较低)
    {
      "sceneTypeList": [
        {    //一级分类,指该位置所属的场景的类型,如:交通设施服务、购物服务、餐饮服务等。
          "st1": "科教文化服务"
        }
      ]
    }
  ],
  "coarseAddress": "xxxxxx",
  "addressCode": {
    //省Code    
    "province": "450000",
    //市Code    
    "city": "450100",
    //区Code    
    "area": "450108"
  }
}

具体开通联系右侧技术支持,或对应商务

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询