LukeHagar.PlexAPI.SDK
0.3.0
See the version list below for details.
dotnet add package LukeHagar.PlexAPI.SDK --version 0.3.0
NuGet\Install-Package LukeHagar.PlexAPI.SDK -Version 0.3.0
<PackageReference Include="LukeHagar.PlexAPI.SDK" Version="0.3.0" />
paket add LukeHagar.PlexAPI.SDK --version 0.3.0
#r "nuget: LukeHagar.PlexAPI.SDK, 0.3.0"
// Install LukeHagar.PlexAPI.SDK as a Cake Addin #addin nuget:?package=LukeHagar.PlexAPI.SDK&version=0.3.0 // Install LukeHagar.PlexAPI.SDK as a Cake Tool #tool nuget:?package=LukeHagar.PlexAPI.SDK&version=0.3.0
PlexAPI
SDK Example Usage
Example
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
Error Object | Status Code | Content Type |
---|---|---|
PlexAPI.Models.Errors.GetServerCapabilitiesResponseBody | 401 | application/json |
PlexAPI.Models.Errors.SDKException | 4xx-5xx | / |
Example
using PlexAPI;
using PlexAPI.Models.Components;
using System;
using PlexAPI.Models.Errors;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
);
try
{
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
}
catch (Exception ex)
{
if (ex is Models.Errors.GetServerCapabilitiesResponseBody)
{
// handle exception
}
else if (ex is PlexAPI.Models.Errors.SDKException)
{
// handle exception
}
}
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIndex: number
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | {protocol}://{ip}:{port} |
protocol (default is http ), ip (default is 10.10.10.47 ), port (default is 32400 ) |
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
protocol: ServerProtocol
ip: string
port: string
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverUrl: str
optional parameter when initializing the SDK client instance. For example:
Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2");
// handle response
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
AccessToken |
apiKey | API key |
To authenticate with the API the AccessToken
parameter must be set when initializing the SDK client instance. For example:
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- newtonsoft.json (>= 13.0.3)
- nodatime (>= 3.1.9)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.11.1 | 76 | 11/14/2024 |
0.11.0 | 95 | 11/12/2024 |
0.10.0 | 469 | 10/3/2024 |
0.9.2 | 96 | 10/2/2024 |
0.9.1 | 94 | 10/2/2024 |
0.9.0 | 89 | 10/2/2024 |
0.8.7 | 91 | 9/30/2024 |
0.8.6 | 81 | 9/30/2024 |
0.8.5 | 100 | 9/30/2024 |
0.8.1 | 119 | 9/26/2024 |
0.8.0 | 95 | 9/25/2024 |
0.7.1 | 103 | 9/21/2024 |
0.7.0 | 98 | 9/21/2024 |
0.6.11 | 96 | 9/19/2024 |
0.6.10 | 106 | 9/16/2024 |
0.5.3 | 127 | 9/8/2024 |
0.4.2 | 118 | 8/31/2024 |
0.3.0 | 98 | 8/31/2024 |