getui-test-quickapp

个推快应用集成文档

安装

NPM

# 目前暂未上线npm
npm install -S @getui-gtsdk-quickapp
npm install

使用

// 目前暂未上线npm
import GtPush from '@getui-gtsdk-quickapp'

//打开调试模式
GtPush.setDebugMode(true)

//初始化推送SDK，生成cid，服务端可通过此cid推送消息到该设备
GtPush.init({

    appid: "123123",

    success: (data) => {

        console.log(`subscribe success, cid: ${data.cid}`)

    },

    fail: (code, msg) => {

        console.log(`subscribe fail, code: ${code}, msg: ${msg}`)

    }

})

//订阅推送消息
GtPush.subscribe({

    callback: (msgId, data) => {

        console.log(`receive msg, msgId: ${msgId}, data: ${data}`)

    }

})

//取消订阅推送消息
GtPush.unscribe()           

API

declare namespace GtPush {
    /**
     * 打开或关闭调试模式
     * @param debugMode 调试模块开启或关闭
     */
    function setDebugMode(debugMode: boolean): void;
    
    /**
     * 订阅push，后续可以收到push消息（一般可在应用初始化的地方进行调用。比如在app的onCreate方法中调用。）
     * @param obj
     */
    function init(obj: {
        /**
         * 个推官网发放的appid
         */
        appid: string;
        /**
         * 订阅成功回调
         */
        success?: (data: {
            /**
             * PushService 返回的注册 id，可用于针对某个用户发送消息
             */
            cid: string;
        }) => void;
        /**
         * 订阅失败回调
         */
        fail?: (
        /**
         * 错误码
         */
        code: number, 
        /**
         * 错误信息
         */
        msg: string) => void;
        /**
         * 执行结束后的回调
         */
        complete?: () => void;
    }): Promise<void>;
    
    /**
    * 订阅push，后续可以收到push消息的事件回调（透传消息的payload内容可在此回调中收到）
    * @param obj
    */
    function subscribe(obj: {
        callback: (data: {
            msgId: string;
            data: string;
        }) => void;
    }): void;
    
    /**
    * 取消订阅push，将移除subscribe添加的push事件回调
    */
    function unsubscribe(): void;
}
export default GtPush;