Class Collections<CollectionVideoType>

Type Parameters

CollectionVideoType = VideoType

Hierarchy

PartialPlexObject
- Collections

Constructors

constructor

new Collections<CollectionVideoType = VideoType>(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): Collections<CollectionVideoType>
Type Parameters
- CollectionVideoType = VideoType
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns Collections<CollectionVideoType>
Inherited from PartialPlexObject.constructor
- Defined in src/base/plexObject.ts:23

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: number

`Optional`art

art?: string

childCount

childCount: number

contentRating

contentRating: string

guid

guid: string

index

index: number

key

key: string

plex relative url

`Optional`librarySectionID

librarySectionID?: number

librarySectionKey

librarySectionKey: string

librarySectionTitle

librarySectionTitle: string

maxYear

maxYear: string

minYear

minYear: string

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

`Optional`ratingKey

ratingKey?: string

`Readonly`server

server: PlexServer

subtype

subtype: string

summary

summary: string

thumb

thumb: string

`Optional`title

title?: string

`Optional`type

type?: string

TYPE

TYPE: string = 'collection'

updatedAt

updatedAt: number

VIDEO_TYPE

VIDEO_TYPE: Class<CollectionVideoType>

`Optional`year

year?: number

`Static`TAG

TAG: string = 'Directory'

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Accessors

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:85

size

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

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:215

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:235

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:225

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:58

delete

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

Returns Promise<any>
Inherited from PartialPlexObject.delete
- Defined in src/base/partialPlexObject.ts:210

edit

edit(changeObj: Record<string, string | number>): Promise<void>
Edit an object.
Parameters
- changeObj: Record<string, string | number>
  Obj of settings to edit. Example: {'type': 1, 'id': movie.ratingKey, 'title.value': 'New Title', 'collection[0].tag.tag': 'Super', 'collection.locked': 0}
Returns Promise<void>
Inherited from PartialPlexObject.edit
- Defined in src/base/partialPlexObject.ts:258

fixMatch

fixMatch(
    searchResult?: SearchResult,
    auto?: boolean,
    agent?: string,
): Promise<void>
Use match result to update show metadata.
Parameters
- OptionalsearchResult: SearchResult
  Search result
- auto: boolean = false
  True uses first match from matches, False allows user to provide the match
- agent: string = ''
  (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
Returns Promise<void>
See
PartialPlexObject.matches
Inherited from PartialPlexObject.fixMatch
- Defined in src/base/partialPlexObject.ts:95

getWebURL

getWebURL(base?: string): string
Parameters
- Optionalbase: string
Returns string
Inherited from PartialPlexObject.getWebURL
- Defined in src/base/partialPlexObject.ts:244

history

history(maxresults?: number, mindate?: Date): Promise<HistoryMetadatum[]>
Get Play History for a media item.
Parameters
- maxresults: number = 9999999
  Only return the specified number of results (optional).
- Optionalmindate: Date
  Min datetime to return results from.
Returns Promise<HistoryMetadatum[]>
Inherited from PartialPlexObject.history
- Defined in src/base/partialPlexObject.ts:199

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from PartialPlexObject.isChildOf
- Defined in src/base/plexObject.ts:63

items

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

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

matches

matches(
    agent?: string,
    title?: string,
    year?: string,
    language?: string,
): Promise<SearchResult[]>
Parameters
- Optionalagent: string
  Agent name to be used (imdb, thetvdb, themoviedb, etc.)
- Optionaltitle: string
  Title of item to search for
- Optionalyear: string
  Year of item to search in
- Optionallanguage: string
  Language of item to search in
  
  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:139

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:55

reload

reload(ekey?: string, args?: any): Promise<void>
load full data / reload the data for this object from this.key.
Parameters
- Optionalekey: string
- Optionalargs: any
Returns Promise<void>
Inherited from PartialPlexObject.reload
- Defined in src/base/partialPlexObject.ts:66

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:220

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:240

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:230

section

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

unmatch

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

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

Class Collections<CollectionVideoType>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collections<CollectionVideoType>

Properties

_INCLUDES

addedAt

Optionalart

childCount

contentRating

guid

index

key

OptionallibrarySectionID

librarySectionKey

librarySectionTitle

maxYear

minYear

Optional Readonlyparent

OptionalratingKey

Readonlyserver

subtype

summary

thumb

Optionaltitle

Optionaltype

TYPE

updatedAt

VIDEO_TYPE

Optionalyear

StaticTAG

StaticTYPE

Accessors

isFullObject

Returns boolean

size

Returns number

Methods

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addLabel

Parameters

Returns Promise<void>

analyze

Returns Promise<void>

delete

Returns Promise<any>

edit

Parameters

Returns Promise<void>

fixMatch

Parameters

Returns Promise<void>

See

getWebURL

Parameters

Returns string

history

Parameters

Returns Promise<HistoryMetadatum[]>

isChildOf

Parameters

Returns boolean

items

Returns Promise<CollectionVideoType[]>

matches

Parameters

`Optional`art

`Optional`librarySectionID

`Optional` `Readonly`parent

`Optional`ratingKey

`Readonly`server

`Optional`title

`Optional`type

`Optional`year

`Static`TAG

`Static`TYPE