icloud_storage_sync

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

icloud_storage_sync

★ 12 Open GitHub ↗

Easily sync and secure your app's data with the iCloud Sync Flutter plugin for seamless iCloud integration.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 📦☁️ iCloud_Storage_Sync Plugin

**Seamless iCloud integration for your Flutter iOS apps!**

## 🌟 Introduction

iCloud_Storage_Sync simplifies iCloud storage integration, bringing powerful cloud capabilities to your Flutter iOS apps:

🔄 Effortless backup and sync of app data

📱💻 Consistent user experience across all devices

🔒 Secure storage and retrieval of important information

☁️ Seamless integration with the iCloud ecosystem

## ✨ Features

| Feature | Description            |
| ------- | ---------------------- |
| 📂      | Get iCloud files       |
| ⬆️      | Upload files to iCloud |
| ✏️      | Rename iCloud files    |
| 🗑️      | Delete iCloud files    |
| ↔️      | Move iCloud files      |

## 🚀 Getting Started

### 1. 🛠️ Installation

Add this to your `pubspec.yaml`:

```yaml
dependencies:
  icloud_storage_sync: ^1.0.0
```

### 2. ⚙️ Install the Plugin

Run:

```bash
flutter pub get
```

### 3. 💻 Usage

Import in your Dart code:

```dart
import 'package:icloud_storage_sync/icloud_storage_sync.dart';
```

## 📋 Prerequisites

Before diving in, make sure you have:

☑️ An Apple Developer account

☑️ App ID and iCloud Container ID

☑️ iCloud capability enabled and assigned

☑️ iCloud capability configured in Xcode

🔍 See [How to set up iCloud Container](#-how-to-set-up-icloud-container-and-enable-the-capability) for step-by-step instructions.

## 🧰 API Examples

### 📥 Getting iCloud Files

```dart
Future<List<CloudFiles>> getCloudFiles({required String containerId}) async {
 return await icloudSyncPlugin.getCloudFiles(containerId: containerId);
}
```

### 📤 Uploading Files to iCloud

```dart
Future<void> upload({
 required String containerId,
 required String filePath,
 String? destinationRelativePath,
 StreamHandler<double>? onProgress,
}) async {
 await icloudSyncPlugin.upload(
 containerId: containerId,
 filePath: filePath,
 destinationRelativePath: destinationRelativePath,
 onProgress: onProgress,
 );
}
```

### 🏷️ Renaming iCloud Files

```dart
Future<void> rename({
 required String containerId,
 required String relativePath,
 required String newName,
}) async {
 await icloudSyncPlugin.rename(
 containerId: containerId,
 relativePath: relativePath,
 newName: newName,
 );
}
```

### 🗑️ Deleting iCloud Files

```dart
Future<void> delete({
 required String containerId,
 required String relativePath,
 required bool isDirectory
}) async {
 await icloudSyncPlugin.delete(
 containerId: containerId,
 relativePath: relativePath,
 isDirectory: isDirectory
 );
}
```

### 🔄 Replace iCloud Files

```dart
Future replaceFile({
  required String updatedFilePath,
  required String relativePath
  }) async {
    await icloudSyncPlugin.replace(
      containerId: iCloudContainerId,
      updatedFilePath: updatedFilePath,
      relativePath: relativePath,
    );
}
```

### 🔀 Moving iCloud Files

```dart
Future<void> move({
 required String containerId,
 required String fromRelativePath,
 required String toRelativePath,
}) async {
 await IcloudSyncPlatform.instance.move(
 containerId: containerId,
 fromRelativePath: fromRelativePath,
 toRelativePath: toRelativePath,
 );
}
```

## 🛠 How to set up iCloud Container and enable the capability

1. **👤 Log in to your Apple Developer account** and select 'Certificates, IDs & Profiles'.

2. **🆔 Create an App ID** (if needed) and an **iCloud Containers ID**:

3. **🔗 Assign the iCloud Container** to your App ID:

4. **💻 In Xcode, enable iCloud capability** and select your container:

## 🤝 Contributing

## 🙏 Acknowledgements

- Thanks to all the contributors who have helped shape this plugin
- Apple for providing the iCloud infrastructure

---

Made with ❤️ by the DevCodeSpace

icloud_storage_sync

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README