@ctrl/plex
    Preparing search index...

    Class BaseResourceAbstract

    Base class for all Art, Poster, and Theme objects.

    Hierarchy (View Summary)

    Index
    constructor
    key parent? provider? ratingKey selected server thumb TAG TYPE
    isChildOf refresh reload resourceFilepath select
    key: string

    Plex relative url, when the payload includes one.

    parent?: WeakRef<PlexObject>

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

    provider?: string

    The source of the resource. 'local' for local files (e.g. theme.mp3),

    ratingKey: string

    Unique key identifying the resource.

    selected: boolean

    True if the resource is currently selected.

    server: PlexServer
    thumb: string

    The URL to retrieve the resource thumbnail.

    TAG: string | null = null

    xml element tag

    TYPE: string | null = null

    xml element type

    • Returns true if this object was built from a parent of the given class.

      Parameters

      • cls: new (...args: any[]) => PlexObject

      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>

    • Path to this resource relative to the Plex data directory, or undefined when the parent item's metadata directory is unknown.

      Returns string | undefined

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods