plexjs/docs/sdks/hubs/README.md

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

import { OnlyTransient, PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  accessToken: "<YOUR_API_KEY_HERE>",
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.hubs.getGlobalHubs(1262.49, OnlyTransient.One);

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
count	number	➖	The number of items to return with each hub.
onlyTransient	models.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).
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.GetGlobalHubsResponse>

Errors

Error Object	Status Code	Content Type
models.GetGlobalHubsHubsResponseBody	401	application/json
models.SDKError	4xx-5xx	/

getLibraryHubs

This endpoint will return a list of library specific hubs

Example Usage

import { PlexAPI, QueryParamOnlyTransient } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  accessToken: "<YOUR_API_KEY_HERE>",
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.hubs.getLibraryHubs(6728.76, 9010.22, QueryParamOnlyTransient.Zero);

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
sectionId	number	✔️	the Id of the library to query
count	number	➖	The number of items to return with each hub.
onlyTransient	models.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).
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.GetLibraryHubsResponse>

Errors

Error Object	Status Code	Content Type
models.GetLibraryHubsHubsResponseBody	401	application/json
models.SDKError	4xx-5xx	/