@ctrl/plex
    Preparing search index...

    Class FilteringFilter

    Represents a single Filter object for a FilteringType

    Hierarchy

    • PlexObject
      • FilteringFilter
    Index

    Constructors

    constructor

    Properties

    filter filterType key parent? server title type TAG TYPE

    Methods

    _loadData isChildOf refresh reload

    Constructors

    • Parameters

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

      Returns FilteringFilter

    Properties

    filter: string

    The key for the filter.

    filterType: string

    The :class:~plexapi.library.FilteringFieldType type (string, boolean, integer, date, etc).

    key: string

    plex relative url

    parent?: WeakRef<any>

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

    server: PlexServer
    title: string

    The title of the filter.

    type: string

    'filter'

    TAG: string = 'Filter'

    xml element tag

    TYPE: string = null

    xml element type

    Methods

    _loadData

    • _loadData(data: any): void

      Parameters

      • data: any

      Returns void

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

      Parameters

      • cls: any

      Returns boolean

    • 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