DataProvider

modules/file-browser.DataProvider

ImplementsImplements

• IFileBrowserDataProvider

constructorconstructor

new DataProvider(parent, options): DataProvider

ParametersParameters

Name	Type
parent	IViewBased<IViewOptions>
options	IFileBrowserOptions

ReturnsReturns

DataProvider

Defined inDefined in

src/modules/file-browser/data-provider.ts#61

parentparent

Readonly parent: IViewBased<IViewOptions>

Defined inDefined in

src/modules/file-browser/data-provider.ts#62

---

optionsoptions

Readonly options: IFileBrowserOptions

Defined inDefined in

src/modules/file-browser/data-provider.ts#63

oo

get o(): this["options"]

Alias for options

ReturnsReturns

this["options"]

Defined inDefined in

src/modules/file-browser/data-provider.ts#69

onProgressonProgress

onProgress(callback): void

ParametersParameters

Name	Type
callback	(percentage: number) => void

ReturnsReturns

void

Implementation ofImplementation of

IFileBrowserDataProvider.onProgress

Defined inDefined in

src/modules/file-browser/data-provider.ts#130

---

permissionspermissions

permissions(path, source): Promise<Nullable<IPermissions>>

Load permissions for path and source

ParametersParameters

Name	Type
path	string
source	string

ReturnsReturns

Promise<Nullable<IPermissions>>

Implementation ofImplementation of

IFileBrowserDataProvider.permissions

Defined inDefined in

src/modules/file-browser/data-provider.ts#137

---

canIcanI

canI(action): boolean

ParametersParameters

Name	Type
action	string

ReturnsReturns

boolean

Implementation ofImplementation of

IFileBrowserDataProvider.canI

Defined inDefined in

src/modules/file-browser/data-provider.ts#185

---

itemsitems

items(path, source, mods?): Promise<IFileBrowserItem[]>

Load items list by path and source

ParametersParameters

Name	Type
path	string
source	string
mods	IFileBrowserDataProviderItemsMods

ReturnsReturns

Promise<IFileBrowserItem[]>

Implementation ofImplementation of

IFileBrowserDataProvider.items

Defined inDefined in

src/modules/file-browser/data-provider.ts#241

---

itemsExitemsEx

itemsEx(path, source, mods?): Promise<{ items: IFileBrowserItem[] ; loadedTotal: number }>

Load items list by path and source

ParametersParameters

Name	Type
path	string
source	string
mods	IFileBrowserDataProviderItemsMods

ReturnsReturns

Promise<{ items: IFileBrowserItem[] ; loadedTotal: number }>

Implementation ofImplementation of

IFileBrowserDataProvider.itemsEx

Defined inDefined in

src/modules/file-browser/data-provider.ts#254

---

treetree

tree(path, source): Promise<ISourcesFiles>

ParametersParameters

Name	Type
path	string
source	string

ReturnsReturns

Promise<ISourcesFiles>

Implementation ofImplementation of

IFileBrowserDataProvider.tree

Defined inDefined in

src/modules/file-browser/data-provider.ts#309

---

getPathByUrlgetPathByUrl

getPathByUrl(url): Promise<any>

Get path by url. You can use this method in another modules

ParametersParameters

Name	Type
url	string

ReturnsReturns

Promise<any>

Implementation ofImplementation of

IFileBrowserDataProvider.getPathByUrl

Defined inDefined in

src/modules/file-browser/data-provider.ts#341

---

createFoldercreateFolder

createFolder(name, path, source): Promise<boolean>

Create a directory on the server

ParametersParameters

Name	Type	Description
name	string	Name the new folder
path	string	Relative directory in which you want create a folder
source	string	Server source key

ReturnsReturns

Promise<boolean>

Implementation ofImplementation of

IFileBrowserDataProvider.createFolder

Defined inDefined in

src/modules/file-browser/data-provider.ts#360

---

movemove

move(filepath, path, source, isFile): Promise<boolean>

Move a file / directory on the server

ParametersParameters

Name	Type	Description
filepath	string	The relative path to the file / folder source
path	string	Relative to the directory where you want to move the file / folder
source	string	-
isFile	boolean	-

ReturnsReturns

Promise<boolean>

Implementation ofImplementation of

IFileBrowserDataProvider.move

Defined inDefined in

src/modules/file-browser/data-provider.ts#386

---

fileRemovefileRemove

fileRemove(path, file, source): Promise<string>

Deleting a file

ParametersParameters

Name	Type	Description
path	string	Relative path
file	string	The filename
source	string	Source

ReturnsReturns

Promise<string>

Implementation ofImplementation of

IFileBrowserDataProvider.fileRemove

Defined inDefined in

src/modules/file-browser/data-provider.ts#454

---

folderRemovefolderRemove

folderRemove(path, file, source): Promise<string>

Deleting a folder

ParametersParameters

Name	Type	Description
path	string	Relative path
file	string	The filename
source	string	Source

ReturnsReturns

Promise<string>

Implementation ofImplementation of

IFileBrowserDataProvider.folderRemove

Defined inDefined in

src/modules/file-browser/data-provider.ts#465

---

folderRenamefolderRename

folderRename(path, name, newname, source): Promise<string>

Rename folder

ParametersParameters

Name	Type
path	string
name	string
newname	string
source	string

ReturnsReturns

Promise<string>

Implementation ofImplementation of

IFileBrowserDataProvider.folderRename

Defined inDefined in

src/modules/file-browser/data-provider.ts#507

---

fileRenamefileRename

fileRename(path, name, newname, source): Promise<string>

Rename file

ParametersParameters

Name	Type
path	string
name	string
newname	string
source	string

ReturnsReturns

Promise<string>

Implementation ofImplementation of

IFileBrowserDataProvider.fileRename

Defined inDefined in

src/modules/file-browser/data-provider.ts#519

---

cropcrop

crop(path, source, name, newname, box): Promise<boolean>

Send command to server to crop image

ParametersParameters

Name	Type
path	string
source	string
name	string
newname	string | void
box	void | ImageBox

ReturnsReturns

Promise<boolean>

Implementation ofImplementation of

IFileBrowserDataProvider.crop

Defined inDefined in

src/modules/file-browser/data-provider.ts#568

---

resizeresize

resize(path, source, name, newname, box): Promise<boolean>

Send command to server to resize image

ParametersParameters

Name	Type
path	string
source	string
name	string
newname	string | void
box	void | ImageBox

ReturnsReturns

Promise<boolean>

Implementation ofImplementation of

IFileBrowserDataProvider.resize

Defined inDefined in

src/modules/file-browser/data-provider.ts#581

---

getMessagegetMessage

getMessage(resp): string

ParametersParameters

Name	Type
resp	IFileBrowserAnswer

ReturnsReturns

string

Implementation ofImplementation of

IFileBrowserDataProvider.getMessage

Defined inDefined in

src/modules/file-browser/data-provider.ts#591

---

isSuccessisSuccess

isSuccess(resp): boolean

ParametersParameters

Name	Type
resp	IFileBrowserAnswer

ReturnsReturns

boolean

Implementation ofImplementation of

IFileBrowserDataProvider.isSuccess

Defined inDefined in

src/modules/file-browser/data-provider.ts#595

---

destructdestruct

destruct(): any

ReturnsReturns

any

Implementation ofImplementation of

IFileBrowserDataProvider.destruct

Defined inDefined in

jodit/src/modules/file-browser/data-provider.ts:599