ftpServer

来自于:开发者 立即使用

startFtp stopFtp

概述

使用本模块,可在移动端创建一个 FTP 服务器,在同一局域网(Wi-Fi)内的 PC 端通过资源管理器即可访问,可实现移动端和 PC 端文件交换的功能。注意在 MC 系统下的 Finder,只能下载,无法上传,必须使用相关 FTP 小工具才能实现上传。

注意:在 iOS 端,APP 切到后台(运行时按下 home 键),该 APP 会被挂起,此时 FTP 服务器也不可访问。

startFtp

开启ftp服务,开启成功后在电脑端文件资源管理器输入ftp://ip:端口号即可访问手机分享文件。需要开启存储权限。

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

parameter

filePath:

  • 类型:字符串
  • 描述:(可选项)要共享的目录,要求本地路径(fs://)
  • 默认:fs://

port:

  • 类型:数字
  • 描述:(可选项)端口号,暂仅支持 iOS 端
  • 默认:2121

account:

  • 类型:JSON 对象
  • 描述:(可选项)配置访问账号,暂仅支持 iOS 端
  • 注意:本参数不传,表示允许匿名访问,若传则表示不支持匿名访问
  • 默认:见内部字段
  • 内部字段:
  1. {
  2. name:'', //(可选项)字符串类型;账号;默认:APICloud
  3. password:'' //(可选性)字符串类型;密码;默认:APICloud
  4. }

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true, //布尔型;是否成功
  3. ip:'', //字符串类型;设备ip
  4. port:, //数字类型;ftp端口号
  5. path:'' //字符串类型;共享的绝对路径,暂仅支持 iOS 端
  6. }

err:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. msg: '' //字符串类型;错误信息
  3. }

示例代码

  1. var ftpServer = api.require('ftpServer');
  2. ftpServer.startFtp({
  3. filePath:'fs://',
  4. port:8888,
  5. account:{
  6. name:'APICloud',
  7. password:'APICloud',
  8. }
  9. }, function(ret, err) {
  10. if (ret.status) {
  11. api.alert({msg:JSON.stringify(ret)});
  12. } else {
  13. api.alert({msg:JSON.stringify(err)});
  14. }
  15. });

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本

stopFtp

关闭ftp服务。

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;是否成功
  3. }

err:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. msg: ‘’, //字符串类型;错误信息
  3. }

示例代码

  1. var ftpServer = api.require('ftpServer');
  2. ftpServer.stopFtp(function(ret, err) {
  3. if (ret.status) {
  4. api.alert({msg:JSON.stringify(ret)});
  5. } else {
  6. api.alert({msg:JSON.stringify(err)});
  7. }
  8. });

可用性

Android系统,iOS系统

可提供的 1.0.0 及更高版本