@ctrl/plex
    Preparing search index...

    Class Hub

    Represents a single Hub (or category) in the PlexServer search

    Hierarchy

    • PlexObject
      • Hub
    Index
    constructor
    context? Directory hubIdentifier hubKey? key librarySectionID? Metadata more parent? random server size style? title type TAG TYPE
    isChildOf items refresh reload section

    • Parameters

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

      Returns Hub

    context?: string
    Directory: Directory[]
    hubIdentifier: string
    hubKey?: string
    key: string

    plex relative url

    librarySectionID?: string
    Metadata: SearchResult[]
    more: boolean

    True if Plex has more items available at this hub's key.

    parent?: WeakRef<any>

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

    random: boolean

    True if the hub items are randomized.

    server: PlexServer
    size: number

    Number of items found.

    style?: string
    title: string
    type: string
    TAG: string = 'Hub'

    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

    • Return items from this hub.

      Plex often includes a partial Metadata list with the hub response. When more is true, this fetches the hub key first so callers get the full item list instead of only the preview items.

      Returns Promise<HubItem[]>

    • Return items from this hub.

      Plex often includes a partial Metadata list with the hub response. When more is true, this fetches the hub key first so callers get the full item list instead of only the preview items.

      Type Parameters

      Parameters

      • Cls: Class<T>

      Returns Promise<T[]>

    • 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