mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 04:20:46 +00:00
137 lines
4.1 KiB
Markdown
137 lines
4.1 KiB
Markdown
# PlexAPI
|
|
|
|
|
|
<!-- Start SDK Example Usage [usage] -->
|
|
## SDK Example Usage
|
|
|
|
### Example
|
|
|
|
```csharp
|
|
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
|
|
```
|
|
<!-- End SDK Example Usage [usage] -->
|
|
|
|
<!-- Start Error Handling [errors] -->
|
|
## 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
|
|
|
|
```csharp
|
|
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
|
|
}
|
|
}
|
|
```
|
|
<!-- End Error Handling [errors] -->
|
|
|
|
<!-- Start Server Selection [server] -->
|
|
## 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:
|
|
```csharp
|
|
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
|
|
```
|
|
<!-- End Server Selection [server] -->
|
|
|
|
<!-- Start Authentication [security] -->
|
|
## 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:
|
|
```csharp
|
|
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
|
|
```
|
|
<!-- End Authentication [security] -->
|
|
|
|
<!-- Placeholder for Future Speakeasy SDK Sections --> |