plexjs/docs/models/operations/getlibrarymatchesrequest.md

GetLibraryMatchesRequest

Example Usage

import { GetLibraryMatchesRequest } from "@lukehagar/plexjs/models/operations";
import { BoolInt, MediaType } from "@lukehagar/plexjs/models/shared";

let value: GetLibraryMatchesRequest = {
  type: MediaType.TvShow,
  includeFullMetadata: BoolInt.True,
  includeAncestorMetadata: BoolInt.True,
  includeAlternateMetadataSources: 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
type	shared.MediaType	➖	The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode 5 = artist 6 = album 7 = track 8 = photo_album 9 = photo E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2
includeFullMetadata	shared.BoolInt	➖	N/A	1
includeAncestorMetadata	shared.BoolInt	➖	N/A	1
includeAlternateMetadataSources	shared.BoolInt	➖	N/A	1
guid	string	➖	Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined.
title	string	➖	The title to filter by or assign
year	number	➖	Used for movies shows, and albums. Optional.
path	string	➖	Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item.
grandparentTitle	string	➖	Used for episodes and tracks. The title of the show/artist. Required if path isn't passed.
grandparentYear	number	➖	Used for episodes. The year of the show.
parentIndex	number	➖	Used for episodes and tracks. The season/album number.
index	number	➖	Used for episodes and tracks. The episode/tracks number in the season/album.
originallyAvailableAt	string	➖	Used for episodes. In the format YYYY-MM-DD.
parentTitle	string	➖	Used for albums and tracks. The artist name for albums or the album name for tracks.