expo-document-picker
Version:
Provides access to the system's UI for selecting documents from the available providers on the user's device.
15 lines (14 loc) • 966 B
TypeScript
import { DocumentPickerOptions, DocumentResult } from './types';
export { DocumentPickerOptions, DocumentResult };
/**
* Display the system UI for choosing a document. By default, the chosen file is copied to [the app's internal cache directory](filesystem.md#filesystemcachedirectory).
* > **Notes for Web:** The system UI can only be shown after user activation (e.g. a `Button` press).
* Therefore, calling `getDocumentAsync` in `componentDidMount`, for example, will **not** work as
* intended. The `cancel` event will not be returned in the browser due to platform restrictions and
* inconsistencies across browsers.
*
* @return On success returns a promise that fulfils with [`DocumentResult`](#documentresult) object.
*
* If the user cancelled the document picking, the promise resolves to `{ type: 'cancel' }`.
*/
export declare function getDocumentAsync({ type, copyToCacheDirectory, multiple, }?: DocumentPickerOptions): Promise<DocumentResult>;