Class FilteringField

Represents a single Field object for a FilteringType

Hierarchy

PlexObject
- FilteringField

Index

Constructors

Properties

key parent? server subType title type TAG TYPE

Methods

_loadData isChildOf refresh reload

Constructors

constructor

new FilteringField(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): FilteringField
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns FilteringField
Inherited from PlexObject.constructor
- Defined in src/base/plexObject.ts:23

Properties

key

key: string

plex relative url

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

`Readonly`server

server: PlexServer

subType

subType: string

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

title

title: string

type

type: string

`Static`TAG

TAG: string = 'Field'

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Methods

_loadData

_loadData(data: any): void
Parameters
- data: any
Returns void
Overrides PlexObject._loadData
- Defined in src/library.ts:1137

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from PlexObject.isChildOf
- Defined in src/base/plexObject.ts:63

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>
Inherited from PlexObject.refresh
- Defined in src/base/plexObject.ts:55

reload

reload(ekey?: string): Promise<void>
Reload the data for this object from this.key.
Parameters
- Optionalekey: string
Returns Promise<void>
Inherited from PlexObject.reload
- Defined in src/base/plexObject.ts:38