Close Menu

oystore

Welcome to the documentation for the OyStore framework! OyStore is a powerful toolbox for managing and interacting with data in your iOS app. This documentation will guide you through the setup and usage of OyStore in your project.

Features

  • Efficient data storage and retrieval
  • Synchronization with cloud services
  • Data encryption for added security
  • Support for both online and offline data access
  • Powerful query capabilities
  • Easy integration with iOS app architecture

Getting Started

Installation

To begin using OyStore in your iOS project, you need to install the framework. Follow these steps:

  1. Open your Xcode project.
  2. Go to the “File” menu, then select “Swift Packages” > “Add Package Dependency”.
  3. In the search bar, enter “OyStore” and click “Next”.
  4. Choose the latest version and click “Next”.
  5. Select the target where you want to add OyStore and click “Finish”.

Note: If you prefer using CocoaPods, you can also install OyStore by adding it to your Podfile.

Configuration

Once OyStore is installed, you need to configure it in your project. Here’s how:

  1. Import the OyStore module in your source file.
  2. Create an instance of the OyStore class.
  3. Configure any desired options, such as enabling data encryption or specifying a cloud service provider.
  4. Call the `start()` method to initialize OyStore.

Basic Usage

Data Models

In OyStore, you work with data using data models. A data model represents a specific entity or object in your app. To define a data model, follow these steps:

  1. Create a new Swift file in your Xcode project.
  2. Define a struct for your data model.
  3. Specify the properties and their types for your data model.
  4. Optionally, conform to protocols like `Codable` or `Equatable`.

Your data model is now ready to use with OyStore.

Storing and Retrieving Data

To store and retrieve data using OyStore, you can follow these steps:

  1. Create an instance of your data model.
  2. Set the property values for the data model.
  3. Call the `store()` method to save the data model in the local storage.
  4. Use the various query methods provided by OyStore to fetch and filter data models.

Make sure to handle any errors that may occur during data storage or retrieval.

Synchronization with Cloud Services

If you want to synchronize your data with a cloud service, OyStore provides seamless integration with popular services like Firebase or AWS. Here’s how to set it up:

  1. Make sure you have set up your cloud service account and added the required SDK to your project.
  2. Configure the cloud service provider in OyStore by setting the appropriate options.
  3. Use the `sync()` method to synchronize your local data with the cloud service.
  4. Handle conflicts and update conflicts as needed.

Refer to the specific cloud service documentation for more details.

Advanced Usage

Customization

OyStore allows you to customize its behavior and integrate with your app architecture:

  1. Implement custom data storage providers by conforming to the `OyStoreProvider` protocol.
  2. Extend data models with custom methods or additional properties.
  3. Use OyStore notifications to track changes and update UI.
  4. Integrate OyStore with existing Core Data or Realm databases.

Error Handling

OyStore can encounter errors during data storage, retrieval, or synchronization. To handle errors effectively:

  1. Catch and handle specific errors using Swift’s `try-catch` mechanism.
  2. Use the `OyStoreError` enum to identify the specific type of error.
  3. Display appropriate error messages to the user.
  4. Implement error recovery mechanisms, if necessary.

Additional Resources

For more information about OyStore and its capabilities, refer to the following resources:

Conclusion

Congratulations! You are now ready to harness the power of OyStore in your iOS app. Feel free to explore the various features and experiment with different configurations to suit your project’s needs. Happy coding!