Class Guid

Hierarchy

GuidTag
- Guid

Index

Constructors

Properties

id key parent? server TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

new Guid(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): Guid
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns Guid
Inherited from GuidTag.constructor
- Defined in src/base/plexObject.ts:23

Properties

id

id: string

The guid for external metadata sources (e.g. IMDB, TMDB, TVDB). ex - imdb://tt3222784

key

key: string

plex relative url

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

`Readonly`server

server: PlexServer

`Static`TAG

TAG: "Guid" = ...

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Methods

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from GuidTag.isChildOf
- Defined in src/base/plexObject.ts:63

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>
Inherited from GuidTag.refresh
- Defined in src/base/plexObject.ts:55

reload

reload(ekey?: string): Promise<void>
Reload the data for this object from this.key.
Parameters
- Optionalekey: string
Returns Promise<void>
Inherited from GuidTag.reload
- Defined in src/base/plexObject.ts:38