@ctrl/plex
    Preparing search index...

    Class Setting

    Represents a single Plex setting

    Hierarchy

    • PlexObject
      • Setting
    Index

    Constructors

    • Parameters

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

      Returns Setting

    Properties

    _setValue: SettingValue = null
    advanced: boolean

    True if this is an advanced setting.

    default: SettingValue

    Default value for this setting.

    enumValues?: SettingEnumValues

    List or dictionary of valis values for this setting.

    group: string

    Group name this setting is categorized as.

    hidden: boolean

    True if this is a hidden setting.

    id: string

    Setting id (or name).

    key: string

    plex relative url

    label: string

    Short description of what this setting is.

    parent?: WeakRef<any>

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

    server: PlexServer
    summary: string

    Long description of what this setting is.

    Setting type (text, int, double, bool).

    Current value for this setting.

    TAG: string = null

    xml element tag

    TYPE: string = null

    xml element type

    Methods

    • Parameters

      • data: SettingResponse

      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>