mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
24 lines
4.7 KiB
Markdown
24 lines
4.7 KiB
Markdown
# AddDownloadQueueItemsMediaContainer
|
|
|
|
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
|
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
|
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
|
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { AddDownloadQueueItemsMediaContainer } from "@lukehagar/plexjs/models/operations";
|
|
|
|
let value: AddDownloadQueueItemsMediaContainer = {};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `identifier` | *string* | :heavy_minus_sign: | N/A |
|
|
| `offset` | *number* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> |
|
|
| `size` | *number* | :heavy_minus_sign: | N/A |
|
|
| `totalSize` | *number* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> |
|
|
| `addedQueueItems` | [operations.AddedQueueItem](../../models/operations/addedqueueitem.md)[] | :heavy_minus_sign: | N/A | |