Class ButlerTask

Represents a scheduled butler (maintenance) task on the Plex server.

Hierarchy

PlexObject
- ButlerTask

Index

Constructors

Properties

description enabled interval key name parent? scheduleRandomized server title TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

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

Properties

description

description: string

enabled

enabled: boolean

interval

interval: number

key

key: string

plex relative url

name

name: string

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

scheduleRandomized

scheduleRandomized: boolean

`Readonly`server

server: PlexServer

title

title: string

`Static`TAG

TAG: string = 'ButlerTask'

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