/** * @param {String} err 调用失败时得到的异常 * @param {CreateTmpQRCodeCallbackResult} result 调用失败时得到的异常 */ export declare type CreateTmpQRCodeCallback = (err: string, result: CreateTmpQRCodeCallbackResult) => void; export interface CreateTmpQRCodeCallbackResult { ticket: string; expire_seconds: number; } export declare type GetUserCallback = (err: string, result: WechatUser) => void; export interface WechatUser { /** * 用户是否订阅该公众号标识,值为0时,代表此用户没有关注该公众号,拉取不到其余信息。 */ subscribe: 0 | 1; /** * 用户的标识,对当前公众号唯一 */ openid: string; /** * 用户的语言,简体中文为zh_CN */ language: 'zh_CN'; /** * 用户关注时间,为时间戳。如果用户曾多次关注,则取最后关注时间 */ subscribe_time: number; /** * 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。 */ unionid: string; /** * 公众号运营者对粉丝的备注,公众号运营者可在微信公众平台用户管理界面对粉丝添加备注 */ remark: string; /** * 用户所在的分组ID(兼容旧的用户分组接口) */ groupid: 0; /** * 用户被打上的标签 ID 列表 */ tagid_list: number[]; /** * 返回用户关注的渠道来源 * ADD_SCENE_SEARCH 公众号搜索 * ADD_SCENE_ACCOUNT_MIGRATION 公众号迁移 * ADD_SCENE_PROFILE_CARD 名片分享 * ADD_SCENE_QR_CODE 扫描二维码 * ADD_SCENE_PROFILE_LINK 图文页内名称点击 * ADD_SCENE_PROFILE_ITEM 图文页右上角菜单 * ADD_SCENE_PAID 支付后关注 * ADD_SCENE_WECHAT_ADVERTISEMENT 微信广告 * ADD_SCENE_REPRINT 他人转载 * ADD_SCENE_LIVESTREAM 视频号直播 * ADD_SCENE_CHANNELS 视频号 * ADD_SCENE_OTHERS 其他 */ subscribe_scene: string; /** * 二维码扫码场景(开发者自定义) */ qr_scene: number; /** * 二维码扫码场景描述(开发者自定义) */ qr_scene_str: string; nickname: string; sex: 0 | 1 | 2; city: string; province: string; country: string; headimgurl: string; } export interface WechatApiAccessTokenPayload { accessToken: string; expireTime: number; } export interface WechatApiTicketTokenPayload { ticket: string; expireTime: number; } export interface WechatApiJsConfigParams { debug: boolean; jsApiList: string[]; url: string; } export interface WechatApiJsConfigResult { debug: boolean; appId: string; timestamp: string; nonceStr: string; signature: string; jsApiList: string[]; } export declare type WechatApiLang = 'en' | 'zh_CN' | 'zh_TW'; export declare class WechatApi { constructor(appId: string, appSecret: string, loadToken?: (callback: (err: string | null, payload: WechatApiAccessTokenPayload) => void) => void, saveToken?: (payload: WechatApiAccessTokenPayload, callback: () => void) => void); /** * 创建临时二维码 * @link http://mp.weixin.qq.com/wiki/18/28fc21e7ed87bec960651f0ce873ef8a.html * @param {number | string} sceneId 场景ID。字符串ID长度限制为1到64 * @param {number} expire 过期时间,单位秒。最大不超过2592000(即30天) * @param {CreateTmpQRCodeCallbackResult} callback */ createTmpQRCode(sceneId: number | string, expire: number, callback: CreateTmpQRCodeCallback): void; /** * 生成显示二维码的链接。微信扫描后,可立即进入场景 * @example * https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET * @param {string} ticket 二维码Ticket * @returns {string} 显示二维码的URL地址,通过img标签可以显示出来 */ showQRCodeURL(ticket: string): string; getUser(openId: string, callback: GetUserCallback): void; getUser(e: { openid: string; lang: WechatApiLang; }, callback: GetUserCallback): void; registerTicketHandle(getTicketToken: (type: string, callback: (err: Error | null, token: WechatApiTicketTokenPayload) => void) => void, setTicketToken: (type: string, token: WechatApiTicketTokenPayload, callback: (err: Error | null) => void) => void): void; getTicket(type: 'jsapi', callback: (err: Error | null, result: WechatApiTicketTokenPayload) => void): void; getJsConfig(params: WechatApiJsConfigParams, callback: (err: Error | null, result: WechatApiJsConfigResult) => void): void; } //# sourceMappingURL=wechat-api.types.d.ts.map