# uni-app API
这里介绍 uni-app 插件集成的 FinClip 小程序 SDK 提供了哪些能力,以及 API 的详细说明和使用示例。
# 1. 初始化 API
MopSdk.initialize({
'sdkKey': '这里填上的SDK Key',
'sdkSecret': '这里填上SDK secret',
'apmServer': '这里填上你们的服务器地址', // 例如:https://api.finclip.com;
//'apiServer': '这里填上你们的服务器地址', // 例如:https://api.finclip.com;
// 'apiPrefix': '/api/v1/mop/',
// 'cryptType': 'MD5',
// 'sdkFingerprint': '',
// 'encryptServerData': false,
// 'userId': '',
// 'customWebViewUserAgent': '',
// 'bindAppletWithMainProcess': false,
// 'maxRunningApplet': 5,
// 'apmExtension'
// 'enableAppletDebug'
// 'disablePermission': false,
// 'disableGetSuperviseInfo'
// 'disableRequestPermissions'
// 小程序界面UI
uiConfig: {
//是否隐藏小程序加载界面的关闭按钮
hideTransitionCloseButton: true,
//屏蔽更多菜单中的“转发”按钮
hideForwardMenu: false,
//屏蔽更多菜单中的“设置”按钮
hideSettingMenu: false,
//屏蔽更多菜单中的“返回首页”按钮
hideBackToHome: false,
//屏蔽更多菜单中的“反馈与投诉”按钮
hideFeedbackMenu: false,
//SDK中“小程序”文案替换为任意其它名称
//appletText: '小程序',
//胶囊按钮配置
capsuleConfig: {
//右上角胶囊视图的宽度,默认值为88
capsuleWidth: 88,
//右上角胶囊视图的高度,默认值为32
capsuleHeight: 32,
//右上角胶囊视图的右边距
capsuleRightMargin: 7,
//右上角胶囊视图的圆角半径,默认值为5
capsuleCornerRadius: 16,
//右上角胶囊视图的边框宽度,默认值为0.8
capsuleBorderWidth: 0.5,
//胶囊背景颜色浅色
capsuleBgLightColor: '0x00000000',
//胶囊背景颜色深色
capsuleBgDarkColor: '0x80ffffff',
//右上角胶囊视图的边框浅色颜色
capsuleBorderLightColor: '0x80ffffff',
//右上角胶囊视图的边框深色颜色
capsuleBorderDarkColor: '0x26000000',
// 胶囊分割线浅色颜色
capsuleDividerLightColor: '0x26ffffff',
// 胶囊分割线深色颜色
capsuleDividerDarkColor: '0x26000000',
// 胶囊里的更多按钮的宽度,高度与宽度相等
moreBtnWidth: 32,
// 胶囊里的更多按钮的左边距
moreBtnLeftMargin: 6,
// 胶囊里的关闭按钮的宽度,高度与宽度相等
closeBtnWidth: 32,
// 胶囊里的关闭按钮的左边距
closeBtnLeftMargin: 6,
//以下属性暂不支持,需原生工程调整
//胶囊里的浅色更多按钮的图片对象,如果不传,会使用默认图标
//moreLightImage
//胶囊里的深色更多按钮的图片对象,如果不传,会使用默认图标
//moreDarkImage
//胶囊里的浅色更多按钮的图片对象,如果不传,会使用默认图标
//closeLightImage
//胶囊里的深色更多按钮的图片对象,如果不传,会使用默认图标
//closeDarkImage
},
//导航栏的返回首页按钮UI定制方法
// navHomeConfig: {
// //返回首页按钮宽度,默认44
// width: 44,
// //返回首页按钮高度,默认32
// height: 32,
// // 返回首页按钮的左边距,默认7
// leftMargin: 7,
// //返回首页按钮边框圆角半径,默认5
// cornerRadius: 5,
// //返回首页按钮边框宽度,默认1
// borderWidth: 0.5,
// //返回首页按钮浅色边框颜色,默认0X80FFFFFF
// borderLightColor: '0x80ffffff',
// //返回首页按钮深色边框颜色,默认0X26000000
// borderDarkColor: '0x26000000',
// //返回首页按钮浅色背景,默认0x33000000
// bgLightColor: '0x33000000',
// //返回首页按钮深色背景,默认0x33000000
// bgDarkColor: '0x80ffffff',
// //以下属性暂不支持,需要原生工程调整
// //导航栏返回首页按钮浅色图标,如果不传,会使用默认图标
// //lightImage
// //导航栏返回首页按钮浅色图标,如果不传,会使用默认图标
// //darkImage
// },
//浮窗设置窗口大小和位置,一般用于智能设备 如车载、手表、
// floatWindowConfig: {
// floatMode: true,
// x: 0,
// y: 0,
// width: 0,
// height: 0,
// }
}
},
(ret) => {
console.log('App Launch Success', ret)
},
(ret) =>{
console.log('App Launch Fail', ret)
});
# 2. 小程序生命周期
MopSdk.setAppletLifecycleCallback(
(ret) => {
console.log('onInitComplete', ret)
},
(ret) => {
console.log('onFailure', ret)
},
(ret) => {
console.log('onCreate', ret)
},
(ret) => {
console.log('onStart', ret)
},
(ret) => {
console.log('onResume', ret)
},
(ret) => {
console.log('onPause', ret)
},
(ret) => {
console.log('onStop', ret)
},
(ret) => {
console.log('onDestroy', ret)
})
# 3. 监听右上角关闭小程序事件
MopSdk.setNavigationBarCloseButtonClicked((appId) => {
console.log('setNavigationBarCloseButtonClicked',appId)
})
# 4. 获取当前小程序appId信息
const appId = MopSdk.currentAppletId();
# 5. 获取当前小程序信息
const appletInfo = MopSdk.currentApplet();
# 6. 打开小程序
const apiServer = 'https://api.finclip.com'
const appId = '5eec56a41464cc0001852e9a'
const startParams = null
// const startParams = {
// path: '/pages/index/index',
// query: 'a=1&b=2'
// }
const sequence = null // 小程序的上架序列号
MopSdk.openApplet(apiServer,
appId,
startParams,
sequence)
# 7. 二维码打开小程序
MopSdk.openAppletByQrcode(qrcode,
(ret) => {
console.log('onSuccess',ret)
},
(ret) => {
console.log('onFail',ret)
},
(ret) => {
console.log('onProcess',ret)
})
# 8. 搜索小程序
MopSdk.seachApplets({
apiServer: '',
text: ''
},
(ret)= > {
console.log('onSuccess',ret)
},
(ret)= > {
console.log('onFail',ret)
},
(ret)= > {
console.log('onProcess',ret)
})
# 9. 关闭小程序事件,保留在内存中
MopSdk.closeApplet(appId);
# 10. 关闭所有小程序事件,保留在内存中
MopSdk.closeApplets();
# 11. 结束小程序事件,从在内存中移除
MopSdk.finishRunningApplet(appId);
# 12. 结束所有小程序事件,从在内存中移除
MopSdk.finishRunningApplets();
# 13. 清除所有小程序缓存信息
MopSdk.clearApplets();