PlainApp
Référence de l'API

Fichiers

Parcourez et gérez les fichiers et répertoires. Prend en charge le stockage multi-montage (interne, carte SD, USB).

Définitions de types

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
}

Opérations

query

mounts

Liste tous les volumes de stockage disponibles (interne, carte SD, USB).

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

recentFiles

Liste les fichiers récemment modifiés sur tous les stockages. Source de la vue « Récents » dans l'interface Fichiers.

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

files

Liste et recherche des fichiers sous un chemin racine avec pagination. Passez une requête vide pour tout lister.

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

Récupère stat + métadonnées média + étiquettes pour un fichier unique. Passez fileName pour que le serveur détecte image/vidéo/audio et charge largeur, hauteur, durée, 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

Résout une liste de chemins du système de fichiers en leurs IDs du magasin média (chaîne vide si non indexé).

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

uploadedChunks

Liste les index de chunks déjà reçus pour un upload chunked reprendable. Utilisé pour reprendre des uploads interrompus.

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

createDir

Crée un nouveau répertoire et le renvoie sous forme d'objet File.

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

renameFile

Renomme un fichier ou un répertoire.

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

writeTextFile

Écrit du contenu texte dans un fichier. Définissez overwrite=false pour ajouter un suffixe « (1) » lorsque le fichier existe déjà.

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

deleteFiles

Supprime un ou plusieurs fichiers ou répertoires par chemin exact.

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

copyFile

Copie un fichier ou un répertoire vers un chemin de destination. Définissez overwrite pour remplacer un fichier existant.

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

moveFile

Déplace un fichier ou un répertoire vers un chemin de destination. Définissez overwrite pour remplacer un fichier existant.

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

addFavoriteFolder

Marque un dossier pour un accès rapide. Renvoie la liste mise à jour de tous les dossiers marqués.

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

removeFavoriteFolder

Retire un dossier marqué. Renvoie la liste mise à jour des dossiers restants.

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

setFavoriteFolderAlias

Définit ou met à jour l'alias affiché pour un dossier marqué. Passez une chaîne vide pour effacer l'alias.

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

deleteChunks

Supprime tous les chunks stockés pour un fileId d'upload chunked. À utiliser après un upload annulé ou échoué pour libérer de l'espace disque.

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

mergeChunks

Fusionne les chunks précédemment uploadés dans le fichier final. Passez isAppFile=true pour importer le résultat dans le magasin AppFile à adressage par contenu de PlainApp (utilisé par les pièces jointes 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)
}