PlainApp
Referência da API

Arquivos

Verificar app.capabilities para o suporte de funcionalidades e app.access juntamente com as permissões do anfitrião para autorização. Os exemplos usam valores sintéticos; substituir caminhos, ID, entradas e filtros antes da chamada.

Definições de Tipo

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
}

Operações

subscription

fileSearchResults

Receber instantâneos dos resultados de pesquisa de ficheiros para a raiz, filtro, página e ordem fornecidos.

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

Extrair a entrada ZIP indicada para a cache e devolver o respetivo caminho.

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

copyFileToDirectory

Copiar um ficheiro para um diretório com o nome de destino fornecido e devolver o caminho quando disponível.

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

createDir

Criar um diretório e devolvê-lo como objeto File.

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

createFile

Criar um ficheiro vazio no caminho fornecido e devolver os respetivos metadados.

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

createFileTask

Criar uma tarefa de cópia ou movimentação em lote; opcionalmente aguardar a conclusão antes de devolver o estado.

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

Criar um arquivo ZIP a partir dos caminhos selecionados no caminho de destino.

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

deleteFiles

Eliminar um ou mais ficheiros ou diretórios pelo caminho exato.

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

deleteTrashedFile

Eliminar permanentemente um item do lixo de ficheiros.

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

extractZipArchive

Extrair um arquivo ZIP para o diretório de destino.

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

renameFile

Mudar o nome de um ficheiro ou diretório.

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

restoreFiles

Restaurar os caminhos de ficheiros indicados no lixo e indicar a contagem afetada.

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

trashFiles

Mover os caminhos de ficheiros indicados para o lixo e indicar a contagem afetada.

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

writeTextFile

Escrever texto no caminho de ficheiro fornecido com a política de substituição pedida.

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

Contar os resultados de pesquisa de ficheiros sob a raiz indicada, ignorando a paginação.

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

fileInfo

Consultar os atributos do ficheiro, os metadados multimédia suportados e as etiquetas de um caminho.

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

fileTasks

Consultar uma página de tarefas de operações de ficheiros que correspondam à consulta.

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

Listar e pesquisar ficheiros sob um caminho raiz com paginação. Passar query vazio para listar todos.

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

Listar os ficheiros abertos recentemente.

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

Contar os itens no lixo de ficheiros.

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

trashedFiles

Pesquisar ficheiros no lixo com paginação e ordenação.

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 }
}