plexjs/docs/models/operations/getmetadataitemrequest.md

GetMetadataItemRequest

Example Usage

import { GetMetadataItemRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt } from "@lukehagar/plexjs/models/shared";

let value: GetMetadataItemRequest = {
  ids: [],
  asyncCheckFiles: BoolInt.True,
  asyncRefreshLocalMediaAgent: BoolInt.True,
  asyncRefreshAnalysis: BoolInt.True,
  checkFiles: BoolInt.True,
  skipRefresh: BoolInt.True,
  checkFileAvailability: BoolInt.True,
  asyncAugmentMetadata: BoolInt.True,
  augmentCount: 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
ids	string[]	✔️	N/A
asyncCheckFiles	shared.BoolInt	➖	Determines if file check should be performed asynchronously. An activity is created to indicate progress. Default is false.	1
asyncRefreshLocalMediaAgent	shared.BoolInt	➖	Determines if local media agent refresh should be performed asynchronously. An activity is created to indicate progress. Default is false.	1
asyncRefreshAnalysis	shared.BoolInt	➖	Determines if analysis refresh should be performed asynchronously. An activity is created to indicate progress. Default is false.	1
checkFiles	shared.BoolInt	➖	Determines if file check should be performed synchronously. Specifying asyncCheckFiles will cause this option to be ignored. Default is false.	1
skipRefresh	shared.BoolInt	➖	Determines if synchronous local media agent and analysis refresh should be skipped. Specifying async versions will cause synchronous versions to be skipped. Default is false.	1
checkFileAvailability	shared.BoolInt	➖	Determines if file existence check should be performed synchronously. Specifying checkFiles will imply this option. Default is false.	1
asyncAugmentMetadata	shared.BoolInt	➖	Add metadata augmentations. An activity is created to indicate progress. Option will be ignored if specified by non-admin or if multiple metadata items are requested. Default is false.	1
augmentCount	shared.BoolInt	➖	Number of augmentations to add. Requires asyncAugmentMetadata to be specified.	1