PlainApp
Referência da API

Arquivos

Navegue e gerencie arquivos e diretórios. Suporta armazenamento com vários pontos de montagem (interno, cartão SD, USB).

Definições de Tipo

bash
type File {
  name: String!
  path: String!
  permission: String!        # "rw" | "r"
  createdAt: String          # ISO 8601, null on some filesystems
  updatedAt: String!         # ISO 8601
  size: Long!                # 0 for directories
  isDir: Boolean!
  childCount: Int!           # 0 for files; child count for directories
  mediaId: String!           # media store ID, empty when unavailable
}

type StorageMount {
  id: String!
  name: String!
  path: String!
  mountPoint: String!
  fsType: String!
  totalBytes: Long!
  usedBytes: Long!
  freeBytes: Long!
  remote: Boolean!
  alias: String!
}

type FileInfo {
  path: String!
  updatedAt: String!
  size: Long!
  tags: [Tag!]!
  data: MediaFileInfo          # image/video/audio metadata, null for other types
}

type MediaFileInfo {
  # Union-like structure; fields vary by media type (image / video / audio)
  width: Int
  height: Int
  duration: Int               # milliseconds (video / audio)
  artist: String
  album: String
  title: String
}

type FavoriteFolder {
  rootPath: String!
  fullPath: String!
  alias: String               # optional display alias, empty when not set
}

Operações

query

mounts

Liste todos os volumes de armazenamento disponíveis (interno, cartão SD, USB).

bash
query GetMounts {
  mounts {
    id name path mountPoint fsType totalBytes usedBytes freeBytes remote alias
  }
}
query

recentFiles

Liste arquivos modificados recentemente em todo o armazenamento. Origem da vista "Recentes" na UI Arquivos.

bash
query GetRecentFiles {
  recentFiles {
    name path permission createdAt updatedAt size isDir childCount mediaId
  }
}
query

files

Liste e pesquise arquivos em um caminho raiz com paginação. Passe uma consulta vazia para listar todos.

bash
query GetFiles($root: String!, $offset: Int!, $limit: Int!, $query: String!, $sortBy: FileSortBy!) {
  files(root: $root, offset: $offset, limit: $limit, query: $query, sortBy: $sortBy) {
    name path permission createdAt updatedAt size isDir childCount mediaId
  }
}
query

fileInfo

Obtenha stat + metadados de mídia + tags para um único arquivo. Passe fileName para que o servidor possa detectar imagem/vídeo/áudio e carregar largura, altura, duração, etc.

bash
query GetFileInfo($id: ID!, $path: String!, $fileName: String!) {
  fileInfo(id: $id, path: $path, fileName: $fileName) {
    path updatedAt size
    tags { id name }
    data { width height duration artist album title }
  }
}
query

fileIds

Resolve uma lista de caminhos de sistema de arquivos para seus IDs de media store (string vazia quando não indexados).

bash
query GetFileIds($paths: [String!]!) {
  fileIds(paths: $paths)
}
query

uploadedChunks

Lista os índices de chunk já recebidos para um upload em partes retomável. Usado para retomar uploads interrompidos.

bash
query GetUploadedChunks($fileId: String!) {
  uploadedChunks(fileId: $fileId)
}
mutation

createDir

Crie um novo diretório e o retorne como um objeto File.

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

renameFile

Renomeie um arquivo ou diretório.

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

writeTextFile

Grave conteúdo de texto em um arquivo. Defina overwrite=false para acrescentar um sufixo "(1)" quando o arquivo já existe.

bash
mutation WriteTextFile($path: String!, $content: String!, $overwrite: Boolean!) {
  writeTextFile(path: $path, content: $content, overwrite: $overwrite) {
    name path size updatedAt
  }
}
mutation

deleteFiles

Exclua um ou mais arquivos ou diretórios pelo caminho exato.

bash
mutation DeleteFiles($paths: [String!]!) {
  deleteFiles(paths: $paths)
}
mutation

copyFile

Copie um arquivo ou diretório para um caminho de destino. Defina overwrite para substituir um arquivo existente.

bash
mutation CopyFile($src: String!, $dst: String!, $overwrite: Boolean!) {
  copyFile(src: $src, dst: $dst, overwrite: $overwrite)
}
mutation

moveFile

Mova um arquivo ou diretório para um caminho de destino. Defina overwrite para substituir um arquivo existente.

bash
mutation MoveFile($src: String!, $dst: String!, $overwrite: Boolean!) {
  moveFile(src: $src, dst: $dst, overwrite: $overwrite)
}
mutation

addFavoriteFolder

Marque uma pasta como favorita para acesso rápido. Retorna a lista atualizada de todas as pastas favoritas.

bash
mutation AddFavoriteFolder($rootPath: String!, $fullPath: String!) {
  addFavoriteFolder(rootPath: $rootPath, fullPath: $fullPath) {
    rootPath fullPath alias
  }
}
mutation

removeFavoriteFolder

Remova uma pasta favorita. Retorna a lista atualizada das pastas restantes.

bash
mutation RemoveFavoriteFolder($fullPath: String!) {
  removeFavoriteFolder(fullPath: $fullPath) {
    rootPath fullPath alias
  }
}
mutation

setFavoriteFolderAlias

Defina ou atualize o alias mostrado para uma pasta favorita. Passe uma string vazia para limpar o alias.

bash
mutation SetFavoriteFolderAlias($fullPath: String!, $alias: String!) {
  setFavoriteFolderAlias(fullPath: $fullPath, alias: $alias) {
    rootPath fullPath alias
  }
}
mutation

deleteChunks

Exclua todos os chunks armazenados para um fileId de upload em partes. Use após um upload cancelado ou com falha para liberar espaço em disco.

bash
mutation DeleteChunks($fileId: String!) {
  deleteChunks(fileId: $fileId)
}
mutation

mergeChunks

Junte os chunks enviados anteriormente no arquivo final. Passe isAppFile=true para importar o resultado para o AppFile store content-addressable do PlainApp (usado por anexos de chat).

bash
mutation MergeChunks($fileId: String!, $totalChunks: Int!, $path: String!, $replace: Boolean!, $isAppFile: Boolean!) {
  mergeChunks(fileId: $fileId, totalChunks: $totalChunks, path: $path, replace: $replace, isAppFile: $isAppFile)
}