ftpRequest

来自于:开发者 立即使用

概述

通过本模块提供的接口,可以实现从 ftp 服务器下载上传数据,创建删除文件等功能。注意:接口中涉及到的路径都是由 ftp 服务器地址拼接而来。格式为:ftp://地址:端口号/文件路径,如:ftp://192.168.19.159:2121/test.zip

getCatalog

获取制定路径的目录

getCatalog({params}, callback(ret, err))

parameter

url:

  • 类型:字符串
  • 描述:目标文件路径 如:ftp://192.168.19.159:2121

name:

  • 类型:字符串
  • 描述:(可选项)账号,允许匿名访问的 ftp 服务器可不传本参数

password:

  • 类型:字符串
  • 描述:(可选项)密码,允许匿名访问的 ftp 服务器可不传本参数

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType:'',          //字符串类型;事件类型;取值范围:
                           //progress(仅iOS支持)
                           //success
                           //fail
    totalSize: ,           //数字类型;总大小,仅当 eventType 为 progress 时有值(仅iOS支持)
    finishedSize:,         //数字类型;下载完成大小,仅当 eventType 为 progress 时有值(仅iOS支持)
    finishedPercent:       //字符串类型;下载完成百分比,仅当 eventType 为 progress 时有值(仅iOS支持)
    result:[]              //数组类型;该目录下包涵的文件信息组成的数组,仅当 eventType 为 success 时有值
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: ,               //数字类型;错误码
    msg: ''               //字符串类型;错误信息
}

示例代码

var ftpRequest = api.require('ftpRequest');
ftpRequest.getCatalog({
    url:'ftp://192.168.19.159:2121',
    name:'APICloud',
    password:'APICloud'
}, function(ret, err) {
    if (ret.eventType == 'success') {
        api.alert({msg:JSON.stringify(ret)});
    } else if (ret.eventType == 'progress') {
        console.log(JSON.stringify(ret));
    } else {
        api.alert({msg:JSON.stringify(err)});
    }
});

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本

download

获取制定路径的目录

download({params}, callback(ret, err))

parameter

url:

  • 类型:字符串
  • 描述:目标文件路径 如:ftp://192.168.19.159:2121/test.zip

localPath:

  • 类型:字符串
  • 描述:保存文件路径,要求本地路径(fs://) 如:fs://test.zip

name:

  • 类型:字符串
  • 描述:(可选项)账号,允许匿名访问的 ftp 服务器可不传本参数

password:

  • 类型:字符串
  • 描述:(可选项)密码,允许匿名访问的 ftp 服务器可不传本参数

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType:'',          //字符串类型;事件类型;取值范围:
                           //progress(仅iOS支持)
                           //success
                           //fail
    totalSize: ,           //数字类型;总大小,仅当 eventType 为 progress 时有值
    finishedSize:,         //数字类型;下载完成大小,仅当 eventType 为 progress 时有值(仅iOS支持)
    finishedPercent:       //字符串类型;下载完成百分比,仅当 eventType 为 progress 时有值(仅iOS支持)
    result:''              //字符串类型;该下载文件的绝对路径,仅当 eventType 为 success 时有值 
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: ,               //数字类型;错误码
    msg: ''               //字符串类型;错误信息
}

示例代码

var ftpRequest = api.require('ftpRequest');
ftpRequest.download({
    url:'ftp://192.168.19.159:2121/test.zip', 
    localPath:'fs://test.zip',
    name:'APICloud',
    password:'APICloud'
}, function(ret, err) {
    if (ret.eventType == 'success') {
        api.alert({msg:JSON.stringify(ret)});
    } else if (ret.eventType == 'progress') {
        console.log(JSON.stringify(ret));
    } else {
        api.alert({msg:JSON.stringify(err)});
    }
});

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本

upload

上传文件

upload({params}, callback(ret, err))

parameter

url:

  • 类型:字符串
  • 描述:服务器路径 如:ftp://192.168.19.159:2121/test.zip

localPath:

  • 类型:字符串
  • 描述:要上传的本地文件路径,要求本地路径(fs://) 如:fs://test.zip

name:

  • 类型:字符串
  • 描述:(可选项)账号,允许匿名访问的 ftp 服务器可不传本参数

password:

  • 类型:字符串
  • 描述:(可选项)密码,允许匿名访问的 ftp 服务器可不传本参数

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType:'',          //字符串类型;事件类型;取值范围:
                           //progress(仅iOS支持)
                           //success
                           //fail
    totalSize: ,           //数字类型;总大小,仅当 eventType 为 progress 时有值
    finishedSize:,         //数字类型;下载完成大小,仅当 eventType 为 progress 时有值(仅iOS支持)
    finishedPercent:       //字符串类型;下载完成百分比,仅当 eventType 为 progress 时有值(仅iOS支持)
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: ,               //数字类型;错误码
    msg: ''               //字符串类型;错误信息
}

示例代码

var ftpRequest = api.require('ftpRequest');
ftpRequest.upload({
    url:'ftp://192.168.19.159:2121/test.zip', 
    localPath:'fs://test.zip',
    name:'APICloud',
    password:'APICloud'
}, function(ret, err) {
    if (ret.eventType == 'success') {
        api.alert({msg:JSON.stringify(ret)});
    } else if (ret.eventType == 'progress') {
        console.log(JSON.stringify(ret));
    } else {
        api.alert({msg:JSON.stringify(err)});
    }
});

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本

createFolder

创建目录,仅支持创建文件夹

createFolder({params}, callback(ret, err))

parameter

url:

  • 类型:字符串
  • 描述:服务器路径 如:ftp://192.168.19.159:2121/newDir

name:

  • 类型:字符串
  • 描述:(可选项)账号,允许匿名访问的 ftp 服务器可不传本参数

password:

  • 类型:字符串
  • 描述:(可选项)密码,允许匿名访问的 ftp 服务器可不传本参数

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType:''           //字符串类型;事件类型;取值范围: 
                           //success
                           //fail 
    result:''              //字符串类型;创建目录的绝对路径,仅当 eventType 为 success 时有值 (仅iOS支持)
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: ,               //数字类型;错误码
    msg: ''               //字符串类型;错误信息
}

示例代码

var ftpRequest = api.require('ftpRequest');
ftpRequest.createFolder({
    url:'ftp://192.168.19.159:2121/test.zip',  
    name:'APICloud',
    password:'APICloud'
}, function(ret, err) {
    if (ret.eventType == 'success') {
        api.alert({msg:JSON.stringify(ret)});
    } else {
        api.alert({msg:JSON.stringify(err)});
    }
});

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本

destoryResource

删除目录文件

destoryResource({params}, callback(ret, err))

parameter

url:

  • 类型:字符串
  • 描述:服务器路径 如:ftp://192.168.19.159:2121/newDir

name:

  • 类型:字符串
  • 描述:(可选项)账号,允许匿名访问的 ftp 服务器可不传本参数

password:

  • 类型:字符串
  • 描述:(可选项)密码,允许匿名访问的 ftp 服务器可不传本参数

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType:''           //字符串类型;事件类型;取值范围: 
                           //success
                           //fail 
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: ,               //数字类型;错误码
    msg: ''               //字符串类型;错误信息
}

示例代码

var ftpRequest = api.require('ftpRequest');
ftpRequest.destoryResource({
    url:'ftp://192.168.19.159:2121/test.zip',  
    name:'APICloud',
    password:'APICloud'
}, function(ret, err) {
    if (ret.eventType == 'success') {
        api.alert({msg:JSON.stringify(ret)});
    } else {
        api.alert({msg:JSON.stringify(err)});
    }
});

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本