Class FilePicker<IsMultiSelect>

SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors SPDX-License-Identifier: AGPL-3.0-or-later

Type Parameters

IsMultiSelect extends boolean

Index

Constructors

Methods

Constructors

constructor

new FilePicker<IsMultiSelect extends boolean>(
    title: string,
    multiSelect: IsMultiSelect,
    mimeTypeFilter: string[],
    directoriesAllowed: boolean,
    buttons: IFilePickerButton[] | IFilePickerButtonFactory,
    path?: string,
    filter?: IFilePickerFilter,
    container?: string,
    disabledNavigation?: boolean,
): FilePicker<IsMultiSelect>
Type Parameters
- IsMultiSelect extends boolean
Parameters
- title: string
- multiSelect: IsMultiSelect
- mimeTypeFilter: string[]
- directoriesAllowed: boolean
- buttons: IFilePickerButton[] | IFilePickerButtonFactory
- Optionalpath: string
- Optionalfilter: IFilePickerFilter
- Optionalcontainer: string
- OptionaldisabledNavigation: boolean
Returns FilePicker<IsMultiSelect>
- Defined in dist/filepicker-builder.d.ts:28

Methods

pick

pick(): Promise<IsMultiSelect extends true ? string[] : string>
Pick files using the FilePicker

Returns Promise<IsMultiSelect extends true ? string[] : string>
Promise with array of paths of picked files or rejected promise on close without picking
- Defined in dist/filepicker-builder.d.ts:40

pickNodes

pickNodes(): Promise<Node[]>
Pick files using the FilePicker.

Returns Promise<Node[]>
Promise with array of picked files or rejected promise on close without picking
- Defined in dist/filepicker-builder.d.ts:34