小程序 SDK 集成文档

简介

本SDK⽀持H5、⼩程序(微信、⽀付宝、字节)、Uni平台，为应⽤提供安全稳定的推送服务。

合法域名配置

使用个推推送SDK，需要在小程序后台需要配置合法域名：

#杭州机房
wss://wshz.getui.net:5223
wss://wshz.gepush.com:5223

#无锡机房
wss://wswx.getui.net:5223
wss://wswx.gepush.com:5223

#北京机房
wss://wsmjq.getui.net:5223
wss://wsmjq.gepush.com:5223

SDK使用

应⽤启动时调⽤GtPush的init⽅法，初始化个推推送SDK。

import GtPush from './GtPush-min.js'

//打开调试模式，调试模式下将会向控制台输出SDK⽇志，正式上线时建议关掉
GtPush.setDebugMode(true)

//初始化推送SDK
  GtPush.init({
    appid: 'kHx67S8jWU6BBDTAFj9BjA',
    onClientId: (res) => {
      //个推ClientId回调，拿到cid后将其上报到服务端
      console.info(`onClientId: ${res.cid}`)
  },

  onlineState: (data) => {
    //个推ClientId在线状态回调
    console.info(`onlineState: ${data.online}`)
  },

  onPushMsg: (res) => {
    //推送消息回调
    console.info(`onPushMsg`, res.message)
  },

  onError: (res) => {
    //错误回调
    console.info(`onError`, res.error)
  }
})

API说明

GtPush.d.ts⽂件如下

declare namespace GtPush {
    /**
     * 设置调试模式
     * @param debugMode 打开或关闭调试模式
     */
    function setDebugMode(debugMode: boolean): void;
    /**
     * 初始化GtPush
     */
    function init(obj: {
        /**
         * 个推官网生成的appid
         */
        appid: string;
        onError?: (res: {
            error: any;
        }) => void;
        /**
         * 个推终端ID回调，标识当前终端和应用
         */
        onClientId?: (res: {
            cid: string;
        }) => void;
        /**
         * 个推终端ID在线状态回调
         */
        onlineState?: (res: {
            online: boolean;
            reason?: string;
        }) => void;
        /**
         * 推送消息回调
         */
        onPushMsg?: (res: {
            message: string;
        }) => void;
    }): void;
    /**
     * 配置socketServer信息
     * @param obj sockeetServer配置，包括url、key、keyId
     */
    function setSocketServer(obj: {
        url: string;
        keyId: string;
        key: string;
    }): void;
    /**
     * 设置是否允许socket连接
     * @param enable 是否允许socket连接
     */
    function enableSocket(enable: boolean): void;
    /**
     * 获取sdk版本信息
     * @returns sdk版本信息
     */
    function getVersion(): string;
}
export = GtPush;