PlainApp
API குறிப்பு

பதிவிறக்கங்கள்

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், ID-கள், உள்ளீடுகள் மற்றும் வடிப்பான்களை மாற்றவும்.

வகை வரையறைகள்

graphql
type Subscription {
  downloadsChanged: Boolean!
}

type Mutation {
  cancelDownload(id: ID!): Boolean!
  createDownload(input: DownloadInput!): Download!
  pauseDownload(id: ID!): Boolean!
  removeDownload(id: ID!): Boolean!
  resumeDownload(id: ID!): Boolean!
  retryDownload(id: ID!): Boolean!
}

type Query {
  downloads: [Download!]!
}

input ChatDownloadInput {
	messageId: ID!
	peerId: ID!
	fileIds: [String!]!
}

type ChatDownloadSource {
	messageId: ID!
	peerId: ID!
	fileIds: [String!]!
}

type Download {
	id: ID!
	title: String!
	source: DownloadSource!
	targetDir: String!
	zipName: String
	status: DownloadStatus!
	downloadedBytes: Long!
	totalBytes: Long!
	bytesPerSecond: Long!
	totalFiles: Int!
	doneFiles: Int!
	currentFile: String!
	error: String!
	failures: [DownloadFailure!]!
}

type DownloadFailure {
	path: String!
	error: String!
}

input DownloadInput @oneOf {
	resources: ResourceDownloadInput
	chat: ChatDownloadInput
}

union DownloadSource = ResourceDownloadSource | ChatDownloadSource

enum DownloadStatus {
	PENDING
	DOWNLOADING
	PAUSED
	PACKING
	COMPLETED
	PARTIAL
	FAILED
	CANCELED
}

scalar Long

input ResourceDownloadInput {
	urls: [String!]!
	targetDir: String!
	zipName: String
}

type ResourceDownloadSource {
	urls: [String!]!
}

செயல்பாடுகள்

subscription

downloadsChanged

பதிவிறக்க முன்னேற்றம் மாறும்போது மாற்றச் சைகையைப் பெறவும்.

graphql
subscription downloadsChanged {
  downloadsChanged
}
mutation

cancelDownload

பதிவையும் சேமித்த கோப்புகளையும் வைத்துக்கொண்டு பதிவிறக்கத்தை நிறுத்தவும்.

graphql
mutation cancelDownload($id: ID!) {
  cancelDownload(id: $id)
}
mutation

createDownload

வள URL அல்லது அரட்டை இணைப்புகளில் இருந்து பதிவிறக்கத்தை உருவாக்கவும்; ஒரே ஒரு மூலத்தை வழங்கவும்.

graphql
mutation createDownload($input: DownloadInput!) {
  createDownload(input: $input) { id title targetDir zipName status downloadedBytes totalBytes bytesPerSecond }
}
mutation

pauseDownload

குறிப்பிட்ட பதிவிறக்கத்தை இடைநிறுத்தி முடிந்த கோப்புகளை வைத்திருக்கவும்.

graphql
mutation pauseDownload($id: ID!) {
  pauseDownload(id: $id)
}
mutation

removeDownload

பதிவிறக்கத்தை நிறுத்தி பணிப் பதிவை நீக்கவும்; சேமித்த கோப்புகளை வைத்திருக்கவும்.

graphql
mutation removeDownload($id: ID!) {
  removeDownload(id: $id)
}
mutation

resumeDownload

ஏற்கெனவே இடைநிறுத்தப்பட்ட பதிவிறக்கத்தைத் தொடரவும்.

graphql
mutation resumeDownload($id: ID!) {
  resumeDownload(id: $id)
}
mutation

retryDownload

தோல்வியுற்ற, பகுதி முடிந்த அல்லது ரத்தான பதிவிறக்கத்தை மீண்டும் முயற்சிக்கவும்.

graphql
mutation retryDownload($id: ID!) {
  retryDownload(id: $id)
}
query

downloads

பதிவிறக்கப் பணிகளையும் தற்போதைய முன்னேற்றம், முடிவுகள், பிழைகளையும் பட்டியலிடவும்.

graphql
query downloads {
  downloads { id title targetDir zipName status downloadedBytes totalBytes bytesPerSecond }
}