mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
48 lines
8.9 KiB
Markdown
48 lines
8.9 KiB
Markdown
# AddSectionRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { AddSectionRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: AddSectionRequest = {
|
|
name: "<value>",
|
|
type: 583726,
|
|
agent: "<value>",
|
|
language: "<value>",
|
|
locations: [
|
|
"O:\fatboy\\Media\\Ripped\\Music",
|
|
"O:\fatboy\\Media\\My Music",
|
|
],
|
|
prefs: {},
|
|
relative: BoolInt.True,
|
|
importFromiTunes: BoolInt.True,
|
|
};
|
|
```
|
|
|
|
## 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 |
|
|
| `name` | *string* | :heavy_check_mark: | The name of the new section | |
|
|
| `type` | *number* | :heavy_check_mark: | The type of library section | |
|
|
| `scanner` | *string* | :heavy_minus_sign: | The scanner this section should use | |
|
|
| `agent` | *string* | :heavy_check_mark: | The agent this section should use for metadata | |
|
|
| `metadataAgentProviderGroupId` | *string* | :heavy_minus_sign: | The agent group id for this section | |
|
|
| `language` | *string* | :heavy_check_mark: | The language of this section | |
|
|
| `locations` | *string*[] | :heavy_minus_sign: | The locations on disk to add to this section | [<br/>"O:\\fatboy\\Media\\Ripped\\Music",<br/>"O:\\fatboy\\Media\\My Music"<br/>] |
|
|
| `prefs` | [operations.AddSectionPrefs](../../models/operations/addsectionprefs.md) | :heavy_minus_sign: | The preferences for this section | {<br/>"collectionMode": 2,<br/>"hidden": 0<br/>} |
|
|
| `relative` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, paths are relative to `Media Upload` path | 1 |
|
|
| `importFromiTunes` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If set, import media from iTunes. | 1 | |