Class Collections<CollectionVideoType>

_INCLUDES

key

OptionallibrarySectionID

Optional Readonlyparent

OptionalratingKey

Readonlyserver

Optionaltitle

Optionaltype

Optionalyear

StaticTYPE

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

addCollection

• addCollection(collections: string[]): Promise<void>

  Add a collection(s).

  Parameters

  • collections: string[]

  Returns Promise<void>

addGenre

• addGenre(genres: string[]): Promise<void>

  Add a genre(s).

  Parameters

  • genres: string[]

  Returns Promise<void>

addLabel

• addLabel(labels: string[]): Promise<void>

  Add a label(s).

  Parameters

  • labels: string[]

  Returns Promise<void>

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>

delete

• delete(): Promise<any>

  Delete a media element. This has to be enabled under settings > server > library in plex webui.

  Returns Promise<any>

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>

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>

getWebURL

• getWebURL(__namedParameters?: { base?: string }): string

  Parameters

  • __namedParameters: { base?: string } = {}

  Returns string

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[]>

isChildOf

• isChildOf(cls: any): boolean

  Returns True if this object is a child of the given class.

  Parameters

  • cls: any

  Returns boolean

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:

    1. video.matches()

    2. video.matches({ title: "something", year: "2020" })

    3. video.matches({ title: "something" })

    4. video.matches({ year: "2020" })

    5. video.matches({ title: "something", year: "" })

    6. video.matches({ title: "", year: "2020" })

    7. video.matches({ title: "", year: "" })

    8. The default behaviour in Plex Web = no params in plexapi

    9. Both title and year specified by user

    10. Year automatically filled in

    11. Title automatically filled in

    12. Explicitly searches for title with blank year

    13. Explicitly searches for blank title with year

    14. 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[]>

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>

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>

removeCollection

• removeCollection(collections: string[]): Promise<void>

  Remove a collection(s).

  Parameters

  • collections: string[]

  Returns Promise<void>

removeGenre

• removeGenre(genres: string[]): Promise<void>

  Remove a genre(s).

  Parameters

  • genres: string[]

  Returns Promise<void>

removeLabel

• removeLabel(labels: string[]): Promise<void>

  Remove a label(s).

  Parameters

  • labels: string[]

  Returns Promise<void>

section

• section(): Promise<Section>

  Returns Promise<Section>

unmatch

• unmatch(): Promise<any>

  Unmatches metadata match from object.

  Returns Promise<any>