@tnwx/wxmp/dist/api/shakearound/ShakeAroundPageApi.d.ts

TNWX 微信系开发脚手架之极速开发微信公众号

import { AccessToken } from '@tnwx/accesstoken';
/**
 * @author Javen
 * @copyright javendev@126.com
 * @description 微信摇一摇 页面管理
 */
export declare class ShakeAroundPageApi {
    private static addPageUrl;
    /**
     * 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
     * 其中，图片必须为用素材管理接口上传至微信侧服务器后返回的链接。
     * @param title 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
     * @param description 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
     * @param pageUrl 跳转链接
     * @param comment 页面的备注信息，不超过15个汉字或30个英文字母
     * @param iconUrl 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
     * @param accessToken
     */
    static addPage(title: string, description: string, pageUrl: string, iconUrl: number, comment?: string, accessToken?: AccessToken): Promise<any>;
    private static updatePageUrl;
    /**
     * 编辑页面信息
     * @param pageId 摇周边页面唯一ID
     * @param title 在摇一摇页面展示的主标题，不超过6个汉字或12个英文字母
     * @param description 在摇一摇页面展示的副标题，不超过7个汉字或14个英文字母
     * @param pageUrl 跳转链接
     * @param iconUrl 在摇一摇页面展示的图片。图片需先上传至微信侧服务器，用“素材管理-上传图片素材”接口上传图片，返回的图片URL再配置在此处
     * @param comment 页面的备注信息，不超过15个汉字或30个英文字母
     * @param accessToken
     */
    static updatePage(pageId: number, title: string, description: string, pageUrl: string, iconUrl: number, comment?: string, accessToken?: AccessToken): Promise<any>;
    private static searchPageUrl;
    /**
     * 查询页面列表
     * @param pageIds 指定页面的id列表
     * @param accessToken
     */
    static searchPageByIds(pageIds: number[], accessToken?: AccessToken): Promise<any>;
    /**
     * 分页查询或者指定范围内的页面时
     * @param begin 页面列表的起始索引值
     * @param count 待查询的页面数量，不能超过50个
     * @param accessToken
     */
    static searchPage(begin: number, count: number, accessToken?: AccessToken): Promise<any>;
    private static deletePageUrl;
    /**
     * 删除页面
     * @param pageId 指定页面的id
     * @param accessToken
     */
    static deletePage(pageId: number, accessToken?: AccessToken): Promise<any>;
}