Files
plexjs/docs/models/operations/updateitemsrequest.md

18 KiB
Raw Blame History

UpdateItemsRequest

Example Usage

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 Indicates the client accepts the indicated media types
clientIdentifier string An opaque identifier unique to the client abc123
product string The name of the client product Plex for Roku
version string The version of the client application 2.4.1
platform string The platform of the client Roku
platformVersion string The version of the platform 4.3 build 1057
device string A relatively friendly name for the client device Roku 3
model string A potentially less friendly identifier for the device model 4200X
deviceVendor string The device vendor Roku
deviceName string A friendly name for the client Living Room TV
marketplace string The marketplace on which the client application is distributed googlePlay
sectionId string ✔️ The id of the section
type string N/A
filters string The filters to apply to determine which items should be modified
fieldValue string Set the specified field to a new value
fieldLocked shared.BoolInt Set the specified field to locked (or unlocked if set to 0) 1
titleValue string This field is treated specially by albums or artists and may be used for implicit reparenting.
artistTitleValue string Reparents set of Tracks or Albums - used with album.title.* in the case of tracks
artistTitleId string Reparents set of Tracks or Albums - used with album.title.* in the case of tracks
albumTitleValue string Reparents set of Tracks - Must be used in conjunction with artist.title.value or id
albumTitleId string Reparents set of Tracks - Must be used in conjunction with artist.title.value or id
tagtypeIdxTagTag string Creates tag and associates it with each item in the set. - [idx] links this and the next parameters together
tagtypeIdxTaggingObject string Here object may be text/thumb/art/theme - Optionally used in conjunction with tag.tag, to update association info across the set.
tagtypeTagTag string Remove comma separated tags from the set of items
tagtypeTag string Remove associations of this type (e.g. genre) from the set of items