UIAlbum

立即使用

概述

本模块封装了图片资源选择功能

注意:使用本模块前需在云编译页面添加勾选访问相册权限,否则会有崩溃闪退现象

注意:本模块 iOS 平台上最低适配系统版本为 iOS 9.0

模块接口

open

打开图片资源选择器,打开后会全屏显示

open({params}, callback(ret))

params

max:

  • 类型:数字
  • 描述:(可选项)最多选择几张图片
  • 默认值:9

styles:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式
  • 内部字段:
{
    bg: 'rgba(36,36,36,1)',                  //(可选项)字符串类型;资源选择器背景,支持 rgb,rgba,#;默认:'rgba(36,36,36,1)'
    mark: {                         //(可选项)JSON对象;选中图标的样式
        unSelectedIcon:'',          //(可选项)字符串类型;未选中图标路径(本地路径,支持fs://、widget://);默认:圆形灰色对勾图标
        icon: '',                   //(可选项)字符串类型;选中图标路径(本地路径,支持fs://、widget://);默认:圆形绿色对勾图标                      
    },
    nav: {                          //(可选项)JSON对象;导航栏样式
        bg: 'rgba(36,36,36,1)',     //(可选项)字符串类型;导航栏背景,支持 rgb,rgba,#;默认:'rgba(36,36,36,1)'
        titleColor: '#fff',         //(可选项)字符串类型;标题文字颜色,支持 rgb,rgba,#;默认:'#fff'
        finishText: '上传',          //(可选项)字符串类型;上传按钮文字内容;默认:'上传'
        finishColor: '#FFFF00',     //(可选项)字符串类型;上传按钮的文字颜色,支持 rgb,rgba,#;默认:'#FFFF00'
        backUrl: '',                //(可选项)字符串类型;返回按钮图片路径,支持fs、widget;默认:模块自带按钮

    },
    header: {                       //(可选项)JSON对象;头视图样式
        bg: 'rgba(36,36,36,1)',                 //(可选项)字符串类型;头视图背景,支持 rgb,rgba,#;默认:'rgba(36,36,36,1)'
        titleColor: '#fff',         //(可选项)字符串类型;头视图文字颜色,支持 rgb,rgba,#;默认:'#fff'
        titleSize: 18,              //(可选项)数字类型;头视图文字大小,默认:18
    },
    bottom: {                       //(可选项)JSON对象;底部视图样式
        bg: 'rgba(36,36,36,1)',                 //(可选项)字符串类型;底部视图背景,支持 rgb,rgba,#;默认:'rgba(36,36,36,1)'
        btnTitle: '确定',          //(可选项)字符串类型;底部视图按钮文字内容;默认:'确定'
        btnTitleColor: '#000',         //(可选项)字符串类型;底部视图按钮文字颜色,支持 rgb,rgba,#;默认:'#000'
        btnTitleSize: 20,              //(可选项)数字类型;底部视图按钮文字大小,默认:20
        btnBgColor: '#FFFF00',         //(可选项)字符串类型;底部视图按钮背景颜色,支持 rgb,rgba,#;默认:'#FFFF00'
        btnCorners: 20,              //(可选项)数字类型;底部视图按钮圆角,默认:20

    }
}

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: cancel,               //字符串类型;按钮点击事件,取值范围
                                     //upload 用户点击上传按钮事件
                                     //cancel 用户点击取消按钮事件
    list: [{                         //数组类型;返回选定的资源信息数组
        path: '',                    //字符串类型;资源路径,返回资源在本地的绝对路径,注意:iOS 平台上需要用 transPath 接口转换之后才可读取原图
        thumbPath: '',               //字符串类型;缩略图路径,返回资源缩略图在本地的绝对路径
        size: 1048576,               //数字类型;资源大小,单位(Bytes)
        time: '1490580032000',       //字符串类型;资源修改时间,格式:时间戳,单位为毫秒。  
    }]
}

示例代码

var UIAlbum = api.require('UIAlbum');
UIAlbum.open({
    max: 9,
    styles: {
        bg: 'rgba(36,36,36,1)',
        mark: {        
          unSelectedIcon:'',          
          icon: '',                                     
        },
        nav: {      
         bg: 'rgba(36,36,36,1)',    
         titleColor: '#fff',         
         finishText: '上传',          
         finishColor: '#FFFF00',     
         backUrl: '',                

       },
       header: {                       
         bg: 'rgba(36,36,36,1)',                 
         titleColor: '#fff',         
         titleSize: 18,                      
       },
       bottom: {           
        bg: 'rgba(36,36,36,1)',  
        btnTitle: '确定',        
        btnTitleColor: '#000',         
        btnTitleSize: 20,       
        btnBgColor: '#FFFF00',   
        btnCorners: 20,   
        }
      }
}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

close

关闭图片资源选择器

close()

示例代码

var UIAlbum = api.require('UIAlbum');
UIAlbum.close();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

requestAlbumPermissions

请求相册权限

requestAlbumPermissions( callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  isAccessPermissions: true    //布尔类型;是否有相册权限
}

示例代码

var UIAlbum = api.require('UIAlbum');
UIAlbum.requestAlbumPermissions({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统

可提供的1.0.0及更高版本

transPath

将相册图片地址转换为可以直接使用的本地路径地址(临时文件夹的绝对路径),相册图片会被拷贝到临时文件夹,调用 api.clearCache 接口可清除该临时图片文件

transPath({params}, callback(ret))

params

path:

  • 类型:字符串
  • 描述:要转换的图片路径(在相册库的绝对路径)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   path: ''          //字符串类型;相册内图片被拷贝到临时文件夹,返回已拷贝图片的绝对路径 
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
  status: false     //转化失败
}

示例代码

var UIAlbum = api.require('UIAlbum');
UIAlbum.transPath({
    path: ''
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统

可提供的1.0.0及更高版本