Skip to main content

CloudStorageScope

CloudStorageScope is a TypeScript enum containing the possible values for the scope parameters of the rest of the API.

Available scopes are documents and app_data. When using documents, data will be stored in the user-visible root directory of the cloud storage. When using app_data, the directory for app-specific data, usually hidden from the user, will be used. By default, all methods will use the app_data scope. This can either be overriden by explicitly providing a scope to the method or by setting a default scope on the provider using setProviderOptions({ scope }).

import { CloudStorageScope } from 'react-native-cloud-storage';

Definition​

enum CloudStorageScope {
  Documents = 'documents',
  AppData = 'app_data',
}

When using pure JavaScript, simply use the appropriate values:

CloudStorage.exists('/test.txt', 'documents');