LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
61492e5dadb409b790c999e7145a98e64d0e13e5
plexcsharp/docs/sdks/watchlist/README.md

3.0 KiB
Raw Blame History

Watchlist

(Watchlist)

Overview

API Calls that perform operations with Plex Media Server Watchlists

Available Operations

GetWatchList

Get User Watchlist

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

GetWatchListRequest req = new GetWatchListRequest() {
    Filter = LukeHagar.PlexAPI.SDK.Models.Requests.Filter.Available,
    XPlexToken = "CV5xoxjTpFKUzBTShsaf",
    XPlexContainerStart = 0,
    XPlexContainerSize = 50,
};

var res = await sdk.Watchlist.GetWatchListAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetWatchListRequest ✔️ The request object to use for the request.
serverURL string ➖ An optional server URL to use.

Response

GetWatchListResponse

Errors

Error Type Status Code Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetWatchListBadRequest 400 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetWatchListUnauthorized 401 application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException 4XX, 5XX */*