Skip to content

Latest commit

 

History

History
129 lines (91 loc) · 5.8 KB

rss_feeds_service.md

File metadata and controls

129 lines (91 loc) · 5.8 KB
Raw

RssFeedsService

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

Methods Description
AddRssFeed ### Overview ### Authorization Requires an API key using the Authorization Bearer Header.
ControlRssFeed ### Overview Controls an RSS Feed. By sending the RSS feed's ID and the type of operation you want to perform, it will perform said action on the RSS feed checker. Operations are either: - Update forces an update on the rss feed - Delete deletes the rss feed from your account permanently - Pause pauses checking the rss feed on the scan interval - Resume resumes a paused rss feed ### Authorization Requires an API key using the Authorization Bearer Header.
ModifyRssFeed ### Overview ### Authorization Requires an API key using the Authorization Bearer Header.

AddRssFeed

Overview ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/rss/addrss

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.RssFeeds.AddRssFeed(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)

ControlRssFeed

Overview Controls an RSS Feed. By sending the RSS feed's ID and the type of operation you want to perform, it will perform said action on the RSS feed checker. Operations are either: - Update forces an update on the rss feed - Delete deletes the rss feed from your account permanently - Pause pauses checking the rss feed on the scan interval - Resume resumes a paused rss feed ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/rss/controlrss

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.RssFeeds.ControlRssFeed(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)

ModifyRssFeed

Overview ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/rss/modifyrss

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.RssFeeds.ModifyRssFeed(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)