Jubo-sdk NPM | npm.io

JuboSdk API 文档

构造函数

new JuboSdk(options: JuboSdkOptions);

参数

参数名	类型	是否必填	默认值	描述
options	JuboSdkOptions	是	无	配置参数

options参数说明

参数名	类型	是否必填	默认值	描述
name	AppName	是	无	app名称
oldAppVersion	string	是	无	app旧版本, 用于判断是否使用新版sdk
ojbRouter	OjbRouter[]	是	无	ojb路由
appHome	string	否	无	跳转的首页
miniProgramAppId	string	否	元气的小程序appid: wxc2f42496fb5f5b91	小程序appid
miniProgramLogin	string	否	/pages/login/index	小程序的登录页
miniProgramTabBar	string[]	否	'/pages/home/index','/pages/boxHome/index','/pages/csgoPage/index','/pages/mine/index','/pages/ipHome/index'	小程序tabBar页面列表
miniProgramPayPage	string	否	无	小程序支付页
handleOjbUrlFn	(url: string) => string	否	无	自定义处理ojb协议函数

AppName枚举值

/** 元气玛特 */
Airmart = "Airmart",
/** 赛高 */
Saigo = "Saigo"

OjbRouter参数说明

参数名	类型	是否必填	默认值	描述
key	string	是	无	ojb统一标识
remark	string	否	无	说明
val	string	是	无	小程序对应地址，无地址的时候填`[event]`

属性

属性名	类型	描述
name	AppName	只读属性，app名称
isApp	boolean	只读属性，返回当前是否为app。
isMiniProgram	boolean	只读属性，返回当前是否为小程序。
isIos	boolean	只读属性，返回当前是否为iOS设备。
isH5	boolean	只读属性，返回当前是否为H5设备。(版本：1.2.0)
isIframe	boolean	只读属性，返回当前是否为iframe。(版本：1.2.0)
isCanShowNav	boolean	只读属性，返回当前是否可以显示自定义导航栏。(弃用属性)
device	`ios`	`android`	`wx`	只读属性，返回当前设备类型。
version	string	只读属性，返回当前sdk版本号。
channel	string	只读属性，返回当前渠道。
isOldApp	boolean	只读属性，返回当前app是否为旧版本。(兼容属性)

方法

如果方法有平台差异的时候，会显示平台差异说明

getToken()

获取token

平台差异说明

ios	android	小程序
√	√	x

返回参数说明

参数名	类型	描述
token	Promise	字符串类型的Promise对象，代表获取到的token值。

goLogin()

跳转登录

返回参数说明

参数名	类型	描述	平台差异说明
token	Promise	字符串类型的Promise对象，代表获取到的token值。	小程序登录成功后会刷新页面，`刷新后的页面为当前webview进入的首页`

goRoute(route: string, isRedirect?: boolean )

跳转路由

参数名	类型	是否必填	默认值	描述	平台差异说明
route	string	是	无	路由路径
isRedirect	boolean	否	false	是否使用重定向方式跳转(仅小程序有效)	小程序有效

shareMiniProgram(options: ShareMiniProgramOptions, trackData?: Record<string, any>)

分享微信小程序

app端调用会自动上传神策 埋点

参数名	类型	是否必填	默认值	描述
options	ShareMiniProgramOptions	是	无	分享参数配置
trackData	Record<string, any>	否	无	神策埋点数据

ShareMiniProgramOptions的结构

参数名	类型	是否必填	默认值	描述	平台差异说明
title	string	是	无	分享标题
descr	string	否	无	分享描述
webpage	string	是	无	小程序路径
appid	string	否	options.miniProgramAppId	小程序原始id (版本: 1.1.4)	仅app有效
thumbImage	string	否	无	分享图
base64	string	否	无	base64分享图, 仅app有效, 与thumbImage二选一	仅app有效
activity_id	string	否	无	活动id
activity_name	string	否	无	活动名称
product_id	string	否	无	商品id
product_name	string	否	无	商品名称
saInfo	any	否	无	神策埋点数据
shareOptions	shareOptions	否	无	分享选项	仅小程序有效

shareOptions的结构

参数名	类型	是否必填	默认值	描述
isRefresh	boolean	否	无	是否刷新
...

postReport(keyName: string, data: Record<string, any>)

原生埋点协助上报

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
keyName	string	是	无	埋点key
data	Record<string, any>	是	无	上报数据

sensorsReport(keyName: string, data: Record<string, any>)

原生埋点神策直接上报

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
keyName	string	是	无	埋点key
data	Record<string, any>	是	无	上报数据

shareWXImg(params: ShareImgData)

图片微信分享

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
base64	string	是	无	base64图片
type	`0`	`1`	`2`	否	0	分享方式（0 = 好友列表 1 = 朋友圈 2 = 收藏）

setNavTitle(title: string)

设置导航栏标题

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
title	string	是	无	标题

hideNavBar(isHide: boolean)

隐藏或显示原生导航栏

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
isHide	boolean	是	无	是否隐藏

setOrientation(isLandscape: boolean)

设置横竖屏

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
isLandscape	boolean	是	无	是否横屏

toPayPage(options: ToPayPageOptions): Promise<boolean | string>

拉起原生充值页面，充值成功或失败时有回调

小程序调用方法后是跳转小程序的支付页

参数名	类型	是否必填	默认值	描述
options	ToPayPageOptions	是	无	是否横屏

ToPayPageOptions的结构

参数名	类型	是否必填	默认值	描述	平台差异说明
orderId	string	否	无	订单id（版本：1.2.0）
amount	string	是	无	充值金额
activityId	string	是	无	活动ID
success	string	否	无	支付成功的回调地址	仅小程序有效
fail	string	否	无	支付失败的回调地址	仅小程序有效

返回参数说明

参数名	类型	描述	平台差异说明
isSuccess	Promise	boolean类型的Promise对象, `true`代表成功	仅app有效

hideStatusBar(isHide: boolean)

隐藏或显示状态栏

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
isHide	boolean	是	无	是否隐藏

quit()

返回到原生上一页面

平台差异说明

ios	android	小程序
√	√	x

goBack()

返回路由上一级，没有路由上一级会退到原生上一页面

平台差异说明

ios	android	小程序
√	√	x

shareHtml(options: ShareHtmlOptions)

分享H5页面到微信

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
options	ShareHtmlOptions	是	无	参数

ShareHtmlOptions的结构

参数名	类型	是否必填	默认值	描述	平台差异说明
title	string	是	无	分享标题
desc	string	是	无	分享描述
url	string	是	无	分享链接
imageUrl	string	是	无	分享图
type	`0`	`1`	`2`	否	0	分享方式（0 = 好友列表 1 = 朋友圈 2 = 收藏）

checkAppNotice(): Promise

检查App推送通知权限，若没打开会有自定义弹窗提示用户去打开

平台差异说明

ios	android	小程序
√	√	x

返回参数说明

参数名	类型	描述
isOpen	Promise	boolean类型的Promise对象，代表是否打开通知

checkNetStatus(): Promise

检查网络状态

平台差异说明

ios	android	小程序
√	√	x

返回参数说明

参数名	类型	描述
NetStatus	`0`	`1`	`2`	网络状态 (0 无网络 1 手机网络 2 wifi)

hcAuthorization(options: HcAuthorizationOptions): Promise

幻潮授权

平台差异说明

ios	android	小程序
√	√	x

参数名	类型	是否必填	默认值	描述
options	HcAuthorizationOptions	是	无	参数

HcAuthorizationOptions的结构

参数名	类型	是否必填	默认值	描述
title	string	是	无	授权页面标题
access_token	string	是	无	访问token
redirect_url	string	否	无	成功的回调地址 (旧版sdk使用) (兼容属性)
error_redirect_url	string	否	无	失败的回调地址 (旧版sdk使用) (兼容属性)