Class Hub

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

Hierarchy

  • PlexObject
    • Hub

Constructors

constructor

Properties

Directory Metadata hubIdentifier key parent? server size title type TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

  • new Hub(server, data, initpath?, parent?): Hub

  • Parameters

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

    Returns Hub

Properties

Directory

Directory: Directory[]

Metadata

Metadata: Metadatum[]

hubIdentifier

hubIdentifier: string

key

key: string

plex relative url

Optional Readonlyparent

parent?: WeakRef<any>

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

Readonlyserver

server: PlexServer

size

size: number

Number of items found.

title

title: string

type

type: string

StaticTAG

TAG: string = 'Hub'

xml element tag

StaticTYPE

TYPE: string = null

xml element type

Methods

isChildOf

  • isChildOf(cls): boolean

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

    Parameters

    • cls: any

    Returns boolean

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?): 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