com.jfinal.weixin.sdk.api.shakearound

## 类 ShakeAroundPageApi

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

-     public class ShakeAroundPageApi
      extends Object

- - ### 构造器概要

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

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static ApiResult` | `addPage(String title, String pageUrl, String description, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `addPage(String title, String pageUrl, String description, String comment, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `deletePage(int pageId)` 删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `searchByIds(int... pageIds)` 查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `searchPage(int begin, int count)` 查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `updatePage(int pageId, String title, String pageUrl, String description, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
    `static ApiResult` | `updatePage(int pageId, String title, String pageUrl, String description, String comment, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。

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

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

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

    - #### ShakeAroundPageApi

          public ShakeAroundPageApi()

  - ### 方法详细资料

    - #### addPage

          public static ApiResult addPage(String title,
                                          String pageUrl,
                                          String description,
                                          String iconUrl)

      新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。
      参数:
        `title` - 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
        `pageUrl` - 页面地址
        `description` - 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
        `iconUrl` - 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
      返回:
        ApiResult

    - #### addPage

          public static ApiResult addPage(String title,
                                          String pageUrl,
                                          String description,
                                          String comment,
                                          String iconUrl)

      新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。
      参数:
        `title` - 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
        `pageUrl` - 页面地址
        `description` - 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
        `iconUrl` - 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
        `comment` - 页面的备注信息，不超过15个汉字或30个英文字母
      返回:
        ApiResult

    - #### updatePage

          public static ApiResult updatePage(int pageId,
                                             String title,
                                             String pageUrl,
                                             String description,
                                             String iconUrl)

      新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。
      参数:
        `pageId` - 摇周边页面唯一ID
        `title` - 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
        `pageUrl` - 页面地址
        `description` - 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
        `iconUrl` - 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
      返回:
        ApiResult

    - #### updatePage

          public static ApiResult updatePage(int pageId,
                                             String title,
                                             String pageUrl,
                                             String description,
                                             String comment,
                                             String iconUrl)

      新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。
      参数:
        `pageId` - 摇周边页面唯一ID
        `title` - 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
        `pageUrl` - 页面地址
        `description` - 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
        `iconUrl` - 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
        `comment` - 页面的备注信息，不超过15个汉字或30个英文字母
      返回:
        ApiResult

    - #### searchByIds

          public static ApiResult searchByIds(int... pageIds)

      查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 页面ID查询
      参数:
        `pageIds` - 定页面ID查询
      返回:
        ApiResult

    - #### searchPage

          public static ApiResult searchPage(int begin,
                                             int count)

      查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 批量拉取页面列表。
      参数:
        `begin` - 页面列表的起始索引值；
        `count` - 待查询的页面数量，不能超过50个；
      返回:
        ApiResult

    - #### deletePage

          public static ApiResult deletePage(int pageId)

      删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 只有页面与设备没有关联关系时，才可被删除。
      参数:
        `pageId` - 指定页面的id
      返回:
        ApiResult

Copyright © 2017. All rights reserved.