Documents by Readdle

Documents by Readdle is Readdle's file manager, media player, and document hub for iPhone and iPad. Protocol Launcher allows you to generate Documents URL scheme links to open files stored inside the app.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Open File

Open a file stored in the My Files section with the documented rdocs:///folder/subfolder/file.pdf form.

On-Demand

import { openFile } from 'protocol-launcher/documents-readdle'

const url = openFile({
  path: 'folder/subfolder/file.pdf',
})

Open File in Documents

Open Synced File

Open a file kept in Synced folders with the documented rdocs:///SyncedFolders/ static path.

On-Demand

import { openSyncedFile } from 'protocol-launcher/documents-readdle'

const url = openSyncedFile({
  path: 'folder1/folder2/test.pdf',
})

Open Synced File in Documents

Readdle notes that other app languages may require the translated version of the Synced folders part of the URL. Pass that segment as syncedFoldersPath when needed:

On-Demand

const localizedUrl = openSyncedFile({
  syncedFoldersPath: '同期フォルダ',
  path: 'folder1/folder2/test.pdf',
})

Open Localized Synced File

Generated URLs

openFile({ path: 'folder/subfolder/file.pdf' })
// => 'rdocs:///folder/subfolder/file.pdf'

openSyncedFile({ path: 'folder1/folder2/test.pdf' })
// => 'rdocs:///SyncedFolders/folder1/folder2/test.pdf'

openSyncedFile({
  syncedFoldersPath: '同期フォルダ',
  path: 'folder1/folder2/test.pdf',
})
// => 'rdocs:///同期フォルダ/folder1/folder2/test.pdf'

Official Documentation

• Documents URL scheme from Safari