@ctrl/plex
    Preparing search index...

    Class FilteringSort

    Represents a single Sort object for a FilteringType

    Hierarchy

    • PlexObject
      • FilteringSort
    Index

    Constructors

    constructor

    Properties

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

    Methods

    _loadData isChildOf refresh reload

    Constructors

    • Parameters

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

      Returns FilteringSort

    Properties

    active: boolean

    True if the sort is currently active.

    activeDirection: string

    The currently active sorting direction.

    default: string

    The currently active default sorting direction.

    defaultDirection: string

    The default sorting direction.

    descKey: string

    The URL key for sorting with desc.

    firstCharacterKey: string

    API URL path for first character endpoint.

    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 sorting.

    TAG: string = 'Sort'

    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