plexjs/docs/sdk/models/operations/getlibraryitemsrequest.md

GetLibraryItemsRequest

Example Usage

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

let value: GetLibraryItemsRequest = {
    sectionKey: 9518,
    tag: Tag.Unwatched,
    includeGuids: IncludeGuids.One,
    includeMeta: IncludeMeta.One,
    type: Type.Two,
    xPlexContainerStart: 0,
    xPlexContainerSize: 50,
};

Fields

Field	Type	Required	Description	Example
sectionKey	number	✔️	The unique key of the Plex library. Note: This is unique in the context of the Plex server.	9518
tag	operations.Tag	✔️	A key representing a specific tag within the section.
includeGuids	operations.IncludeGuids	➖	Adds the Guids object to the response	1
includeMeta	operations.IncludeMeta	➖	Adds the Meta object to the response	1
type	operations.Type	✔️	The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2
xPlexContainerStart	number	➖	The index of the first item to return. If not specified, the first item will be returned. If the number of items exceeds the limit, the response will be paginated. By default this is 0	0
xPlexContainerSize	number	➖	The number of items to return. If not specified, all items will be returned. If the number of items exceeds the limit, the response will be paginated. By default this is 50	50