mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
34 lines
22 KiB
Markdown
34 lines
22 KiB
Markdown
# CreateCollectionRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { CreateCollectionRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { MediaType } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: CreateCollectionRequest = {
|
|
sectionId: "<id>",
|
|
type: MediaType.TvShow,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
|
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
|
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
|
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
|
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
|
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
|
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
|
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
|
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
|
| `sectionId` | *string* | :heavy_check_mark: | The section where this collection will be created | |
|
|
| `title` | *string* | :heavy_minus_sign: | The title to filter by or assign | |
|
|
| `smart` | *boolean* | :heavy_minus_sign: | Whether this is a smart collection/playlist | |
|
|
| `uri` | *string* | :heavy_minus_sign: | The URI for processing the smart collection. Required for a smart collection | |
|
|
| `type` | [shared.MediaType](../../models/shared/mediatype.md) | :heavy_minus_sign: | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 | |