1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00
joplin/packages/react-native-saf-x
2024-03-02 11:04:23 +00:00
..
android Android: Fixed #8533: Fix sharing image to Joplin (#8970) 2023-10-05 11:51:46 +01:00
scripts Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
src Tools: Enable eslint rule comma-dangle: always-multiline for functions 2023-08-23 18:28:00 +01:00
.editorconfig Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
.eslintignore Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
.gitattributes Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
.gitignore Mobile: Improved Vosk support (beta, fr only) (#8131) 2023-05-07 12:05:41 +01:00
.yarnrc Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
bob.config.js Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
CONTRIBUTING.md Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
LICENSE Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
package.json Chore: Setup new release 3.0 2024-03-02 11:04:23 +00:00
react-native-saf-x.podspec Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
README.md Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
tsconfig.build.json Android: Fixes #5779: Fixed android filesystem sync (#6395) 2022-07-10 15:26:24 +01:00
tsconfig.json Chore: Clean up react-native-saf-x 2022-07-11 17:41:44 +01:00

react-native-saf-x

A module to help simplify usage of scoped storages on android.

intended to use when targeting Android API level 30+

Installation

npm install react-native-saf-x

or

yarn add react-native-saf-x

Usage

After receiving a content uri using openDocumentTree function, you can use this as if like it's a normal path like we are used to. This is the intended behaviour, if you find any problems or if something does not behave as intended, please create an issue.

Note that each method can reject when there's an unexpected error or when the permission is revoked.

Example:

import { openDocumentTree, mkdir } from "react-native-saf-x";

// somewhere in the app .....

async function testIt() {
  const doc = await openDocumentTree(true);
  if (doc && doc.uri) {
    // user has selected a directory and uri is available
    // you can save this uri as base directory in your app and reuse it anywhere you want
    await mkdir(doc.uri + '/foo/bar'); // creates foo/bar folder and subfolder at selected directory
  }
}

For more examples look at example folder in the source.

Table of contents

Type aliases

Functions

Type aliases

CreateDocumentOptions

Ƭ CreateDocumentOptions: FileOperationOptions & { initialName?: string }

Defined in

index.tsx:80


DocumentFileDetail

Ƭ DocumentFileDetail: Object

Type declaration

Name Type
lastModified number
mime? string
name string
size? number
type "directory" | "file"
uri string

Defined in

index.tsx:60


Encoding

Ƭ Encoding: "utf8" | "base64" | "ascii"

Defined in

index.tsx:22


FileOperationOptions

Ƭ FileOperationOptions: Object

Type declaration

Name Type Description
append? boolean Append data to the file. If not set file content will be overwritten.
encoding? Encoding Defaults to 'utf8'
mimeType? string mime type of the file being saved. Defaults to '*/*'

Defined in

index.tsx:69

Functions

copyFile

copyFile(srcUri, destUri, options?): Promise<null | DocumentFileDetail>

Copy file from source uri to destination uri. promise Rejects if destination already exists and replaceIfDestinationExists option is not set to true. Does not support moving directories.

Parameters

Name Type
srcUri string
destUri string
options? FileTransferOptions

Returns

Promise<null | DocumentFileDetail>

Defined in

index.tsx:214


createDocument

createDocument(data, options?): Promise<null | DocumentFileDetail>

Open the Document Picker to save a file. Returns an object of type DocumentFileDetail or null if user did not select a file.

Parameters

Name Type
data string
options? CreateDocumentOptions

Returns

Promise<null | DocumentFileDetail>

Defined in

index.tsx:105


createFile

createFile(uriString, options?): Promise<DocumentFileDetail>

Creates an empty file at given uri. Rejects if a file or directory exist at given uri.

Parameters

Name Type
uriString string
options? Pick<FileOperationOptions, "mimeType">

Returns

Promise<DocumentFileDetail>

Defined in

index.tsx:150


exists

exists(uriString): Promise<boolean>

Check if there's a document located at the given uri.

Parameters

Name Type
uriString string

Returns

Promise<boolean>

Defined in

index.tsx:117


getPersistedUriPermissions

getPersistedUriPermissions(): Promise<string[]>

Returns a list of all the persisted uri permissions.

Returns

Promise<string[]>

Defined in

index.tsx:186


hasPermission

hasPermission(uriString): Promise<boolean>

Check if you have permission to access the uri.

Parameters

Name Type
uriString string

Returns

Promise<boolean>

Defined in

index.tsx:112


listFiles

listFiles(uriString): Promise<DocumentFileDetail[]>

List all files and folders in a directory uri.

Parameters

Name Type
uriString string

Returns

Promise<DocumentFileDetail[]>

Defined in

index.tsx:196


mkdir

mkdir(uriString): Promise<DocumentFileDetail>

Create a directory at given uri. Automatically creates folders in path if needed. You can use it to create nested directories easily. Rejects if it fails.

Parameters

Name Type
uriString string

Returns

Promise<DocumentFileDetail>

Defined in

index.tsx:172


moveFile

moveFile(srcUri, destUri, options?): Promise<null | DocumentFileDetail>

Move file from source uri to destination uri. promise Rejects if destination already exists and replaceIfDestinationExists option is not set to true. Does not support moving directories.

Parameters

Name Type
srcUri string
destUri string
options? FileTransferOptions

Returns

Promise<null | DocumentFileDetail>

Defined in

index.tsx:229


openDocument

openDocument(persist): Promise<null | DocumentFileDetail>

Open the Document Picker to select a file. Returns an object of type DocumentFileDetail or null if user did not select a file.

Parameters

Name Type
persist boolean

Returns

Promise<null | DocumentFileDetail>

Defined in

index.tsx:97


openDocumentTree

openDocumentTree(persist): Promise<null | DocumentFileDetail>

Open the Document Picker to select a folder. Read/Write Permission will be granted to the selected folder. Returns an object of type DocumentFileDetail or null if user did not select a folder.

Parameters

Name Type
persist boolean

Returns

Promise<null | DocumentFileDetail>

Defined in

index.tsx:89


readFile

readFile(uriString, options?): Promise<string>

Read contents of the given uri. uri must point to a file.

Parameters

Name Type
uriString string
options? Pick<FileOperationOptions, "encoding">

Returns

Promise<string>

Defined in

index.tsx:122


releasePersistableUriPermission

releasePersistableUriPermission(uriString): Promise<void>

Remove a uri from persisted uri permissions list.

Parameters

Name Type
uriString string

Returns

Promise<void>

Defined in

index.tsx:191


rename

rename(uriString, newName): Promise<boolean>

Renames the document at given uri. uri can be file or folder. Resolves with true if successful and false otherwise.

Parameters

Name Type
uriString string
newName string

Returns

Promise<boolean>

Defined in

index.tsx:181


stat

stat(uriString): Promise<DocumentFileDetail>

Get details for a file/directory at given uri.

Parameters

Name Type
uriString string

Returns

Promise<DocumentFileDetail>

Defined in

index.tsx:201


unlink(uriString): Promise<boolean>

Removes the file or directory at given uri. Resolves with true if delete is successful, false otherwise.

Parameters

Name Type
uriString string

Returns

Promise<boolean>

Defined in

index.tsx:162


writeFile

writeFile(uriString, data, options?): Promise<string>

Writes the given data to the file at given uri. Tries to create the file if does not already exist before writing to it. Resolves with given uriString if successful.

Parameters

Name Type
uriString string
data string
options? FileOperationOptions

Returns

Promise<string>

Defined in

index.tsx:136

Caveats

Due to simplyifing the uri structure usage, file and directories should not have the same name at a given uri. doing so can cause unexpected results. for example in a folder named "foo", do not create "bar" file and "bar" directory making the uri being "foo/bar" for both cases.


Thanks to

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT