Tham chiếu API

Tệp

Kiểm tra app.capabilities để biết tính năng và app.access cùng quyền máy chủ để xác định quyền truy cập. Thay giá trị mẫu trước khi gọi.

Định nghĩa kiểu

graphql
type Subscription {
  fileSearchResults(root: String!, query: String!, offset: Int!, limit: Int!, sortBy: FileSortBy!): FileSearchResults!
}

type Mutation {
  cacheZipEntry(path: String!): String!
  copyFileToDirectory(src: String!, directory: String!, name: String!): String!
  createDir(path: String!): File!
  createFile(path: String!): File!
  createFileTask(type: FileTaskType!, title: String!, ops: [FileTaskOpInput!]!, waitForCompletion: Boolean! = false): FileTask!
  createZipArchive(paths: [String!]!, target: String!): String!
  deleteFiles(paths: [String!]!): ActionResult!
  deleteTrashedFile(path: String!): Boolean!
  extractZipArchive(path: String!, target: String!): String!
  renameFile(path: String!, name: String!): String
  restoreFiles(paths: [String!]!): ActionResult!
  trashFiles(paths: [String!]!): ActionResult!
  writeTextFile(path: String!, content: String!, overwrite: Boolean!): File!
}

type Query {
  fileCount(root: String!, query: String!): Int!
  fileInfo(path: String!): FileInfo
  fileTasks(query: String!, offset: Int!, limit: Int!): [FileTask!]!
  files(root: String!, query: String!, offset: Int!, limit: Int!, sortBy: FileSortBy!): [File!]!
  recentFiles: [File!]!
  trashedFileCount(query: String!): Int!
  trashedFiles(query: String!, offset: Int!, limit: Int!, sortBy: TrashedFileSortBy!): [TrashedFile!]!
}

type ActionResult {
	affectedCount: Int!
}

type AudioFileInfo {
	durationMs: Long!
	location: Location
}

type File {
	permission: String!
	
	mediaId: ID
	name: String!
	path: String!
	createdAt: Instant
	updatedAt: Instant!
	size: Long!
	isDir: Boolean!
	childCount: Int!
	url: String!
	isSystem: Boolean!
}

type FileInfo {
	path: String!
	updatedAt: Instant!
	size: Long!
	data: MediaFileInfo
}

type FileSearchResults {
	items: [File!]!
	offset: Long!
	count: Long!
	complete: Boolean!
}

enum FileSortBy {
	UPDATED_AT_ASC
	UPDATED_AT_DESC
	SIZE_ASC
	SIZE_DESC
	NAME_ASC
	NAME_DESC
}

type FileTask {
	id: ID!
	clientId: ID!
	type: FileTaskType!
	title: String!
	status: FileTaskStatus!
	error: String!
	totalBytes: Long!
	doneBytes: Long!
	totalItems: Long!
	doneItems: Long!
	createdAt: Instant!
	updatedAt: Instant!
	completedOps: [FileTaskCompletedOp!]!
}

type FileTaskCompletedOp {
	src: String!
	dst: String!
}

input FileTaskOpInput {
	src: String!
	dst: String!
	overwrite: Boolean!
}

enum FileTaskStatus {
	QUEUED
	RUNNING
	DONE
	ERROR
}

enum FileTaskType {
	COPY
	MOVE
}

type ImageFileInfo {
	make: String!
	model: String!
	rotation: Int!
	colorSpace: String!
	apertureValue: Float!
	exposureTime: String!
	focalLength: String!
	isoSpeed: Int!
	takenAt: Instant
	flash: Int!
	fNumber: Float!
	exposureProgram: Int!
	meteringMode: Int!
	whiteBalance: Int!
	creator: String!
	resolutionX: Int!
	resolutionY: Int!
	description: String!
	width: Int!
	height: Int!
	location: Location
}

scalar Instant

type Location {
	latitude: Float!
	longitude: Float!
}

scalar Long

union MediaFileInfo = ImageFileInfo | AudioFileInfo | VideoFileInfo

type TrashedFile {
	id: ID!
	type: TrashedFileType!
	originalPath: String!
	disk: String!
	trashRelPath: String!
	deletedAt: Instant!
	uid: Int!
	gid: Int!
	mode: Int!
	sizeBytes: Long
	entryCount: Int
	displayName: String!
	trashedPath: String!
}

enum TrashedFileSortBy {
	DATE_ASC
	DATE_DESC
	SIZE_ASC
	SIZE_DESC
	NAME_ASC
	NAME_DESC
}

enum TrashedFileType {
	FILE
	DIR
}

type VideoFileInfo {
	width: Int!
	height: Int!
	durationMs: Long!
	rotation: Int!
	displayWidth: Int!
	displayHeight: Int!
	bitrate: Long!
	frameRate: Float!
	title: String!
	artist: String!
	album: String!
	genre: String!
	takenAt: Instant
	writer: String!
	composer: String!
	location: Location
}

Thao tác

subscription

fileSearchResults

Nhận ảnh chụp kết quả tìm tệp cho gốc, bộ lọc, trang và thứ tự sắp xếp được cung cấp.

graphql
subscription fileSearchResults($root: String!, $query: String!, $offset: Int!, $limit: Int!, $sortBy: FileSortBy!) {
  fileSearchResults(root: $root, query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { offset count complete }
}
mutation

cacheZipEntry

Giải nén mục ZIP được chỉ định vào bộ nhớ đệm và trả về đường dẫn.

graphql
mutation cacheZipEntry($path: String!) {
  cacheZipEntry(path: $path)
}
mutation

copyFileToDirectory

Sao chép tệp vào thư mục với tên đích được cung cấp và trả về đường dẫn nếu có.

graphql
mutation copyFileToDirectory($src: String!, $directory: String!, $name: String!) {
  copyFileToDirectory(src: $src, directory: $directory, name: $name)
}
mutation

createDir

Tạo thư mục mới và trả về dưới dạng đối tượng File.

graphql
mutation createDir($path: String!) {
  createDir(path: $path) { permission mediaId name path createdAt updatedAt size isDir }
}
mutation

createFile

Tạo tệp rỗng tại đường dẫn được cung cấp và trả về siêu dữ liệu.

graphql
mutation createFile($path: String!) {
  createFile(path: $path) { permission mediaId name path createdAt updatedAt size isDir }
}
mutation

createFileTask

Tạo tác vụ sao chép hoặc di chuyển hàng loạt; tùy chọn chờ hoàn tất trước khi trả về trạng thái.

graphql
mutation createFileTask($type: FileTaskType!, $title: String!, $ops: [FileTaskOpInput!]!, $waitForCompletion: Boolean!) {
  createFileTask(type: $type, title: $title, ops: $ops, waitForCompletion: $waitForCompletion) { id clientId type title status error totalBytes doneBytes }
}
mutation

createZipArchive

Tạo kho ZIP từ các đường dẫn đã chọn tại đường dẫn đích.

graphql
mutation createZipArchive($paths: [String!]!, $target: String!) {
  createZipArchive(paths: $paths, target: $target)
}
mutation

deleteFiles

Xóa một hoặc nhiều tệp hoặc thư mục theo đường dẫn chính xác.

graphql
mutation deleteFiles($paths: [String!]!) {
  deleteFiles(paths: $paths) { affectedCount }
}
mutation

deleteTrashedFile

Xóa vĩnh viễn một mục khỏi thùng rác tệp.

graphql
mutation deleteTrashedFile($path: String!) {
  deleteTrashedFile(path: $path)
}
mutation

extractZipArchive

Giải nén kho ZIP vào thư mục đích.

graphql
mutation extractZipArchive($path: String!, $target: String!) {
  extractZipArchive(path: $path, target: $target)
}
mutation

renameFile

Đổi tên tệp hoặc thư mục.

graphql
mutation renameFile($path: String!, $name: String!) {
  renameFile(path: $path, name: $name)
}
mutation

restoreFiles

Khôi phục các đường dẫn tệp trong thùng rác đã chỉ định và báo số bị tác động.

graphql
mutation restoreFiles($paths: [String!]!) {
  restoreFiles(paths: $paths) { affectedCount }
}
mutation

trashFiles

Chuyển các đường dẫn tệp đã chỉ định vào thùng rác và báo số bị tác động.

graphql
mutation trashFiles($paths: [String!]!) {
  trashFiles(paths: $paths) { affectedCount }
}
mutation

writeTextFile

Ghi văn bản vào đường dẫn tệp được cung cấp theo chính sách ghi đè được yêu cầu.

graphql
mutation writeTextFile($path: String!, $content: String!, $overwrite: Boolean!) {
  writeTextFile(path: $path, content: $content, overwrite: $overwrite) { permission mediaId name path createdAt updatedAt size isDir }
}
query

fileCount

Đếm kết quả tìm tệp dưới gốc đã chỉ định, bỏ qua phân trang.

graphql
# Total matches for the same query, ignoring paging.
query fileCount($root: String!, $query: String!) {
  fileCount(root: $root, query: $query)
}
query

fileInfo

Đọc thuộc tính tệp, siêu dữ liệu phương tiện được hỗ trợ và thông tin thẻ của một đường dẫn.

graphql
query fileInfo($path: String!) {
  fileInfo(path: $path) { path updatedAt size }
}
query

fileTasks

Đọc một trang tác vụ thao tác tệp khớp truy vấn.

graphql
query fileTasks($query: String!, $offset: Int!, $limit: Int!) {
  fileTasks(query: $query, offset: $offset, limit: $limit) { id clientId type title status error totalBytes doneBytes }
}
query

files

Liệt kê và tìm tệp dưới đường dẫn gốc có phân trang. Truyền query rỗng để liệt kê tất cả.

graphql
# One page of a directory listing, filtered and sorted by the search
# DSL. `query` may carry a `parent` field to redirect the root, which
# is what the file manager's breadcrumb links send.
query files($root: String!, $query: String!, $offset: Int!, $limit: Int!, $sortBy: FileSortBy!) {
  files(root: $root, query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { permission mediaId name path createdAt updatedAt size isDir }
}
query

recentFiles

Liệt kê tệp mới mở gần đây.

graphql
# Recently-opened files. Reading them is a storage read, so this one
# gates — plain-app's `recentFiles` calls `checkEnabledAsync`.
query recentFiles {
  recentFiles { permission mediaId name path createdAt updatedAt size isDir }
}
query

trashedFileCount

Đếm mục trong thùng rác tệp.

graphql
query trashedFileCount($query: String!) {
  trashedFileCount(query: $query)
}
query

trashedFiles

Tìm tệp trong thùng rác có phân trang và sắp xếp.

graphql
query trashedFiles($query: String!, $offset: Int!, $limit: Int!, $sortBy: TrashedFileSortBy!) {
  trashedFiles(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { id type originalPath disk trashRelPath deletedAt uid gid }
}