Skip to content

Latest commit

 

History

History
254 lines (178 loc) · 20 KB

README.md

File metadata and controls

254 lines (178 loc) · 20 KB

Hubs

(hubs)

Overview

Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.

Available Operations

getGlobalHubs

Get Global Hubs filtered by the parameters provided.

Example Usage

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

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

async function run() {
  const result = await plexAPI.hubs.getGlobalHubs();

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

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { hubsGetGlobalHubs } from "@lukehagar/plexjs/funcs/hubsGetGlobalHubs.js";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accessToken: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await hubsGetGlobalHubs(plexAPI);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
count number ➖ The number of items to return with each hub.
onlyTransient operations.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.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.GetGlobalHubsResponse>

Errors

Error Type Status Code Content Type
errors.GetGlobalHubsBadRequest 400 application/json
errors.GetGlobalHubsUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*

getRecentlyAdded

This endpoint will return the recently added content.

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";
import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";

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

async function run() {
  const result = await plexAPI.hubs.getRecentlyAdded({
    contentDirectoryID: 470161,
    sectionID: 2,
    type: Type.TvShow,
    includeMeta: IncludeMeta.Enable,
    xPlexContainerStart: 0,
    xPlexContainerSize: 50,
  });

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

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { hubsGetRecentlyAdded } from "@lukehagar/plexjs/funcs/hubsGetRecentlyAdded.js";
import { IncludeMeta, Type } from "@lukehagar/plexjs/sdk/models/operations";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accessToken: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await hubsGetRecentlyAdded(plexAPI, {
    contentDirectoryID: 470161,
    sectionID: 2,
    type: Type.TvShow,
    includeMeta: IncludeMeta.Enable,
    xPlexContainerStart: 0,
    xPlexContainerSize: 50,
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.GetRecentlyAddedRequest ✔️ The request object to use for the request.
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.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.GetRecentlyAddedResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

getLibraryHubs

This endpoint will return a list of library specific hubs

Example Usage

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

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

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

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

run();

Standalone function

The standalone function version of this method:

import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { hubsGetLibraryHubs } from "@lukehagar/plexjs/funcs/hubsGetLibraryHubs.js";

// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({
  accessToken: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await hubsGetLibraryHubs(plexAPI, 6728.76);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // 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 operations.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.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.GetLibraryHubsResponse>

Errors

Error Type Status Code Content Type
errors.GetLibraryHubsBadRequest 400 application/json
errors.GetLibraryHubsUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*