yl-js-sdk v1.0.2

云链开放JSSDK

• Device
• Network
• ImagePicker
• platform

Device

提供设备相关信息，判断设备类型安卓还是苹果，设备事件调用

API

ready

设备插件准备就绪事件，所有插件的调用必须等到设备 ready 后才能够执行

import Device from '@yl-app-jssdk/device';
Device.ready().then(result => {
  doingSomething();
});

方法返回的是一个 promise

参数说明

无

返回说明

• resolve 设备准备就绪返回 true
• reject 返回错误信息

getDeviceInfo

获取设备相关信息，例如设备平台信息，设备版本信息等等；

Device.getDeviceInfo();

参数说明

无

返回说明

• object 设备相关信息

isIOS

判断设备是否 ios，如果是返回 true，如果不是返回 false

Device.isIOS();

参数说明

无

返回说明

• boolean: true/false

isAndroid

判断设备是否安卓平台，如果是返回 true，如果不是返回 false

Device.isAndroid();

参数说明

无

返回说明

• boolean: true/false

resume

设备恢复前台事件

Device.resume(callback);

参数说明

返回说明

无

pause

设备切换后台事件

Device.resume(callback);

参数说明

返回说明

无

Network

提供网路状态相关的服务，服务均为promise

API

hasNetwork

判断当前是否有联网

hasNetwork()
    .then(res => {
        if (res) {
            console.log('已联网');
        } else {
            console.log('未联网');
        }
    })

无参数

返回说明

• resolve 已联网：true， 未联网：false
• reject 操作失败的原因

getNetworkType

获取网络连接类型

getNetworkType()
    .then(({isNoNetwork, isWifi}) => {
        if (isNoNetwork) {
            console.log('未联网');
        }
        
        if (!isWifi){
            console.log('非wifi网络');
        } else {
            console.log('wifi网络');
        }
    })

无参数

返回说明

• resolve 一个对象，isNoNetwork表示是否无网络，isWifi表示是否是wifi网路 {isNoNetwork: true, isWifi: false}
• reject 操作失败的原因

ImagePicker

图片选取器：包含拍照，录制视频，相册选图，图片和视频处理、获取图片和视频信息、图片涂鸦、文本、剪裁等功能

注意事项

• 以下接口的 error 回调中，errorCode 通用释义

目录

1. 打开相机拍照或者拍摄视频
2. 从相册选图
3. 图片处理
4. 视频处理
5. 图片编辑
6. 获取图片信息
7. 获取视频信息

API

openCamera 打开相机拍照或者拍摄视频

ImagePicker.openCamera(path, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

options 结构说明

photoConfig 结构说明

videoConfig 结构说明

openAlbum 从手机相册选择图片

ImagePicker.openAlbum(paths, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

options 结构说明

返回数据结构说明

成功回调，result为结果数组(result.length ≤ paths.length)
result内容：
[{
 "code":0, //code为0是图片选取成功，非0时均为失败;
 "result":"path", //图片存储路径，从前端传入paths遍历后得到
 "errMsg":"失败错误具体原因"
}]

imageProcess 从手机相册选择图片

ImagePicker.imageProcess(path, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

options 结构说明

• 注意：width 和 height 如果小于待压缩图片尺寸，那么图片宽高不做处理

watermarkConfig 参数字段说明

videoProcess 从手机相册选择图片

ImagePicker.videoProcess(path, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

options 结构说明

editImage 从手机相册选择图片

ImagePicker.editImage(pathGroups, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

pathGroups 结构说明

[
  {
    srcPath: 'src_image_01.png', // 待编辑图片路径
    destPath: 'dest_image_02.png', // 编辑后的图片存放路径
  },
  {
    srcPath: 'src_image_01.png',
    destPath: 'dest_image_02.png',
  },
];

res 结构说明

[
  {
    code: -1, // 非0时操作失败
    errMsg: '图片不存在', // 操作失败具体原因
    srcPath: 'src_image_01.png', // 待编辑图片路径
  },
  {
    code: 0, // 为0时操作成功
    srcPath: 'src_image_01.png', // 待编辑图片路径
    destPath: 'dest_image_02.png', // 编辑后的图片存放路径(仅当图片编辑成功后该值才有内容返回)
  },
];

options 结构说明

getImageInfo 从手机相册选择图片

ImagePicker.getImageInfo(path)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

res 结构说明

{
  "width": 1080,// 照片宽度
  "height": 1920,// 照片高度
  "size": 1024,// 照片占用内存大小，单位：Byte
  "dateTime": "2019:03:07 18:05:20",// 照片拍摄时间，格式:"yyyy:mm:dd HH:mm:ss"
}

getVideoInfo 从手机相册选择图片

ImagePicker.getVideoInfo(path, options)
  .then(res => {
    doSuccess();
  })
  .catch(err => {
    doError();
  });

参数说明

options 结构说明

res 结构说明

{
  "width": 1080,// 帧宽度
  "height": 1920,// 帧高度
  "size": 1024,// 视频占用内存大小，单位：Byte
  "dateTime": "2019:03:07 18:05:20",// 照片拍摄时间，格式:"yyyy:mm:dd HH:mm:ss"
  "rotate": 90,// 视频旋转角度
  "duration": 10, // 视频时长，单位：毫秒
  "firstFramePath": "xxxx", // 视频首帧存放路径，绝对路径
}

platform

提供当前代码运行环境(android,ios,weixin,ipad)的判断方法

API

是否是 ios 环境

isIOS();

是否是 android 环境

isAndroid();

是否是 ipad 环境

isIPad();

是否是 移动端 环境

isMobile();

是否是 IOSX 环境，主要用于做 iphone 刘海屏的兼容

isIOSX();