Class SearchResult

Hierarchy

  • PlexObject
    • SearchResult

Constructors

constructor

Properties

guid key lifespanEnded name parent? score server year TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

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

  • Parameters

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

    Returns SearchResult

Properties

guid

guid: string

key

key: string

plex relative url

lifespanEnded

lifespanEnded: boolean

name

name: string

Optional Readonlyparent

parent?: WeakRef<any>

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

score

score: number

Readonlyserver

server: PlexServer

year

year: number

StaticTAG

TAG: string = 'SearchResult'

xml element tag

StaticTYPE

TYPE: string = null

xml element type

Methods

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