Class Collections<CollectionVideoType>

Type Parameters

CollectionVideoType extends RatingKeyItem = SectionType

Hierarchy

PartialPlexObject
- Collections

Index

Constructors

constructor

Accessors

artwork isAudio isFullObject isPhoto isVideo listType metadataDirectory metadataType size

Constructors

constructor

new Collections<CollectionVideoType extends RatingKeyItem = SectionType>(
    server: PlexServer,
    data: CollectionData,
    initpath?: string,
    parent?: PlexObject,
    itemClass?: CollectionItemClass<CollectionVideoType>,
): Collections<CollectionVideoType>
Type Parameters
- CollectionVideoType extends RatingKeyItem = SectionType
Parameters
- server: PlexServer
- data: CollectionData
- Optionalinitpath: string
- Optionalparent: PlexObject
- OptionalitemClass: CollectionItemClass<CollectionVideoType>
Returns Collections<CollectionVideoType>
Overrides PartialPlexObject.constructor
- Defined in src/library.ts:3507

Properties

_INCLUDES

_INCLUDES: {
    checkFiles: number;
    includeAllConcerts: number;
    includeBandwidths: number;
    includeChapters: number;
    includeChildren: number;
    includeConcerts: number;
    includeExternalMedia: number;
    includeExtras: number;
    includeFields: string;
    includeGeolocation: number;
    includeLoudnessRamps: number;
    includeMarkers: number;
    includeOnDeck: number;
    includePopularLeaves: number;
    includePreferences: number;
    includeRelated: number;
    includeRelatedCount: number;
    includeReviews: number;
    includeStations: number;
} = ...

addedAt

addedAt: Date

`Optional`art

art?: string

childCount

childCount: number

collectionMode

collectionMode: number

Collection display mode (-1 library default, 0 hide, 1 hide items, 2 show items).

collectionSort

collectionSort: number

Collection sort (0 release date, 1 alphabetical, 2 custom).

`Optional`content

content?: string

Smart collection content URI.

contentRating

contentRating: string

fields

fields: Field[]

guid

guid: string

images

images: Image[]

index

index: number

key

key: string

Plex relative url of this metadata item.

labels

labels: Label[]

`Optional`librarySectionID

librarySectionID?: number

`Optional`librarySectionKey

librarySectionKey?: string

`Optional`librarySectionTitle

librarySectionTitle?: string

`Optional`maxYear

maxYear?: string

`Optional`minYear

minYear?: string

`Optional` `Readonly`parent

parent?: WeakRef<PlexObject>

WeakRef to the parent object that this object is built from.

`Optional`rating

rating?: number

`Optional`ratingCount

ratingCount?: number

Number of ratings contributing to the collection rating.

`Optional`ratingKey

ratingKey?: string

`Readonly`server

server: PlexServer

smart

smart: boolean

subtype

subtype: string

summary

summary: string

thumb

thumb: string

`Optional`title

title?: string

titleSort

titleSort: string

`Optional`type

type?: string

TYPE

TYPE: string = 'collection'

`Optional`ultraBlurColors

ultraBlurColors?: UltraBlurColorsData

updatedAt

updatedAt: Date

`Optional`userRating

userRating?: number

`Optional`year

year?: number

`Static`TAG

TAG: string = 'Directory'

xml element tag

`Static`TYPE

TYPE: string | null = null

xml element type

Accessors

artwork

get artwork(): ArtworkManager
Typed poster, background, logo, and square-art management.

Returns ArtworkManager
Inherited from PartialPlexObject.artwork
- Defined in src/base/partialPlexObject.ts:72

isAudio

get isAudio(): boolean
Returns boolean
- Defined in src/library.ts:3564

isFullObject

get isFullObject(): boolean
Retruns True if this is already a full object. A full object means all attributes were populated from the api path representing only this item. For example, the search result for a movie often only contain a portion of the attributes a full object (main url) for that movie would contain.

Returns boolean
Inherited from PartialPlexObject.isFullObject
- Defined in src/base/partialPlexObject.ts:290

isPhoto

get isPhoto(): boolean
Returns boolean
- Defined in src/library.ts:3568

isVideo

get isVideo(): boolean
Returns boolean
- Defined in src/library.ts:3560

listType

get listType(): PlaylistContentType
Returns PlaylistContentType
- Defined in src/library.ts:3572

metadataDirectory

get metadataDirectory(): string | undefined
Path relative to the Plex server data directory, using server-independent separators.

Returns string | undefined
Inherited from PartialPlexObject.metadataDirectory
- Defined in src/base/partialPlexObject.ts:106

metadataType

get metadataType(): | "playlist"
| "movie"
| "show"
| "season"
| "episode"
| "trailer"
| "comic"
| "person"
| "artist"
| "album"
| "track"
| "picture"
| "clip"
| "photo"
| "photoalbum"
| "playlistFolder"
| "collection"
| "optimizedVersion"
| "userPlaylistItem"
Returns
    | "playlist"
    | "movie"
    | "show"
    | "season"
    | "episode"
    | "trailer"
    | "comic"
    | "person"
    | "artist"
    | "album"
    | "track"
    | "picture"
    | "clip"
    | "photo"
    | "photoalbum"
    | "playlistFolder"
    | "collection"
    | "optimizedVersion"
    | "userPlaylistItem"
- Defined in src/library.ts:3556

size

get size(): number
Returns number
- Defined in src/library.ts:3547

Methods

addCollection

addCollection(collections: string[]): Promise<void>
Add a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from PartialPlexObject.addCollection
- Defined in src/base/partialPlexObject.ts:439

addGenre

addGenre(genres: string[]): Promise<void>
Add a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from PartialPlexObject.addGenre
- Defined in src/base/partialPlexObject.ts:459

addItems

addItems(items: CollectionVideoType[]): Promise<void>
Add items to the collection.
Parameters
- items: CollectionVideoType[]
  Items to add to the collection.
Returns Promise<void>
- Defined in src/library.ts:3629

addLabel

addLabel(labels: string[]): Promise<void>
Add a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from PartialPlexObject.addLabel
- Defined in src/base/partialPlexObject.ts:449

analyze

analyze(): Promise<void>
Tell Plex Media Server to performs analysis on it this item to gather information. Analysis includes:
- Gather Media Properties: All of the media you add to a Library has properties that are useful to know–whether it's a video file, a music track, or one of your photos (container, codec, resolution, etc).
- Generate Default Artwork: Artwork will automatically be grabbed from a video file. A background image will be pulled out as well as a smaller image to be used for poster/thumbnail type purposes.
- Generate Video Preview Thumbnails: Video preview thumbnails are created, if you have that feature enabled. Video preview thumbnails allow graphical seeking in some Apps. It's also used in the Plex Web App Now Playing screen to show a graphical representation of where playback is. Video preview thumbnails creation is a CPU-intensive process akin to transcoding the file.
- Generate intro video markers: Detects show intros, exposing the 'Skip Intro' button in clients.
Returns Promise<void>
Inherited from PartialPlexObject.analyze
- Defined in src/base/partialPlexObject.ts:264

createPlayQueue

createPlayQueue(options?: CreatePlayQueueOptions): Promise<PlayQueue>
Create a PlayQueue that plays every item in this collection.
Parameters
- options: CreatePlayQueueOptions = {}
Returns Promise<PlayQueue>
- Defined in src/library.ts:3532

defaultAdvanced

defaultAdvanced(): Promise<void>
Returns Promise<void>
Inherited from PartialPlexObject.defaultAdvanced
- Defined in src/base/partialPlexObject.ts:224

delete

delete(): Promise<void>
Delete a media element. This has to be enabled under settings > server > library in plex webui.

Returns Promise<void>
Overrides PartialPlexObject.delete
- Defined in src/library.ts:3586

download

download(options?: DownloadOptions): AsyncGenerator<MediaDownload, void>
Stream original media files; consume each body before advancing the iterator.
Parameters
- options: DownloadOptions = {}
Returns AsyncGenerator<MediaDownload, void>
Inherited from PartialPlexObject.download
- Defined in src/base/partialPlexObject.ts:101

edit

edit(changes: Readonly<Record<string, string | number>>): Promise<void>
Edit an object.
Parameters
- changes: Readonly<Record<string, string | number>>
Returns Promise<void>
Inherited from PartialPlexObject.edit
- Defined in src/base/partialPlexObject.ts:482

editAdvanced

editAdvanced(values: Record<string, SettingValue>): Promise<void>
Validate values against Plex's advertised preferences before submitting them.
Parameters
- values: Record<string, SettingValue>
Returns Promise<void>
Inherited from PartialPlexObject.editAdvanced
- Defined in src/base/partialPlexObject.ts:208

editContentRating

editContentRating(contentRating: string): Promise<void>
Set the content rating (e.g. PG-13, R, TV-MA).
Parameters
- contentRating: string
Returns Promise<void>
Inherited from PartialPlexObject.editContentRating
- Defined in src/base/partialPlexObject.ts:529

editFields

editFields(
fields: MetadataFieldUpdates,
options?: MetadataEditOptions,
): Promise<void>
Edit several typed metadata fields in one request.
Parameters
- fields: MetadataFieldUpdates
- options: MetadataEditOptions = {}
Returns Promise<void>
Inherited from PartialPlexObject.editFields
- Defined in src/base/partialPlexObject.ts:173

editOriginallyAvailableAt

editOriginallyAvailableAt(date: string): Promise<void>
Set the originally available at date (release date).
Parameters
- date: string
Returns Promise<void>
Inherited from PartialPlexObject.editOriginallyAvailableAt
- Defined in src/base/partialPlexObject.ts:539

editSortTitle

editSortTitle(sortTitle: string): Promise<void>
Set the sort title.
Parameters
- sortTitle: string
Returns Promise<void>
Inherited from PartialPlexObject.editSortTitle
- Defined in src/base/partialPlexObject.ts:519

editStudio

editStudio(studio: string): Promise<void>
Set the studio.
Parameters
- studio: string
Returns Promise<void>
Inherited from PartialPlexObject.editStudio
- Defined in src/base/partialPlexObject.ts:534

editSummary

editSummary(summary: string): Promise<void>
Set the summary.
Parameters
- summary: string
Returns Promise<void>
Inherited from PartialPlexObject.editSummary
- Defined in src/base/partialPlexObject.ts:524

editTags

editTags(__namedParameters: MetadataTagEditOptions): Promise<void>
Edit a server-defined tag, such as genre, collection, country, director, or mood.
Parameters
- __namedParameters: MetadataTagEditOptions
Returns Promise<void>
Inherited from PartialPlexObject.editTags
- Defined in src/base/partialPlexObject.ts:141

editTitle

editTitle(title: string): Promise<void>
Set the title.
Parameters
- title: string
Returns Promise<void>
Inherited from PartialPlexObject.editTitle
- Defined in src/base/partialPlexObject.ts:514

extras

extras(): Promise<Extra[]>
Returns Promise<Extra[]>
Inherited from PartialPlexObject.extras
- Defined in src/base/partialPlexObject.ts:89

filters

filters(): URLSearchParams | undefined
Ordered query parameters defining this smart collection or playlist.

Returns URLSearchParams | undefined
- Defined in src/library.ts:3552

filterUserUpdate

filterUserUpdate(user: "user" | "admin"): Promise<void>
Choose whose watched state is used when evaluating a smart collection.
Parameters
- user: "user" | "admin"
Returns Promise<void>
- Defined in src/library.ts:3685

fixMatch

fixMatch(
    options?: {
        agent?: string;
        auto?: boolean;
        searchResult?: SearchResult;
    },
): Promise<void>
Use match result to update show metadata.
Parameters
- options: { agent?: string; auto?: boolean; searchResult?: SearchResult } = {}
  Match options.
Returns Promise<void>
Inherited from PartialPlexObject.fixMatch
- Defined in src/base/partialPlexObject.ts:298

getWebURL

getWebURL(__namedParameters?: { base?: string }): string
Parameters
- __namedParameters: { base?: string } = {}
Returns string
Inherited from PartialPlexObject.getWebURL
- Defined in src/base/partialPlexObject.ts:468

history

history(options?: Omit<HistoryOptions, "ratingKey">): Promise<HistoryResult[]>
Get Play History for a media item.
Parameters
- options: Omit<HistoryOptions, "ratingKey"> = {}
  Filter and paging options.
Returns Promise<HistoryResult[]>
Inherited from PartialPlexObject.history
- Defined in src/base/partialPlexObject.ts:405

hubs

hubs(): Promise<Hub[]>
Returns Promise<Hub[]>
Inherited from PartialPlexObject.hubs
- Defined in src/base/partialPlexObject.ts:78

isChildOf

isChildOf(cls: new (...args: any[]) => PlexObject): boolean
Returns true if this object was built from a parent of the given class.
Parameters
- cls: new (...args: any[]) => PlexObject
Returns boolean
Inherited from PartialPlexObject.isChildOf
- Defined in src/base/plexObject.ts:61

isLocked

isLocked(name: string): boolean
Whether a loaded field is locked against metadata refreshes.
Parameters
- name: string
Returns boolean
Inherited from PartialPlexObject.isLocked
- Defined in src/base/partialPlexObject.ts:181

item

item(title: string): Promise<CollectionVideoType>
Parameters
- title: string
Returns Promise<CollectionVideoType>
- Defined in src/library.ts:3518

items

items(): Promise<CollectionVideoType[]>
Returns a list of all items in the collection.

Returns Promise<CollectionVideoType[]>
- Defined in src/library.ts:3605

matches

matches(
    options?: {
        agent?: string;
        language?: string;
        title?: string;
        year?: string;
    },
): Promise<SearchResult[]>
Parameters
- options: { agent?: string; language?: string; title?: string; year?: string } = {}
  Match options.
  
  Examples:
  
  video.matches()
  
  video.matches({ title: "something", year: "2020" })
  
  video.matches({ title: "something" })
  
  video.matches({ year: "2020" })
  
  video.matches({ title: "something", year: "" })
  
  video.matches({ title: "", year: "2020" })
  
  video.matches({ title: "", year: "" })
  
  The default behaviour in Plex Web = no params in plexapi
  
  Both title and year specified by user
  
  Year automatically filled in
  
  Title automatically filled in
  
  Explicitly searches for title with blank year
  
  Explicitly searches for blank title with year
  
  I don't know what the user is thinking... return the same result as 1
  
  For 2 to 7, the agent and language is automatically filled in
Returns Promise<SearchResult[]>
Inherited from PartialPlexObject.matches
- Defined in src/base/partialPlexObject.ts:344

merge

merge(ratingKeys: readonly (string | number)[]): Promise<void>
Parameters
- ratingKeys: readonly (string | number)[]
Returns Promise<void>
Inherited from PartialPlexObject.merge
- Defined in src/base/partialPlexObject.ts:238

modeUpdate

modeUpdate(mode: "default" | "hide" | "hideItems" | "showItems"): Promise<void>
Parameters
- mode: "default" | "hide" | "hideItems" | "showItems"
Returns Promise<void>
- Defined in src/library.ts:3692

moveItem

moveItem(item: CollectionVideoType, after?: CollectionVideoType): Promise<void>
Move an item to a new position in the collection.
Parameters
- item: CollectionVideoType
  Item to move.
- Optionalafter: CollectionVideoType
  Item to place it after. If not provided, moves to the beginning.
Returns Promise<void>
- Defined in src/library.ts:3663

preference

preference(id: string): Promise<Preferences>
Parameters
- id: string
Returns Promise<Preferences>
Inherited from PartialPlexObject.preference
- Defined in src/base/partialPlexObject.ts:199

preferences

preferences(): Promise<Preferences[]>
Returns Promise<Preferences[]>
Inherited from PartialPlexObject.preferences
- Defined in src/base/partialPlexObject.ts:188

rate

rate(rating: number | null): Promise<void>
Set a personal rating from 0 to 10, or clear it with null.
Parameters
- rating: number | null
Returns Promise<void>
Inherited from PartialPlexObject.rate
- Defined in src/base/partialPlexObject.ts:55

refresh

refresh(): Promise<void>
Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

Returns Promise<void>
Inherited from PartialPlexObject.refresh
- Defined in src/base/plexObject.ts:51

reload

reload(): Promise<void>
load full data / reload the data for this object from this.key.

Returns Promise<void>
Overrides PartialPlexObject.reload
- Defined in src/library.ts:3590

removeCollection

removeCollection(collections: string[]): Promise<void>
Remove a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from PartialPlexObject.removeCollection
- Defined in src/base/partialPlexObject.ts:444

removeGenre

removeGenre(genres: string[]): Promise<void>
Remove a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from PartialPlexObject.removeGenre
- Defined in src/base/partialPlexObject.ts:464

removeItems

removeItems(items: CollectionVideoType[]): Promise<void>
Remove items from the collection.
Parameters
- items: CollectionVideoType[]
  Items to remove from the collection.
Returns Promise<void>
- Defined in src/library.ts:3645

removeLabel

removeLabel(labels: string[]): Promise<void>
Remove a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from PartialPlexObject.removeLabel
- Defined in src/base/partialPlexObject.ts:454

section

section(): Promise<Section>
Returns Promise<Section>
Inherited from PartialPlexObject.section
- Defined in src/base/partialPlexObject.ts:409

sortUpdate

sortUpdate(sort: "release" | "alpha" | "custom"): Promise<void>
Update the collection sort order.
Parameters
- sort: "release" | "alpha" | "custom"
  Sort order: 'release' (0), 'alpha' (1), 'custom' (2).
Returns Promise<void>
- Defined in src/library.ts:3705

split

split(): Promise<void>
Returns Promise<void>
Inherited from PartialPlexObject.split
- Defined in src/base/partialPlexObject.ts:234

unmatch

unmatch(): Promise<unknown>
Unmatches metadata match from object.

Returns Promise<unknown>
Inherited from PartialPlexObject.unmatch
- Defined in src/base/partialPlexObject.ts:396

updateFilters

updateFilters(
options?: SmartCollectionSearchOptions,
): Promise<Collections<CollectionVideoType>>
Replace the validated search behind a smart collection.
Parameters
- options: SmartCollectionSearchOptions = {}
Returns Promise<Collections<CollectionVideoType>>
- Defined in src/library.ts:3715

visibility

visibility(): Promise<ManagedHub>
Returns Promise<ManagedHub>
- Defined in src/library.ts:3536

`Static`create

create<T extends RatingKeyItem = SectionType>(
    server: PlexServer,
    title: string,
    options: CreateCollectionOptions<T>,
): Promise<Collections<T>>
Create a new regular (non-smart) collection.
Type Parameters
- T extends RatingKeyItem = SectionType
Parameters
- server: PlexServer
  The PlexServer instance.
- title: string
  Title of the new collection.
- options: CreateCollectionOptions<T>
Returns Promise<Collections<T>>
- Defined in src/library.ts:3741
create<T extends RatingKeyItem = SectionType>(
    server: PlexServer,
    title: string,
    section: LibrarySection<T>,
    items: CollectionItem[],
): Promise<Collections<T>>
Create a new regular (non-smart) collection.
Type Parameters
- T extends RatingKeyItem = SectionType
Parameters
- server: PlexServer
  The PlexServer instance.
- title: string
  Title of the new collection.
- section: LibrarySection<T>
  The library section to create the collection in.
- items: CollectionItem[]
  Items to add to the collection. They must share a Plex type.
Returns Promise<Collections<T>>
- Defined in src/library.ts:3746

Class Collections<CollectionVideoType>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collections<CollectionVideoType>

Properties

_INCLUDES

addedAt

Optionalart

childCount

collectionMode

collectionSort

Optionalcontent

contentRating

fields

guid

images

index

key

labels

OptionallibrarySectionID

OptionallibrarySectionKey

OptionallibrarySectionTitle

OptionalmaxYear

OptionalminYear

Optional Readonlyparent

Optionalrating

OptionalratingCount

OptionalratingKey

Readonlyserver

smart

subtype

summary

thumb

Optionaltitle

titleSort

Optionaltype

TYPE

OptionalultraBlurColors

updatedAt

OptionaluserRating

Optionalyear

StaticTAG

StaticTYPE

Accessors

artwork

Returns ArtworkManager

isAudio

Returns boolean

isFullObject

Returns boolean

isPhoto

Returns boolean

isVideo

Returns boolean

listType

Returns PlaylistContentType

metadataDirectory

Returns string | undefined

metadataType

Returns | "playlist" | "movie" | "show" | "season" | "episode" | "trailer" | "comic" | "person" | "artist" | "album" | "track" | "picture" | "clip" | "photo" | "photoalbum" | "playlistFolder" | "collection" | "optimizedVersion" | "userPlaylistItem"

size

Returns number

Methods

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addItems

Parameters

`Optional`art

`Optional`content

`Optional`librarySectionID

`Optional`librarySectionKey

`Optional`librarySectionTitle

`Optional`maxYear

`Optional`minYear

`Optional` `Readonly`parent

`Optional`rating

`Optional`ratingCount

`Optional`ratingKey

`Readonly`server

`Optional`title

`Optional`type

`Optional`ultraBlurColors

`Optional`userRating

`Optional`year

`Static`TAG

`Static`TYPE

Returns
| "playlist"
| "movie"
| "show"
| "season"
| "episode"
| "trailer"
| "comic"
| "person"
| "artist"
| "album"
| "track"
| "picture"
| "clip"
| "photo"
| "photoalbum"
| "playlistFolder"
| "collection"
| "optimizedVersion"
| "userPlaylistItem"