Class FilteringSort

Represents a single Sort object for a FilteringType

Hierarchy

  • PlexObject
    • FilteringSort

Constructors

constructor

Properties

active activeDirection default defaultDirection descKey firstCharacterKey key parent? server title TAG TYPE

Methods

_loadData isChildOf refresh reload

Constructors

constructor

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

  • Parameters

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

    Returns FilteringSort

Properties

active

active: boolean

True if the sort is currently active.

activeDirection

activeDirection: string

The currently active sorting direction.

default

default: string

The currently active default sorting direction.

defaultDirection

defaultDirection: string

The default sorting direction.

descKey

descKey: string

The URL key for sorting with desc.

firstCharacterKey

firstCharacterKey: string

API URL path for first character endpoint.

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

title

title: string

The title of the sorting.

StaticTAG

TAG: string = 'Sort'

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