mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
39 lines
11 KiB
Markdown
39 lines
11 KiB
Markdown
# GetLibrarySectionsAllRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import {
|
|
GetLibrarySectionsAllQueryParamIncludeMeta,
|
|
GetLibrarySectionsAllQueryParamType,
|
|
GetLibrarySectionsAllRequest,
|
|
IncludeAdvanced,
|
|
QueryParamIncludeCollections,
|
|
QueryParamIncludeExternalMedia,
|
|
QueryParamIncludeGuids,
|
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: GetLibrarySectionsAllRequest = {
|
|
sectionKey: 9518,
|
|
type: GetLibrarySectionsAllQueryParamType.TvShow,
|
|
includeMeta: GetLibrarySectionsAllQueryParamIncludeMeta.Enable,
|
|
includeGuids: QueryParamIncludeGuids.Enable,
|
|
includeAdvanced: IncludeAdvanced.Enable,
|
|
includeCollections: QueryParamIncludeCollections.Enable,
|
|
includeExternalMedia: QueryParamIncludeExternalMedia.Enable,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
|
| `type` | [operations.GetLibrarySectionsAllQueryParamType](../../../sdk/models/operations/getlibrarysectionsallqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
|
| `includeMeta` | [operations.GetLibrarySectionsAllQueryParamIncludeMeta](../../../sdk/models/operations/getlibrarysectionsallqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
|
| `includeGuids` | [operations.QueryParamIncludeGuids](../../../sdk/models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
|
| `includeAdvanced` | [operations.IncludeAdvanced](../../../sdk/models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
|
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
|
|
| `includeExternalMedia` | [operations.QueryParamIncludeExternalMedia](../../../sdk/models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 1 |
|
|
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
|
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 | |