Transferências
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
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!]!
}Operações
downloadsChanged
Receber um sinal quando o progresso das transferências mudar.
subscription downloadsChanged {
downloadsChanged
}cancelDownload
Parar um download e manter seu registro e os arquivos salvos.
mutation cancelDownload($id: ID!) {
cancelDownload(id: $id)
}createDownload
Criar um download por URLs de recursos ou anexos do chat; fornecer exatamente uma origem.
mutation createDownload($input: DownloadInput!) {
createDownload(input: $input) { id title targetDir zipName status downloadedBytes totalBytes bytesPerSecond }
}pauseDownload
Pausar a tarefa indicada e preservar os arquivos concluídos.
mutation pauseDownload($id: ID!) {
pauseDownload(id: $id)
}removeDownload
Parar um download e remover seu registro; manter os arquivos salvos.
mutation removeDownload($id: ID!) {
removeDownload(id: $id)
}resumeDownload
Retomar uma tarefa de download existente em pausa.
mutation resumeDownload($id: ID!) {
resumeDownload(id: $id)
}retryDownload
Tentar novamente uma tarefa existente com falha, parcial ou cancelada.
mutation retryDownload($id: ID!) {
retryDownload(id: $id)
}downloads
Listar downloads com progresso, resultados e falhas atuais.
query downloads {
downloads { id title targetDir zipName status downloadedBytes totalBytes bytesPerSecond }
}