Class Rating

Represents a single Rating media tag.

Hierarchy

  • PlexObject
    • Rating

Constructors

constructor

Properties

image key parent? server type value TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

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

  • Parameters

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

    Returns Rating

Properties

image

image: string

The uri for the rating image (e.g. imdb://image.rating, rottentomatoes://image.rating.ripe, rottentomatoes://image.rating.upright, themoviedb://image.rating).

key

key: string

plex relative url

Optional Readonlyparent

parent?: WeakRef<any>

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

Readonlyserver

server: PlexServer

type

type: "audience" | "critic"

The type of rating (e.g. audience or critic).

value

value: number

The rating value.

StaticTAG

TAG: "Rating" = ...

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