Class FilteringField

Represents a single Field object for a FilteringType

Hierarchy

  • PlexObject
    • FilteringField

Constructors

constructor

Properties

key parent? server subType title type TAG TYPE

Methods

_loadData isChildOf refresh reload

Constructors

constructor

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

  • Parameters

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

    Returns FilteringField

Properties

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

subType

subType: string

The subtype of the filter (decade, rating, etc)

title

title: string

type

type: string

StaticTAG

TAG: string = 'Field'

xml element tag

StaticTYPE

TYPE: string = null

xml element type

Methods

_loadData

  • _loadData(data): void

  • Parameters

    • data: any

    Returns void

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