capacitor-advanced-file-manager
Version:
Advanced file manager plugin for Capacitor with comprehensive file system operations including browse, create, edit, delete, move, copy, and search files and directories.
947 lines • 22 kB
JSON
{
"api": {
"name": "AdvancedFileManagerPlugin",
"slug": "advancedfilemanagerplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "requestPermissions",
"signature": "() => Promise<PermissionResult>",
"parameters": [],
"returns": "Promise<PermissionResult>",
"tags": [],
"docs": "",
"complexTypes": [
"PermissionResult"
],
"slug": "requestpermissions"
},
{
"name": "checkPermissions",
"signature": "() => Promise<PermissionResult>",
"parameters": [],
"returns": "Promise<PermissionResult>",
"tags": [],
"docs": "",
"complexTypes": [
"PermissionResult"
],
"slug": "checkpermissions"
},
{
"name": "openSystemFilePicker",
"signature": "(options: SystemFilePickerOptions) => Promise<SystemFilePickerResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SystemFilePickerOptions"
}
],
"returns": "Promise<SystemFilePickerResult>",
"tags": [],
"docs": "",
"complexTypes": [
"SystemFilePickerResult",
"SystemFilePickerOptions"
],
"slug": "opensystemfilepicker"
},
{
"name": "openSystemFileManager",
"signature": "(path?: string | undefined) => Promise<void>",
"parameters": [
{
"name": "path",
"docs": "",
"type": "string | undefined"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "opensystemfilemanager"
},
{
"name": "openFileWithSystemApp",
"signature": "(filePath: string, mimeType?: string | undefined) => Promise<void>",
"parameters": [
{
"name": "filePath",
"docs": "",
"type": "string"
},
{
"name": "mimeType",
"docs": "",
"type": "string | undefined"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "openfilewithsystemapp"
},
{
"name": "listDirectory",
"signature": "(options: ListDirectoryOptions) => Promise<ListDirectoryResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ListDirectoryOptions"
}
],
"returns": "Promise<ListDirectoryResult>",
"tags": [],
"docs": "",
"complexTypes": [
"ListDirectoryResult",
"ListDirectoryOptions"
],
"slug": "listdirectory"
},
{
"name": "createDirectory",
"signature": "(options: CreateDirectoryOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CreateDirectoryOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CreateDirectoryOptions"
],
"slug": "createdirectory"
},
{
"name": "deleteDirectory",
"signature": "(options: FileOperationOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "deletedirectory"
},
{
"name": "createFile",
"signature": "(options: CreateFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CreateFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CreateFileOptions"
],
"slug": "createfile"
},
{
"name": "readFile",
"signature": "(options: ReadFileOptions) => Promise<ReadFileResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ReadFileOptions"
}
],
"returns": "Promise<ReadFileResult>",
"tags": [],
"docs": "",
"complexTypes": [
"ReadFileResult",
"ReadFileOptions"
],
"slug": "readfile"
},
{
"name": "writeFile",
"signature": "(options: WriteFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "WriteFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"WriteFileOptions"
],
"slug": "writefile"
},
{
"name": "deleteFile",
"signature": "(options: FileOperationOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "deletefile"
},
{
"name": "moveFile",
"signature": "(options: MoveFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "MoveFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"MoveFileOptions"
],
"slug": "movefile"
},
{
"name": "copyFile",
"signature": "(options: CopyFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CopyFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CopyFileOptions"
],
"slug": "copyfile"
},
{
"name": "renameFile",
"signature": "(options: RenameFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "RenameFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"RenameFileOptions"
],
"slug": "renamefile"
},
{
"name": "getFileInfo",
"signature": "(options: FileOperationOptions) => Promise<FileInfo>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<FileInfo>",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo",
"FileOperationOptions"
],
"slug": "getfileinfo"
},
{
"name": "exists",
"signature": "(options: FileOperationOptions) => Promise<{ exists: boolean; }>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<{ exists: boolean; }>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "exists"
},
{
"name": "searchFiles",
"signature": "(options: SearchFilesOptions) => Promise<SearchFilesResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SearchFilesOptions"
}
],
"returns": "Promise<SearchFilesResult>",
"tags": [],
"docs": "",
"complexTypes": [
"SearchFilesResult",
"SearchFilesOptions"
],
"slug": "searchfiles"
},
{
"name": "echo",
"signature": "(options: { value: string; }) => Promise<{ value: string; }>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "{ value: string; }"
}
],
"returns": "Promise<{ value: string; }>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "echo"
}
],
"properties": []
},
"interfaces": [
{
"name": "PermissionResult",
"slug": "permissionresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "granted",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean"
},
{
"name": "message",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "SystemFilePickerResult",
"slug": "systemfilepickerresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "选择的文件信息列表",
"complexTypes": [
"SelectedFileInfo"
],
"type": "SelectedFileInfo[]"
},
{
"name": "directories",
"tags": [],
"docs": "选择的目录信息列表",
"complexTypes": [
"SelectedFileInfo"
],
"type": "SelectedFileInfo[]"
},
{
"name": "cancelled",
"tags": [],
"docs": "是否被用户取消",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "SelectedFileInfo",
"slug": "selectedfileinfo",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "name",
"tags": [],
"docs": "文件名",
"complexTypes": [],
"type": "string"
},
{
"name": "path",
"tags": [],
"docs": "文件路径（可能是真实路径或URI）",
"complexTypes": [],
"type": "string"
},
{
"name": "uri",
"tags": [],
"docs": "原始URI（移动端）",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "size",
"tags": [],
"docs": "文件大小",
"complexTypes": [],
"type": "number"
},
{
"name": "type",
"tags": [],
"docs": "文件类型",
"complexTypes": [],
"type": "'file' | 'directory'"
},
{
"name": "mimeType",
"tags": [],
"docs": "MIME类型",
"complexTypes": [],
"type": "string"
},
{
"name": "mtime",
"tags": [],
"docs": "修改时间",
"complexTypes": [],
"type": "number"
},
{
"name": "ctime",
"tags": [],
"docs": "创建时间",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SystemFilePickerOptions",
"slug": "systemfilepickeroptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "type",
"tags": [],
"docs": "选择类型",
"complexTypes": [],
"type": "'file' | 'directory' | 'both'"
},
{
"name": "multiple",
"tags": [],
"docs": "是否允许多选",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "accept",
"tags": [],
"docs": "文件类型过滤",
"complexTypes": [],
"type": "string[] | undefined"
},
{
"name": "startDirectory",
"tags": [],
"docs": "起始目录",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "title",
"tags": [],
"docs": "标题",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "ListDirectoryResult",
"slug": "listdirectoryresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo"
],
"type": "FileInfo[]"
},
{
"name": "totalCount",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "FileInfo",
"slug": "fileinfo",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "name",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "size",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "type",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'file' | 'directory'"
},
{
"name": "mtime",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "ctime",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "permissions",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "isHidden",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "ListDirectoryOptions",
"slug": "listdirectoryoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "showHidden",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "sortBy",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'name' | 'size' | 'mtime' | 'type' | undefined"
},
{
"name": "sortOrder",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'asc' | 'desc' | undefined"
}
]
},
{
"name": "CreateDirectoryOptions",
"slug": "createdirectoryoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "recursive",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "FileOperationOptions",
"slug": "fileoperationoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "CreateFileOptions",
"slug": "createfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
}
]
},
{
"name": "ReadFileResult",
"slug": "readfileresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "ReadFileOptions",
"slug": "readfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
}
]
},
{
"name": "WriteFileOptions",
"slug": "writefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
},
{
"name": "append",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "MoveFileOptions",
"slug": "movefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "sourcePath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "destinationPath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "CopyFileOptions",
"slug": "copyfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "sourcePath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "destinationPath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "overwrite",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "RenameFileOptions",
"slug": "renamefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "newName",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "SearchFilesResult",
"slug": "searchfilesresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo"
],
"type": "FileInfo[]"
},
{
"name": "totalFound",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SearchFilesOptions",
"slug": "searchfilesoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "directory",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "query",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "searchType",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'name' | 'content' | 'both' | undefined"
},
{
"name": "fileTypes",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string[] | undefined"
},
{
"name": "maxResults",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "recursive",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}