IFileBrowserDataProvider | Jodit Editor - v3.24.5

Hierarchy

IDestructible
- IFileBrowserDataProvider

Implemented by

DataProvider

Index

Methods

canI createFolder crop destruct fileRemove fileRename folderRemove folderRename getPathByUrl items itemsEx move onProgress permissions resize tree

Properties

getMessage isSuccess

Methods

canI

canI(action: string): boolean
Parameters
- action: string
Returns boolean

createFolder

createFolder(name: string, path: string, source: string): Promise<boolean>
Parameters
- name: string
- path: string
- source: string
Returns Promise<boolean>

crop

crop(path: string, source: string, name: string, newname: string | void, box: void | ImageBox): Promise<boolean>
Parameters
- path: string
- source: string
- name: string
- newname: string | void
- box: void | ImageBox
Returns Promise<boolean>

destruct

destruct(jodit?: IViewBased<IViewOptions>): any
Parameters
- Optional jodit: IViewBased<IViewOptions>
Returns any

fileRemove

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

fileRename

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

folderRemove

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

folderRename

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

getPathByUrl

getPathByUrl(url: string): Promise<{
    name: string;
    path: string;
    source: string;
}>
Parameters
- url: string
Returns Promise<{
    name: string;
    path: string;
    source: string;
}>

items

items(path: string, source: string, mods?: IFileBrowserDataProviderItemsMods): Promise<IFileBrowserItem[]>
Parameters
- path: string
- source: string
- Optional mods: IFileBrowserDataProviderItemsMods
Returns Promise<IFileBrowserItem[]>

itemsEx

itemsEx(path: string, source: string, mods?: IFileBrowserDataProviderItemsMods): Promise<{
items: IFileBrowserItem[];
loadedTotal: number;
}>
Parameters
- path: string
- source: string
- Optional mods: IFileBrowserDataProviderItemsMods
Returns Promise<{
items: IFileBrowserItem[];
loadedTotal: number;
}>

move

move(filepath: string, path: string, source: string, isFile: boolean): Promise<boolean>
Parameters
- filepath: string
- path: string
- source: string
- isFile: boolean
Returns Promise<boolean>

onProgress

onProgress(callback: ((percentage: number) => void)): void
Parameters
- callback: ((percentage: number) => void)
  - - (percentage: number): void
    - Parameters
      
      percentage: number
      
      Returns void
Returns void

permissions

permissions(path: string, source: string): Promise<Nullable<IPermissions>>
Parameters
- path: string
- source: string
Returns Promise<Nullable<IPermissions>>

resize

resize(path: string, source: string, name: string, newname: string | void, box: void | ImageBox): Promise<boolean>
Parameters
- path: string
- source: string
- name: string
- newname: string | void
- box: void | ImageBox
Returns Promise<boolean>

tree

tree(path: string, source: string): Promise<ISourcesFiles>
Parameters
- path: string
- source: string
Returns Promise<ISourcesFiles>

Properties

getMessage

getMessage: ((resp: IFileBrowserAnswer) => string)

Type declaration

- (resp: IFileBrowserAnswer): string
- Parameters
  - resp: IFileBrowserAnswer
  Returns string

isSuccess

isSuccess: ((resp: IFileBrowserAnswer) => boolean)

Type declaration

- (resp: IFileBrowserAnswer): boolean
- Parameters
  - resp: IFileBrowserAnswer
  Returns boolean

Jodit PRO

If you like Jodit - try Jodit PRO