search

openmobilehub / android-omh-storage

https://www.openmobilehub.org
Apache License 2.0
4 stars 1 forks source link

readme


Android OMH Storage

NPM version License

Chat on Discord Follow on Twitter

Android OMH Storage streamlines the integration of various cloud storage providers into your Android application by offering a unified API for different storage providers. It supports both Google Mobile Services (GMS) and non-GMS configurations, making it easy to incorporate Google Drive, OneDrive and Dropbox storage providers.

Features

OMH Storage Modules

This is the main directory of the mono-repo for Android OMH Storage. If you're searching for a particular package, please click on the corresponding package link below.

A single codebase, running seamlessly on any device

For instance, the following screenshots showcase multiple devices with Android, both with GMS and Non-GMS. The same app works without changing a single line of code, supporting multiple storage provider implementations.

| Google Drive (GMS) | Google Drive (non-GMS) | Dropbox | OneDrive | | --- | --- | --- | ---| | File listing | | | | | |
Show more
| Google Drive (GMS) | Google Drive (non-GMS) | Dropbox | OneDrive | | --- | --- | --- | --- | | File searching | | | | | | | File creation | | | | | | | File update | | | | | | | File deletion | | | | | | | File upload | | | | | | | File download | | | | | | | File metadata | | | | | | | File versioning | | | | | | | File permissions | | | | | |

Documentation

Supported functionality

Features Google Drive (GMS) Google Drive (non-GMS) OneDrive Dropbox
File listing ✅ ✅ ✅ ✅
File searching ✅ ✅ ✅ ✅
Folder creation ✅ ✅ ✅ ✅
File creation (by mime type) ✅ ✅ ❌ ❌
File creation (by extension) ❌ ❌ ✅ ✅
File update ✅ ✅ ✅ ✅
File deletion ✅ ✅ ✅ ✅
File permanent deletion ✅ ✅ ❌ ❌
File upload ✅ ✅ ✅ ✅
File download ✅ ✅ ✅ ✅
File export ✅ ✅ ❌ ❌
File metadata ✅ ✅ 🟨 🟨
File versioning ✅ ✅ ✅ ✅
File permissions 🟨 🟨 🟨 🟨
File URL ✅ ✅ ✅ ✅
Escape hatch (get provider SDK) ✅ ❌ ✅ ✅

File metadata

Show details [`OmhStorageEntity.OmhFile`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-storage-entity/-omh-file) | Property | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | ------------ | :----------------: | :--------------------: | :------: | :-----: | | id | ✅ | ✅ | ✅ | ✅ | | name | ✅ | ✅ | ✅ | ✅ | | createdTime | ✅ | ✅ | ❌ | ❌ | | modifiedTime | ✅ | ✅ | ✅ | ✅ | | parentId | ✅ | ✅ | ✅ | ✅ | | mimeType | ✅ | ✅ | ✅ | ✅ | | extension | ✅ | ✅ | ✅ | ✅ | | size | ✅ | ✅ | ✅ | ✅ | [`OmhStorageEntity.OmhFolder`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-storage-entity/-omh-folder) | Property | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | ------------ | :----------------: | :--------------------: | :------: | :-----: | | id | ✅ | ✅ | ✅ | ✅ | | name | ✅ | ✅ | ✅ | ✅ | | createdTime | ✅ | ✅ | ❌ | ❌ | | modifiedTime | ✅ | ✅ | ✅ | ❌ | | parentId | ✅ | ✅ | ✅ | ✅ | [`OmhStorageMetadata.originalMetadata`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-storage-metadata/original-metadata.html) | Storage provider | Type | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Google Drive (GMS) | [`com.google.api.services.drive.model.File`](https://developers.google.com/resources/api-libraries/documentation/drive/v3/java/latest/com/google/api/services/drive/model/File.html) | | Google Drive (non-GMS) | `String` | | OneDrive | [`com.microsoft.graph.models.DriveItem`](https://learn.microsoft.com/en-us/graph/api/resources/driveitem#properties) | | Dropbox | [`com.dropbox.core.v2.files.Metadata`](https://dropbox.github.io/dropbox-sdk-java/api-docs/v2.0.x/com/dropbox/core/v2/files/Metadata.html) |

File permissions

Show details [`OmhPermission.IdentityPermission`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-permission/-identity-permission) | Property | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | ----------- | :----------------: | :--------------------: | :------: | :-----: | | id | ✅ | ✅ | ✅ | 🟨 | | role | ✅ | ✅ | ✅ | ✅ | | isInherited | 🟨 | 🟨 | ✅ | ✅ | | identity | ✅ | ✅ | ✅ | ✅ | > **Google Drive**: The `isInherited` property is available only for items in shared drives. > **Dropbox**: The `id` corresponds to the underlying identity ID. [`OmhIdentity`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-identity) | Type | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | ----------- | :----------------: | :--------------------: | :------: | :-----: | | User | ✅ | ✅ | ✅ | ✅ | | Group | ✅ | ✅ | ✅ | ✅ | | Domain | ✅ | ✅ | ❌ | ❌ | | Anyone | ✅ | ✅ | ❌ | ❌ | | Device | ❌ | ❌ | ✅ | ❌ | | Application | ❌ | ❌ | ✅ | ❌ | [`OmhIdentity.User`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-identity/-user) | Property | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | -------------- | :----------------: | :--------------------: | :------: | :-----: | | id | ❌ | ❌ | ✅ | ✅ | | displayName | ✅ | ✅ | ✅ | 🟨 | | emailAddress | ✅ | ✅ | ❌ | ✅ | | expirationTime | ✅ | ✅ | ✅ | ❌ | | deleted | ✅ | ✅ | ❌ | ❌ | | photoLink | ✅ | ✅ | ❌ | ❌ | | pendingOwner | ❌ | ✅ | ❌ | ❌ | > **Dropbox**: Invited users who do not have a Dropbox account will not have a `displayName`. [`OmhIdentity.Group`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-identity/-group) | Property | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | -------------- | :----------------: | :--------------------: | :------: | :-----: | | id | ❌ | ❌ | ✅ | ✅ | | displayName | ✅ | ✅ | ✅ | ✅ | | emailAddress | ✅ | ✅ | ❌ | ❌ | | expirationTime | ✅ | ✅ | ✅ | ❌ | | deleted | ✅ | ✅ | ❌ | ❌ | [`OmhPermissionRole`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-permission-role) | Role | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | --------- | :----------------: | :--------------------: | :------: | :-----: | | OWNER | ✅ | ✅ | ✅ | ✅ | | WRITER | ✅ | ✅ | ✅ | 🟨 | | COMMENTER | ✅ | ✅ | ❌ | ✅ | | READER | ✅ | ✅ | ✅ | 🟨 | > **Dropbox**: > > - While the `READER` role is documented in the API, Dropbox does not support granting this role. Attempting to do so will throw an exception with the user message: `viewer_no_comment isn’t yet supported`. > - Dropbox also does not support granting the `WRITER` role for uploaded files. Any attempt will result in an exception with the user message: `You don’t have permission to perform this action`. [`OmhPermissionRecipient`](https://openmobilehub.github.io/android-omh-storage/api/packages/core/com.openmobilehub.android.storage.core.model/-omh-permission-recipient) | Type | Google Drive (GMS) | Google Drive (non-GMS) | OneDrive | Dropbox | | ------------ | :----------------: | :--------------------: | :------: | :-----: | | User | ✅ | ✅ | ✅ | ✅ | | Group | ✅ | ✅ | ✅ | ❌ | | Domain | ✅ | ✅ | ❌ | ❌ | | Anyone | ✅ | ✅ | ❌ | ❌ | | WithObjectId | ❌ | ❌ | ✅ | ✅ | | WithAlias | ❌ | ❌ | ✅ | ❌ | > **Dropbox**: To invite a group, use `WithObjectId` and provide the group ID.

Contributing

License