@ctrl/plex
    Preparing search index...

    Class Collection

    Represents a single Collection media tag.

    Hierarchy

    • MediaTag
      • Collection
    Index

    Constructors

    constructor

    Properties

    FILTER id? key parent? role? server tag TAG TYPE

    Methods

    isChildOf refresh reload

    Constructors

    • Parameters

      • server: PlexServer
      • data: any
      • Optionalinitpath: string
      • Optionalparent: PlexObject

      Returns Collection

    Properties

    FILTER: "collection" = ...
    id?: string

    Tag ID (This seems meaningless except to use it as a unique id).

    key: string

    plex relative url

    parent?: WeakRef<any>

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

    role?: string

    unknown

    server: PlexServer
    tag: string

    Name of the tag. This will be Animation, SciFi etc for Genres. The name of person for Directors and Roles (ex: Animation, Stephen Graham, etc).

    TAG: "Collection" = ...
    TYPE: string = null

    xml element type

    Methods

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

      Parameters

      • cls: any

      Returns boolean

    • 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 the data for this object from this.key.

      Parameters

      • Optionalekey: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods