Class Optimized

Hierarchy

PlexObject
- Optimized

Index

Constructors

Properties

composite id key parent? server target targetTagID title type TAG TYPE

Methods

isChildOf refresh reload remove rename reprocess

Constructors

constructor

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

Properties

composite

composite: any

id

id: string

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

target

target: any

targetTagID

targetTagID: any

title

title: any

type

type: any

`Static`TAG

TAG: string = 'Item'

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 PlexObject.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 PlexObject.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 PlexObject.reload
- Defined in src/base/plexObject.ts:38

remove

remove(): Promise<void>
Remove this Optimized item.

Returns Promise<void>
- Defined in src/media.ts:419

rename

rename(title: string): Promise<void>
Rename this Optimized item.
Parameters
- title: string
  New title for the item.
Returns Promise<void>
- Defined in src/media.ts:428

reprocess

reprocess(ratingKey: string | number): Promise<void>
Reprocess a removed Conversion item that is still a listed Optimize item.
Parameters
- ratingKey: string | number
  The rating key of the item to reprocess.
Returns Promise<void>
- Defined in src/media.ts:437