Class Poster

Represents a single Poster object.

Hierarchy

  • BaseResource
    • Poster

Constructors

constructor

Properties

key parent? provider ratingKey selected server thumb TAG TYPE

Methods

isChildOf refresh reload resourceFilepath select

Constructors

constructor

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

  • Parameters

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

    Returns Poster

Properties

key

key: string

plex relative url

Optional Readonlyparent

parent?: WeakRef<any>

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

provider

provider: string

The source of the resource. 'local' for local files (e.g. theme.mp3),

ratingKey

ratingKey: string

Unique key identifying the resource.

selected

selected: boolean

True if the resource is currently selected.

Readonlyserver

server: PlexServer

thumb

thumb: string

The URL to retrieve the resource thumbnail.

StaticTAG

TAG: string = 'Photo'

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>

resourceFilepath

  • resourceFilepath(): string

  • Returns string

select

  • select(): Promise<any>

  • Returns Promise<any>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods