mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
43 lines
18 KiB
Markdown
43 lines
18 KiB
Markdown
# UpdateItemsRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { UpdateItemsRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: UpdateItemsRequest = {
|
|
sectionId: "<id>",
|
|
fieldLocked: 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 |
|
|
| `sectionId` | *string* | :heavy_check_mark: | The id of the section | |
|
|
| `type` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `filters` | *string* | :heavy_minus_sign: | The filters to apply to determine which items should be modified | |
|
|
| `fieldValue` | *string* | :heavy_minus_sign: | Set the specified field to a new value | |
|
|
| `fieldLocked` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Set the specified field to locked (or unlocked if set to 0) | 1 |
|
|
| `titleValue` | *string* | :heavy_minus_sign: | This field is treated specially by albums or artists and may be used for implicit reparenting. | |
|
|
| `artistTitleValue` | *string* | :heavy_minus_sign: | Reparents set of Tracks or Albums - used with album.title.* in the case of tracks | |
|
|
| `artistTitleId` | *string* | :heavy_minus_sign: | Reparents set of Tracks or Albums - used with album.title.* in the case of tracks | |
|
|
| `albumTitleValue` | *string* | :heavy_minus_sign: | Reparents set of Tracks - Must be used in conjunction with artist.title.value or id | |
|
|
| `albumTitleId` | *string* | :heavy_minus_sign: | Reparents set of Tracks - Must be used in conjunction with artist.title.value or id | |
|
|
| `tagtypeIdxTagTag` | *string* | :heavy_minus_sign: | Creates tag and associates it with each item in the set. - [idx] links this and the next parameters together | |
|
|
| `tagtypeIdxTaggingObject` | *string* | :heavy_minus_sign: | Here `object` may be text/thumb/art/theme - Optionally used in conjunction with tag.tag, to update association info across the set. | |
|
|
| `tagtypeTagTag` | *string* | :heavy_minus_sign: | Remove comma separated tags from the set of items | |
|
|
| `tagtypeTag` | *string* | :heavy_minus_sign: | Remove associations of this type (e.g. genre) from the set of items | | |