更新记录

1.0.0（2025-02-28）

• 初始化项目

平台兼容性

uni-app

uni-app x

bsf-icloud

bsf-icloud 一款专为IOS ICloud同步功能设计的UTS插件。

文档 | Demo

平台

• ios
• uniapp / uniappx

使用前的准备

请修改插件内部UTS.entitlements文件内的<key>com.apple.developer.icloud-container-identifiers</key>的值为$(TeamIdentifierPrefix)$(CFBundleIdentifier)。 以及 com.apple.developer.ubiquity-container-identifiers</key>对应的值

接口说明

引入插件

import * as Icloud from "@uni_modules/bsf-icloud";

isAvailable()

检查 iCloud 是否可用。

返回值

• Boolean: true 表示可用，false 表示不可用

示例

const isAvailable = Icloud.isAvailable();
console.log('iCloud是否可用:', isAvailable);

getLastBackupTime(options)

获取指定文件的最后备份时间。

参数

• options: Object
  • fileName: String - 文件名称
  • success: Function - 成功回调函数，参数为备份时间
  • fail: Function - 失败回调函数，参数为错误信息

示例

Icloud.getLastBackupTime({
  fileName: '1.txt',
  success: (date) => {
    console.log('最后备份时间:', date);
  },
  fail: (err) => {
    console.error('获取备份时间失败:', err);
  }
});

saveContentToICloud(options)

将内容保存到 iCloud。

参数

• options: Object
  • fileName: String - 文件名称
  • content: String - 要保存的内容
  • success: Function - 成功回调函数
  • fail: Function - 失败回调函数，参数为错误信息

示例

Icloud.saveContentToICloud({
  fileName: '1.txt',
  content: '要保存的内容',
  success: () => {
    console.log('保存成功');
  },
  fail: (err) => {
    console.error('保存失败:', err);
  }
});

loaContentFromICloud(options)

从 iCloud 读取文件内容。

参数

• options: Object
  • fileName: String - 文件名称
  • success: Function - 成功回调函数，参数为文件内容
  • fail: Function - 失败回调函数，参数为错误信息

示例

Icloud.loaContentFromICloud({
  fileName: '1.txt',
  success: (content) => {
    console.log('文件内容:', content);
  },
  fail: (err) => {
    console.error('读取失败:', err);
  }
});

deleteFileFromIcloud(options)

从 iCloud 删除文件。

参数

• options: Object
  • fileName: String - 要删除的文件名称
  • success: Function - 成功回调函数
  • fail: Function - 失败回调函数，参数为错误信息

示例

Icloud.deleteFileFromIcloud({
  fileName: '1.txt',
  success: () => {
    console.log('删除成功');
  },
  fail: (err) => {
    console.error('删除失败:', err);
  }
});

注意事项

1. 使用前请确保 iOS 设备已登录 iCloud 账号
2. 所有文件操作都是异步的，请使用回调函数处理结果
3. 文件名建议使用简单的格式，如：xxx.txt、xxx.json 等