yoho.js 7 KB
/**
 * YOHO-SDK
 *
 * 与原生 APP 交互的代码
 * 所有函数要做降级处理
 * 假如不是 YOHO App,在浏览器实现对应的功能
 * 浏览器不支持的功能,给出提示,控制台不能报错,不影响后续代码执行
 *
 * 希望能与 微信 JS-SDK 一样方便
 */

const tip = require('common/tip');

/* 空方法 */
const nullFun = () =>{};

/* 提示信息 */
const tipInfo = '暂不支持,请在BLK应用中打开';

const yoho = {
    /**
     * 判断是否是 APP
     */
    isApp: /yh_blk/i.test((navigator.userAgent || '').toLowerCase()),

    /**
     * JS 与 APP 共享的对象
     */
    data: window.yohoInterfaceData,

    /**
     * 跳转至指定index的tab(从0开始)
     * @param args 传递给 APP 的参数 {"index":tab_index}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goTap(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.tab',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转至登陆页面
     * @param args 传递给 APP 的参数 {""}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goLogin(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.login',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 退出登录,清除本地用户数据
     * @param args {""}
     * @param success
     * @param fail
     */
    goLogout(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.loginout',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 设置shoppingkey
     * @param args 传递给 APP 的参数 {"shoppingkey":""}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goShopingKey(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.shoppingkey',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转至购物车页面
     * @param args 传递给 APP 的参数 {""}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goShopingCart(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.shopingCart',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转地址页面 1:地址选择页面 2:地址管理页面
     * @param args 传递给 APP 的参数 {"type":"1"}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goAddress(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.address',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转至图片浏览页面;images:浏览图片的url index:点击的图片序号
     * @param args 传递给 APP 的参数 {"images":[imgUrl1,imgUrl2...],"index":"1"}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goImageBrowser(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.imageBrowser',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转至新页面(页面内容为html)
     * @param args 传递给 APP 的参数 {"url":""}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goNewPage(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.newPage',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转至支付页面
     * @param args 传递给 APP 的参数 {"orderid":"098768"}
     * @param success 调用成功的回调方法
     * @param fail 调用失败的回调方法
     */
    goPay(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.pay',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 返回上一级页面
     * @param args {""}
     * @param success
     * @param fail
     */
    goBack(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.back',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 分享
     * @param args {"title":"标题","des":"描述","img":"icon地址","url":"网页地址"}
     * @param success
     * @param fail
     */
    goShare(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || nullFun, fail || nullFun, {
                method: 'go.share',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转到搜索页面
     * @param args {""}
     * @param success
     * @param fail
     */
    goSearch(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || function() {}, fail || function() {}, {
                method: 'go.search',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 跳转到设置页面
     * @param args {""}
     * @param success
     * @param fail
     */
    goSetting(args, success, fail) {
        if (this.isApp) {
            window.yohoInterface.triggerEvent(success || function() {}, fail || function() {}, {
                method: 'go.setting',
                arguments: args
            });
        } else {
            tip(tipInfo);
        }
    },

    /**
     * 原生调用 JS 方法
     * @param name 方法名
     * @param callback 回调
     */
    addNativeMethod(name, callback) {
        if (window.yohoInterface) {
            window.yohoInterface[name] = callback;
        }
    }
};

module.exports = yoho;