mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 12:37:46 +00:00
6.7 KiB
6.7 KiB
Hubs
(Hubs)
Overview
Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
Available Operations
- GetGlobalHubs - Get Global Hubs
- GetLibraryHubs - Get library specific hubs
GetGlobalHubs
Get Global Hubs filtered by the parameters provided.
Example Usage
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(
security: new Models.Components.Security() {
AccessToken = "<YOUR_API_KEY_HERE>",
});
var res = await sdk.Hubs.GetGlobalHubsAsync(Count: 1262.49D, OnlyTransient: OnlyTransient.One);
// handle response
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
Count |
double | ➖ | The number of items to return with each hub. |
OnlyTransient |
OnlyTransient | ➖ | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |
Response
GetLibraryHubs
This endpoint will return a list of library specific hubs
Example Usage
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(
security: new Models.Components.Security() {
AccessToken = "<YOUR_API_KEY_HERE>",
});
var res = await sdk.Hubs.GetLibraryHubsAsync(SectionId: 6728.76D, Count: 9010.22D, OnlyTransient: QueryParamOnlyTransient.Zero);
// handle response
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
SectionId |
double | ✔️ | the Id of the library to query |
Count |
double | ➖ | The number of items to return with each hub. |
OnlyTransient |
QueryParamOnlyTransient | ➖ | Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). |