@ctrl/plex
    Preparing search index...

    Class Agent

    Represents a single Agent

    Hierarchy

    • PlexObject
      • Agent
    Index
    constructor
    hasAttribution? hasPrefs id? identifier key languageCode? mediaType? name? parent? primary? server shortIdentifier TAG TYPE
    isChildOf refresh reload

    • Parameters

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

      Returns Agent

    hasAttribution?: boolean
    hasPrefs: boolean
    id?: number
    identifier: string
    key: string

    plex relative url

    languageCode?: string
    mediaType?: number
    name?: string
    parent?: WeakRef<any>

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

    primary?: boolean
    server: PlexServer
    shortIdentifier: string
    TAG: string = 'Agent'

    xml element tag

    TYPE: string = null

    xml element type

    • 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