API संदर्भ

फ़ाइलें

सुविधा समर्थन के लिए app.capabilities और प्राधिकरण के लिए app.access तथा होस्ट अनुमतियाँ जाँचें। उदाहरण कृत्रिम मान उपयोग करते हैं; कॉल करने से पहले पथ, ID, इनपुट और फ़िल्टर बदलें।

प्रकार परिभाषाएँ

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
}

ऑपरेशन

subscription

fileSearchResults

दिए गए रूट, फ़िल्टर, पृष्ठ और क्रम के फ़ाइल-खोज परिणाम स्नैपशॉट लें।

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

निर्दिष्ट ZIP प्रविष्टि कैश में निकालें और उसका पथ लौटाएँ।

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

copyFileToDirectory

दिए गए गंतव्य नाम से फ़ाइल डायरेक्टरी में कॉपी करें और उपलब्ध होने पर उसका पथ लौटाएँ।

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

createDir

नई डायरेक्टरी बनाएँ और File ऑब्जेक्ट के रूप में लौटाएँ।

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

createFile

दिए गए पथ पर खाली फ़ाइल बनाएँ और उसका मेटाडेटा लौटाएँ।

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

createFileTask

बैच कॉपी या स्थानांतरण कार्य बनाएँ; वैकल्पिक रूप से उसकी स्थिति लौटाने से पहले पूरा होने तक प्रतीक्षा करें।

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

चुने गए पथों से लक्ष्य पथ पर ZIP संग्रह बनाएँ।

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

deleteFiles

सटीक पथ से एक या अधिक फ़ाइलें या डायरेक्टरी मिटाएँ।

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

deleteTrashedFile

फ़ाइल ट्रैश से एक आइटम स्थायी रूप से मिटाएँ।

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

extractZipArchive

ZIP संग्रह लक्ष्य डायरेक्टरी में निकालें।

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

renameFile

फ़ाइल या डायरेक्टरी का नाम बदलें।

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

restoreFiles

निर्दिष्ट ट्रैश फ़ाइल पथ बहाल करें और प्रभावित संख्या बताएँ।

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

trashFiles

निर्दिष्ट फ़ाइल पथ ट्रैश में ले जाएँ और प्रभावित संख्या बताएँ।

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

writeTextFile

अनुरोधित ओवरराइट नीति से दिए गए फ़ाइल पथ पर टेक्स्ट लिखें।

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

पृष्ठ विभाजन की अनदेखी करके निर्दिष्ट रूट के नीचे फ़ाइल खोज के मिलान गिनें।

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

fileInfo

एक पथ की फ़ाइल विशेषताएँ, समर्थित मीडिया मेटाडेटा और टैग जानकारी पढ़ें।

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

fileTasks

क्वेरी से मेल खाते फ़ाइल कार्रवाई कार्यों का एक पृष्ठ पढ़ें।

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

रूट पथ के नीचे फ़ाइलें पृष्ठों में सूचीबद्ध और खोजें। सब सूचीबद्ध करने के लिए खाली query दें।

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

हाल में खोली गई फ़ाइलें सूचीबद्ध करें।

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

फ़ाइल ट्रैश के आइटम गिनें।

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

trashedFiles

ट्रैश फ़ाइलें पृष्ठ विभाजन और क्रमबद्धता के साथ खोजें।

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