com.jfinal.weixin.sdk.api.shakearound

## 类 ShakeAroundDeviceApi

- java.lang.Object
- - com.jfinal.weixin.sdk.api.shakearound.ShakeAroundDeviceApi

-     public class ShakeAroundDeviceApi
      extends Object

  周边-设备管理
  作者:
    L.cm

- - ### 构造器概要

    构造器
    构造器和说明
    `ShakeAroundDeviceApi()`

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static ApiResult` | `addDeviceToGroup(int groupId, List<DeviceIdentifier> deviceIdentifierList)` 添加设备到分组，每个分组能够持有的设备上限为10000，并且每次添加操作的添加上限为1000。
    `static ApiResult` | `addGroup(String groupName)` 新建设备分组，每个帐号下最多只有1000个分组。
    `static ApiResult` | `applyId(int quantity, String applyReason, String comment, Integer poiId)` 申请配置设备所需的UUID、Major、Minor。
    `static ApiResult` | `bindLocation(DeviceIdentifier deviceIdentifier, String poiId)` 配置设备与门店的关联关系 支持创建门店后直接关联在设备上，无需为审核通过状态，摇周边后台自动更新门店的最新信息和状态。
    `static ApiResult` | `bindPage(DeviceIdentifier deviceIdentifier, int... pageIds)` 配置设备与页面的关联关系。
    `static ApiResult` | `deleteDeviceFromGroup(int groupId, List<DeviceIdentifier> deviceIdentifierList)` 从分组中移除设备，每次删除操作的上限为1000。
    `static ApiResult` | `deleteGroup(int groupId)` 删除设备分组，若分组中还存在设备，则不能删除成功。
    `static ApiResult` | `getApplyStatus(int applyId)` 查询设备ID申请的审核状态。
    `static ApiResult` | `getGroupDetail(int groupId, int begin, int count)` 查询分组详情，包括分组名，分组id，分组里的设备列表。
    `static ApiResult` | `getGroupList(int begin, int count)` 查询账号下所有的分组。
    `static ApiResult` | `searchByDevice(DeviceIdentifier deviceIdentifier)` 查询设备列表
    `static ApiResult` | `searchPage(int begin, int count)` 需要分页查询或者指定范围内的设备时
    `static ApiResult` | `searchPage(int applyId, int begin, int count)` 根据批次id查找
    `static ApiResult` | `searchRelation(DeviceIdentifier deviceIdentifier, int type)` 查询设备与页面的关联关系。
    `static ApiResult` | `updateDeviceInfo(DeviceIdentifier deviceIdentifier, String comment)` 编辑设备的备注信息。
    `static ApiResult` | `updateGroup(int groupId, String groupName)` 编辑设备分组信息，目前只能修改分组名。

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### ShakeAroundDeviceApi

          public ShakeAroundDeviceApi()

  - ### 方法详细资料

    - #### applyId

          public static ApiResult applyId(int quantity,
                                          String applyReason,
                                          String comment,
                                          Integer poiId)

      申请配置设备所需的UUID、Major、Minor。申请成功后返回批次ID，可用返回的批次ID通过“查询设备ID申请状态”接口查询目前申请的审核状态。 若单次申请的设备ID数量小于500个，系统会进行快速审核；若单次申请的设备ID数量大于等 500个 ，会在三个工作日内完成审核。
      参数:
        `quantity` - 申请的设备ID的数量，单次新增设备超过500个，需走人工审核流程
        `applyReason` - 申请理由，不超过100个汉字或200个英文字母
        `comment` - 备注，可为空，不超过15个汉字或30个英文字母
        `poiId` - 设备关联的门店ID，可为空，关联门店后，在门店1KM的范围内有优先摇出信息的机会。门店相关信息具体可查看：https://mp.weixin.qq.com/zh_CN/htmledition/comm_htmledition/res/store_manage/store_manage_file.zip
      返回:
        {ApiResult}

    - #### getApplyStatus

          public static ApiResult getApplyStatus(int applyId)

      查询设备ID申请的审核状态。若单次申请的设备ID数量小于等于500个， 系统会进行快速审核；若单次申请的设备ID数量大于500个，则在三个工作日内完成审核。
      参数:
        `applyId` - 批次ID，申请设备ID时所返回的批次ID
      返回:
        {ApiResult}

    - #### updateDeviceInfo

          public static ApiResult updateDeviceInfo(DeviceIdentifier deviceIdentifier,
                                                   String comment)

      编辑设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。
      参数:
        `deviceIdentifier` - 设备信息
        `comment` - 设备的备注信息，不超过15个汉字或30个英文字母。
      返回:
        {ApiResult}

    - #### bindLocation

          public static ApiResult bindLocation(DeviceIdentifier deviceIdentifier,
                                               String poiId)

      配置设备与门店的关联关系 支持创建门店后直接关联在设备上，无需为审核通过状态，摇周边后台自动更新门店的最新信息和状态。
      参数:
        `deviceIdentifier` - 设备信息
        `poiId` - 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会。当值为0时，将清除设备已关联的门店ID。门店相关信息具体可查看：https://mp.weixin.qq.com/zh_CN/htmledition/comm_htmledition/res/store_manage/store_manage_file.zip
      返回:
        {ApiResult}

    - #### searchByDevice

          public static ApiResult searchByDevice(DeviceIdentifier deviceIdentifier)

      查询设备列表
      参数:
        `deviceIdentifier` - 指定的设备
      返回:
        {ApiResult}

    - #### searchPage

          public static ApiResult searchPage(int begin,
                                             int count)

      需要分页查询或者指定范围内的设备时
      参数:
        `begin` - 页面列表的起始索引值；
        `count` - 待查询的页面数量，不能超过50个；
      返回:
        {ApiResult}

    - #### searchPage

          public static ApiResult searchPage(int applyId,
                                             int begin,
                                             int count)

      根据批次id查找
      参数:
        `applyId` - 应用id
        `begin` - 页面列表的起始索引值；
        `count` - 待查询的页面数量，不能超过50个；
      返回:
        {ApiResult}

    - #### bindPage

          public static ApiResult bindPage(DeviceIdentifier deviceIdentifier,
                                           int... pageIds)

      配置设备与页面的关联关系。配置时传入该设备需要关联的页面的id列表（该设备原有的关联关系将被直接清除）；页面的id列表允许为空，当页面的id列表为空时则会清除该设备的所有关联关系。配置完成后，在此设备的信号范围内，即可摇出关联的页面信息。 在申请设备ID后，可直接使用接口直接配置页面。 若设备配置多个页面，则随机出现页面信息。一个设备最多可配置30个关联页面。
      参数:
        `deviceIdentifier` - 设备信息
        `pageIds` - 待关联的页面列表
      返回:
        {ApiResult}

    - #### searchRelation

          public static ApiResult searchRelation(DeviceIdentifier deviceIdentifier,
                                                 int type)

      查询设备与页面的关联关系。 提供两种查询方式，可指定页面ID分页查询该页面所关联的所有的设备信息； 也可根据设备ID或完整的UUID、Major、Minor查询该设备所关联的所有页面信息。
      参数:
        `deviceIdentifier` - 设备信息
        `type` - 类别
      返回:
        {ApiResult}

    - #### addGroup

          public static ApiResult addGroup(String groupName)

      新建设备分组，每个帐号下最多只有1000个分组。
      参数:
        `groupName` - 分组名
      返回:
        {ApiResult}

    - #### updateGroup

          public static ApiResult updateGroup(int groupId,
                                              String groupName)

      编辑设备分组信息，目前只能修改分组名。
      参数:
        `groupId` - 分组id
        `groupName` - 分组名
      返回:
        {ApiResult}

    - #### deleteGroup

          public static ApiResult deleteGroup(int groupId)

      删除设备分组，若分组中还存在设备，则不能删除成功。需把设备移除以后，才能删除。
      参数:
        `groupId` - 分组id
      返回:
        {ApiResult}

    - #### getGroupList

          public static ApiResult getGroupList(int begin,
                                               int count)

      查询账号下所有的分组。
      参数:
        `begin` - 分组列表的起始索引值
        `count` - 待查询的分组数量，不能超过1000个
      返回:
        {ApiResult}

    - #### getGroupDetail

          public static ApiResult getGroupDetail(int groupId,
                                                 int begin,
                                                 int count)

      查询分组详情，包括分组名，分组id，分组里的设备列表。
      参数:
        `groupId` - 分组唯一标识，全局唯一
        `begin` - 分组列表的起始索引值
        `count` - 待查询的分组数量，不能超过1000个
      返回:
        {ApiResult}

    - #### addDeviceToGroup

          public static ApiResult addDeviceToGroup(int groupId,
                                                   List<DeviceIdentifier> deviceIdentifierList)

      添加设备到分组，每个分组能够持有的设备上限为10000，并且每次添加操作的添加上限为1000。只有在摇周边申请的设备才能添加到分组。
      参数:
        `groupId` - 分组唯一标识，全局唯一
        `deviceIdentifierList` - 设备信息
      返回:
        {ApiResult}

    - #### deleteDeviceFromGroup

          public static ApiResult deleteDeviceFromGroup(int groupId,
                                                        List<DeviceIdentifier> deviceIdentifierList)

      从分组中移除设备，每次删除操作的上限为1000。
      参数:
        `groupId` - 分组唯一标识，全局唯一
        `deviceIdentifierList` - 设备信息
      返回:
        {ApiResult}

Copyright © 2017. All rights reserved.