@ctrl/plex
    Preparing search index...

    Class LibraryMediaTag

    Generic library tag returned when Plex exposes a tag type that does not have a dedicated media tag class in this package.

    Prefer Library.tags with a named tag type such as 'genre' or 'director' when one is available. Numeric tag types use this fallback shape.

    Hierarchy

    • PlexObject
      • LibraryMediaTag

    Implements

    Index
    constructor
    count? filter? FILTER id? key librarySectionID? librarySectionKey? librarySectionTitle? librarySectionType? parent? reason? reasonID? reasonTitle? score? server tag tagKey? tagType? tagValue? thumb? type? TAG TYPE
    isChildOf items refresh reload
    count?: number

    Number of library items with this tag, when Plex provides it.

    filter?: string

    Filter expression Plex uses for this tag.

    FILTER: string = 'tag'
    id?: string | number

    Tag id.

    key: string

    plex relative url

    librarySectionID?: number

    Library section id this tag belongs to, when scoped.

    librarySectionKey?: string

    Library section key this tag belongs to, when scoped.

    librarySectionTitle?: string

    Library section title this tag belongs to, when scoped.

    librarySectionType?: number

    Numeric Plex section type this tag belongs to, when scoped.

    parent?: WeakRef<any>

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

    reason?: string

    Search result reason, when the tag came from a search payload.

    reasonID?: number

    Search result reason id, when Plex provides it.

    reasonTitle?: string

    Search result reason title, when Plex provides it.

    score?: number

    Search score, when the tag came from a search payload.

    server: PlexServer
    tag: string

    Tag title.

    tagKey?: string

    Plex Discover rating key for person tags, when available.

    tagType?: number

    Numeric Plex tag type.

    tagValue?: number

    Numeric Plex tag value, when available.

    thumb?: string

    Tag thumbnail, when available.

    type?: string

    Search result type.

    TAG: string = 'Directory'

    xml element tag

    TYPE: string = null

    xml element type

    • 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