@ctrl/plex
    Preparing search index...

    Class FirstCharacter

    Represents a single first character entry for a library section. Used to populate the alphabet bar in the Plex UI.

    Hierarchy

    • PlexObject
      • FirstCharacter
    Index

    Constructors

    constructor

    Properties

    key parent? server size title TAG TYPE

    Methods

    isChildOf refresh reload

    Constructors

    Properties

    key: string

    plex relative url

    parent?: WeakRef<any>

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

    server: PlexServer
    size: number

    The number of items starting with this character.

    title: string

    The title of the character (e.g. 'A', 'B', '#').

    TAG: string = 'Directory'

    xml element tag

    TYPE: string = null

    xml element type

    Methods

    • 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