Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 4.54 KB

queued_service.md

File metadata and controls

96 lines (65 loc) · 4.54 KB

QueuedService

A list of all methods in the QueuedService service. Click on the method name to view detailed information about that method.

Methods Description
GetQueuedDownloads ### Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header.
ControlQueuedDownloads ### Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued download from your account - Start starts a queued download, cannot be used with the "all" parameter ### Authorization Requires an API key using the Authorization Bearer Header.

GetQueuedDownloads

Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/queued/getqueued

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params GetQueuedDownloadsRequestParams ✅ Additional request parameters

Return Type

any

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"

  "torbox-sdk-go/pkg/queued"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := queued.GetQueuedDownloadsRequestParams{

}

response, err := client.Queued.GetQueuedDownloads(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Println(response)

ControlQueuedDownloads

Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued download from your account - Start starts a queued download, cannot be used with the "all" parameter ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/queued/controlqueued

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
body []byte ✅

Return Type

any

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"

)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.Queued.ControlQueuedDownloads(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Println(response)