super-jssdk 使用文档

概述

super-jssdk 主要提供了两类插件，一种是基于 Cordova 插件做二次封装的 SDK，抹平 Cordova 插件不同版本、不同系统之间的差异，提供统一的 API 供外部团队使用，使用此类插件前必须先初始化 SDK，具体方法见下面的说明；第二种是常用的工具类插件，例如 http、localstorage 等，此类插件可直接使用。

使用说明

1、下载及引用

  • 使用 npm 安装, import 方式按需引入具体方法
cnpm install @yl/super-jssdk;
import { init, getDeviceInfo, …… } from "@yl/super-jssdk";

注意：安装失败的话，请看私有 npm 库说明

  • 使用 script 标签，使用全局变量 MYSDK 
<script src="https://scp-minio-test.myyscm.com/test-cgsaas/d17a4897-6b0e-41a2-bee3-56892999981c/12bac0bf43ba6b7186dd83ab2aa81bde.js"></script>

window.MYSDK.init();
window.MYSDK.getDeviceInfo();
……

注意：使用浏览器引入方法，无法按需加载

2、通过 init 接口注入初始化配置并初始化 SDK

使用 Cordova 相关插件前必须先初始化 SDK，否则将无法调用，全局调用一次即可，并可传入初始化配置。工具类插件无此限制。

  • 默认初始化配置
{
  mock: false  // 非 Cordova 环境下是否需要模拟数据，默认 false
}

mock 只会在设置为 true 并且是非 Cordova 环境下才会开启，开启 mock 后，所有 Cordova 插件调用会返回模拟数据

  • 初始化方法调用示例，若想启用 mock，传入参数 { mock: true }
init()
  .then(() => {
    console.log('SDK 初始化成功');
    // TODO 调用插件
    // ……
  })
  .catch(err => {
    console.log('SDK 初始化失败:', err);
  })

3、接口调用入参

Cordova 类型插件所有入参统一由一个对象传入，包括必填参数和可扩展参数，参数详情查看具体插件使用文档；工具类插件参数无此限制，具体使用查看文档。

4、接口返回参数

大部分接口返回统一为一个 promise，插件成功调用后的结果通过 then 方法获取，失败的接口由 catch 方法捕获，其他过程中的结果通过传入回调函数执行获取，少数接口直接返回结果，使用详情请查看具体插件文档。其中错误数据通过定义标准的数据格式进行描述，具体格式如下：

{
  errCode: xxx,
  errMsg: xxx
}

错误 code 定义

errCode: -1 // 插件内部错误
errCode: 10000 // 插件未安装
errCode: 10001 // 设备绑定失败
errCode: 10002 // 插件初始化错误
errCode: 10003 // 超时
errCode: 10004 // 参数不合法
errCode: 10008 // 插件方法不存在

5、注意事项

提供的 npm 包未设置垫片（polyfill），若需要兼容低版本浏览器，请自行添加

API 列表

一、Cordova 类型插件

1、初始化

SDK 初始化：init

2、设备信息

获取设备信息-异步：getDeviceInfo

获取设备信息-同步：getSyncDeviceInfo

判断是否是 IOS：isIOS

判断是否是 IOSX：isIOSX

判断是否是 Android：isAndroid

运行环境从后台切换到前台：resume

运行环境从前台切换到后台：pause

3、获取路径相关信息

获取路径相关的方法：Path

4、通用方法

工具集插件：Utils

5、具体插件

消息推送：PushNotification

下载插件：MDownloader

数据存储：MMKV

数据库：SqlitePlus

图片预览：MImageBrowser

拍照插件：MImagePicker & MPhoto

OSS 插件（兼容阿里 OSS 和 minio 插件）：MOSS

文件操作插件：MFilemanager

广告页插件：MAds

天眼插件：Log

加速计：MAccelerometer

MAppAvailability：MAppAvailability

百度地图：MBaiDuMap

二维码工具插件：MBarcode

云助手sdk集成：MCloudAssistant

MDialog：MDialog

文档预览插件：MDocPreview

质检测量工具配套插件：MEngineerKit

文件列表浏览插件：MFileExplorer

热更新插件：MHotUpdate

语音插件：MIFlySpeech

魔链&魔窗：魔链&魔窗

键盘插件：MKeybordExt

核心插件：MicCore

Network：Network

NFC标签检测插件: MNFC

支付插件: MPay

微信: MWeixin

手写签名板: MWeixin

StatusBar: StatusBar

流媒体播放插件: MStreamPlayer

腾讯多人视频会议插件: TXLiveRoom

萤石第三方视频监控: VideoMonitor

MWebview: MWebview

二、工具类插件

Context

guid

http

localstorage

PaasOffline

StringHelper

validate

WebUpload

results matching ""

    No results matching ""