Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.6 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.6 KB
Raw

Watchlist

(watchlist)

Overview

API Calls that perform operations with Plex Media Server Watchlists

Available Operations

get_watch_list

Get User Watchlist

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
      client_name: "Plex for Roku",
      client_version: "2.4.1",
      platform: "Roku",
      device_nickname: "Roku 3",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)


req = ::PlexRubySDK::Operations::GetWatchListRequest.new(
  filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,
  x_plex_container_start: 0,
  x_plex_container_size: 50,
  x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
    
res = s.watchlist.get_watch_list(req)

if ! res.object.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::PlexRubySDK::Operations::GetWatchListRequest ✔️ The request object to use for the request.
server_url String ➖ An optional server URL to use.

Response

T.nilable(::PlexRubySDK::Operations::GetWatchListResponse)