Class FilterChoice

Hierarchy

  • PlexObject
    • FilterChoice

Constructors

constructor

Properties

fastKey key parent? server thumb? title type TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

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

  • Parameters

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

    Returns FilterChoice

Properties

fastKey

fastKey: string

API URL path to quickly list all items with this filter choice. (/library/sections/

/all?genre=)

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

Optionalthumb

thumb?: string

Thumbnail URL for the filter choice.

title

title: string

The title of the filter choice.

type

type: string

The filter type (genre, contentRating, etc).

StaticTAG

TAG: string = 'Directory'

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