cmp.native - CMP文档

decompressFile


    decompressFile
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:317

本地文件的解压

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`filepath`	String	必选	被解压的文件地址
`[decompressPath]`	String	可选	解压路径，（默认应用对应的文件夹）
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.decompressFile({
             filepath:"压缩文件.zip",
             decompressPath:"",
         success:function(result){
             //返回被解压的文件路径和成功与否的标识
         }
         error:function(error){
             //do something
         }
    });
</script>

deleteFile

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:269

本地文件的删除

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`filename`	String	必选	文件名
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.deleteFile({
             filename:"一个文本文件.txt",
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

download

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:22

附件下载

参数:

名称类型标识描述

options

Object

必选

配置参数

名称类型标识描述

url

String

必选

附件的下载地址(默认:"")

[title]

String

可选

在下载进度中的显示名称(默认:"")

[extData]

Object

可选

额外参数，用于优化方面的需求的配置(目前可以配置的是文件本地缓存，避免同一个文件重复被下载)

名称	类型	标识	描述
`[fileId]`	String	可选	用于本地缓存的附件唯一ID
`[lastModified]`	String	可选	用于本地缓存的附件唯一更新时间
`[origin]`	String	可选	用于本地缓存的附件唯一的服务器地址，如：http://10.5.6.7:8080

[success]

Function

可选

下载成功后的回调,附件成功下载到本地后的文件地址,文件名称,文件大小等信息返回

[error]

Function

可选

下载错误的回调

[progress]

Function

可选

下载进度的回调

示例:

<script>
    cmp.native.download({
         url:"",
         title:"",
         extData:{
              fileId:id,
              lastModified:lastModified,
              origin: _.origin
         }
         progress:function(result){
             //do something with progress result
         },
         success:function(result){
             var localUrl = result.url,  //保存到本地的地址
                 localFilename=result.filename, //保存到本地的文件名
                 size=result.size //文件大小
                 ....
         }
         error:function(error){
             //do something with error obj
         }
    });
</script>

fileExist

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:343

判断本地文件是否存在

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`filename`	String	必选	文件名
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.fileExist({
             filename:"压缩文件.zip",
         success:function(result){
             //返回文件是否存在的标识
         }
         error:function(error){
             //do something
         }
    });
</script>

getCurrentPosition


    getCurrentPosition
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:511

获取当前地理位置

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`data`	String	必选	二维码文字
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.getCurrentPosition({
         success:function(result){
             //地理位置信息
         }
         error:function(error){
             //do something
         }
    });
</script>

getDownLoadListInfo


    getDownLoadListInfo
    
        
            (
            
                
                    
                        [options]
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:101

获取下载列表信息

参数:

名称类型标识描述

[options]

Object

可选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

getFileInfo


    getFileInfo
    
        
            (
            
                
                    
                        [options]
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:119

根据路径读取文件信息

参数:

名称类型标识描述

[options]

Object

可选

配置参数

名称	类型	标识	描述
`filepath`	Array	必选	可以传多个文件路径，返回的信息对应到相应的文件上
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

getLocationInfo


    getLocationInfo
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:588

表单-位置定位，获取当前的经纬度，以及时间、地名信息(只支持在cmp里)

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`success`	Function	必选	定位成功回调
`[error]`	Function	可选	定位失败回调

示例:

<script>
   cmp.native.getLocationInfo({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

getOfflineFiles


    getOfflineFiles
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:195

获取本地离线文件

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.getOfflineFiles({
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

getPictures


    getPictures
    
        
            (
            
                
                    
                        [options]
                    
                
            
            
)

Object

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:367

获取图像方法，开发者可通过配置获取自己想要的图像文件数据

参数:

名称类型标识描述

[options]

Object

可选

获取图像配置参数对象

名称	类型	标识	描述
`[compress]`	Boolean	可选	是否返回压缩后的图片，true：返回缩略图，false：返回原图
`[quality]`	Number	可选	摄像头品质参数（范围0~100，默认100）
`[targetWidth]`	Number	可选	生成的图像宽度
`[targetHeight]`	Number	可选	生成的图像高度
`[saveToPhotoAlbum]`	Boolean	可选	是否将图像保存到相册
`[destinationType]`	Number	可选	返回的图像数据类型: 0:base64格式（默认） 1:图像文件路径 2:本地图片路径注：M1平台返回图片路径+base64，纯H5平台只返回base64
`[sourceType]`	Number	可选	获取图像文件的方式: 0:图片库 1:摄像头（默认） 2:相册
`[encodingType]`	Number	可选	图像编码类型： 0:jpeg（默认） 1:png
`[pictureNum]`	Number	可选	选择图片的数量：默认数量：9；注：在M1平台下不支持多选
`[success]`	Function	可选	执行成功后的回调函数
`[error]`	Function	可选	执行失败后的回调函数

返回值:

[Object]

result 返回值：

result.success:成功与否标识,true:成功；false:失败
result.files:返回的图片数据(数组)
- base64:图片的base64字符串(压缩后的，一般作为缩略图展示)
- filepath:图片的原图路径注：纯H5平台下该值不返回
- fileSize:图片的原图大小（单位：byte）
- type:图片的类型

示例:

<script>
    cmp.camera.getPictures({
         compress:true,
         quality:100,
         targetWidth:-1,
         targetHeight:-1,
         saveToPhotoAlbum:true,
         destinationType:0,
         sourceType:1,
         encodingType:0,
         success:function(cameraResult){
                 cameraResult = {
                  success:true,
                  files:[{  /真实的图片数组
                      base64:'data:image/jpg;base64,iVBORw'，//图片的base64字符串
                      filepath:"/storage/emulated/0/Tencent/QQfile_recv/QQDataLineGuidePic.png", //真实图片的地址
                      fileSize:"1024",  //图片大小
                      type:"png",
                      index:1~9//选择图片的顺序，ios  iphone6无法确定选择的顺序
                  }]
              };
             },
         error:function(){
                 //do something
             }
    });
</script>

getUploadListInfo


    getUploadListInfo
    
        
            (
            
                
                    
                        [options]
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:110

获取上传列表信息

参数:

名称类型标识描述

[options]

Object

可选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

holdScanBarcode


    holdScanBarcode
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:465

扫描二维码的插件，其作用是将扫描结果发给开发者，开发者自行判断结果后，进行开发者传过来的提示，并且根据回调函数保持是否关闭扫描插件

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.holdScanBarcode({
         success:function(result){
             //返回扫描结果并返回二维码组件是否关闭/展示新内容回调函数
         }
         error:function(error){
             //do something
         }
    });
</script>

makeBarScan


    makeBarScan
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:487

制作二维码

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`data`	String	必选	二维码文字
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.makeBarScan({
             data:"二维码文字",
         success:function(result){
             //二维码图片路径
         }
         error:function(error){
             //do something
         }
    });
</script>

markLocation


    markLocation
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:534

地图定位

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.markLocation({
         success:function(result){
             //地理位置信息
         }
         error:function(error){
             //do something
         }
    });
</script>

openOfflineFilesModule


    openOfflineFilesModule
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:217

打开离线文档模块

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.openOfflineFilesModule({
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

read

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:129

查看附件内容,包括pdf,excel,word,jpeg...

参数:

名称类型标识描述

options

Object

必选

附件查看配置参数

名称类型标识描述

path

String

必选

附件查看的地址,可以是远程地址或者本地地址

filename

String

必选

附件名称

[edit]

Boolean

可选

是否可以进行编辑,默认:false(注:目前只支持office文档文件的修改编辑,且只能通过wps软件进行修改)

[extData]

Object

可选

额外参数，用于优化方面的需求的配置(目前可以配置的是文件本地缓存，避免同一个文件重复被下载)

名称	类型	标识	描述
`[fileId]`	String	可选	用于本地缓存的附件唯一ID
`[lastModified]`	String	可选	用于本地缓存的附件唯一更新时间
`[origin]`	String	可选	用于本地缓存的附件唯一的服务器地址，如：http://10.5.6.7:8080

[success]

Function

可选

成功回调

[error]

Function

可选

失败回调

示例:

<script>
    cmp.native.read({
         path:"",  //附件查看的地址
         filename:"",//附件名称
         edit:false,  //是否可以进行修改编辑
         extData:{
              fileId:id,
              lastModified:lastModified,
              origin: _.origin
         }
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

readFile

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:293

本地文件的内容读取

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`filename`	String	必选	文件名
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.deleteFile({
             filename:"一个文本文件.txt",
         success:function(result){
             //返回文件的内容，字符串格式
         }
         error:function(error){
             //do something
         }
    });
</script>

saveBase64

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:167

保存base64数据到本地

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`base64`	String	必选	base64数据
`filename`	String	必选	保存成文件的名称
`type`	String	必选	保存成文件的类型
`[success]`	Function	可选	保存成功回调
`[error]`	Function	可选	保存失败回调

示例:

<script>
    cmp.native.saveBase64({
         base64:"",
         filename:"",//附件名称
         type:"png",
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

scanBarcode


    scanBarcode
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:443

扫描二维码

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.scanBarcode({
         success:function(result){
             //返回扫描结果
         }
         error:function(error){
             //do something
         }
    });
</script>

showLocationInfo


    showLocationInfo
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:609

显示地图信息(只支持在cmp里)

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`lbsUrl`	String	必选	获取lbs信息的url地址 http://10.5.6.240:88/seeyon/rest/cmplbs/1814357976477972035
`[userName]`	String	可选	用户名（可以不传）
`[memberIconUrl]`	String	可选	用户头像url地址（可以不传）
`success`	Function	必选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
   cmp.native.showLocationInfo({
       lbsUrl:"http://10.5.6.240:88/seeyon/rest/cmplbs/1814357976477972035",
       userName:"hezi",
       memberIconUrl:"http://10.5.6.240:88/seeyon/rest/avtart/101001"
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

takeLocationPicture


    takeLocationPicture
    
        
            (
            
                
                    
                        options
                    
                
            
            
)

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:556

表单-拍照定位(只支持在cmp里)

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`userName`	String	必选	用户名
`uploadPicUrl`	String	必选	图片上传地址
`serverDateUrl`	String	必选	服务器地址
`location`	String	必选
`success`	Function	必选	定位成功回调
`[error]`	Function	可选	定位失败回调
`[cancel]`	Function	可选	定位取消回调

示例:

<script>
   cmp.native.takeLocationPicture({
       userName:"xxxx",
       uploadPicUrl:"http://10.5.6.240:88/file/upload/",
       serverDateUrl:"http://10.5.6.240:88",
       location:"",
       success:function(result){
            //do something with result
       },
       error:function(error){
       },
       cancel:function(result){
       }
   });
</script>

upload

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:64

附件上传（支持多文件上传）

参数:

名称类型标识描述

options

Object

必选

附件上传配置参数

名称	类型	标识	描述
`url`	String	必选	附件提交到服务器的地址
`fileList`	Array	必选	本地附件资源的路径集,其中单个file对象的格式为 {filepath:"文件路径",fileId:"文件唯一id"}
`[extData]`	String	可选	扩展到业务数据,如对象ID,业务类型等,用JSon字符串转码后提交到服务器
`[imgIndex]`	String	可选	多张文件上传的时候服务器端认证的顺序关键字段，默认sortNum
`[progress]`	Function	可选	上传进度回调
`[success]`	Function	可选	上传成功回调
`[error]`	Function	可选	上传失败回调

示例:

<script>
    cmp.native.upload({
         url:"",  //附件上传的服务器地址
         fileList:[{filepath:"文件路径",fileId:"文件唯一id"}],//需要上传的附件列表
         extData:"",
         progress:function(result){
             var progressVal = result["pos"];  //0~1的小数，即上传进度的百分比
         },
         success:function(result){  //服务器端返回的相应数据
             var filename = result.filename,
                 url = result.url,
                 size = result.size
         }
         error:function(error){
             //do something
         }
    });
</script>

writeFile

定义于 doc\doc\cmp_doc_all\cmp-native-doc.js:239

本地文件写入和修改

参数:

名称类型标识描述

options

Object

必选

配置参数

名称	类型	标识	描述
`filename`	String	必选	文件名
`type`	String	必选	文件类型（符合mimetype格式，如"text/plain"-----文本类型，目前只支持文本类型）
`data`	String	必选	写入文件的数据
`[edit]`	String	可选	是否是修改已有的文件（默认false）
`[success]`	Function	可选	成功回调
`[error]`	Function	可选	失败回调

示例:

<script>
    cmp.native.writeFile({
             filename:"一个文本文件.txt",
             type:"text/plain",
             data:"xxxx",
             edit:false,
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

模块/类

cmp.native 类

方法

方法

decompressFile

参数:

示例:

deleteFile

参数:

示例:

download

参数:

示例:

fileExist

参数:

示例:

getCurrentPosition

参数:

示例:

getDownLoadListInfo

参数:

getFileInfo

参数:

getLocationInfo

参数:

示例:

getOfflineFiles

参数:

示例:

getPictures

参数:

返回值:

示例:

getUploadListInfo

参数:

holdScanBarcode

参数:

示例:

makeBarScan

参数:

示例:

markLocation

参数:

示例:

openOfflineFilesModule

参数:

示例:

read

参数:

示例:

readFile

参数:

示例:

saveBase64

参数:

示例:

scanBarcode

参数:

示例:

showLocationInfo

参数:

示例:

takeLocationPicture

参数:

示例:

upload

参数:

示例:

writeFile

参数:

示例: