Class Activity

Represents a currently running activity on the Plex server.

Hierarchy

PlexObject
- Activity

Index

Constructors

Properties

cancellable key parent? progress server subtitle title type userID uuid TAG TYPE

Methods

cancel isChildOf refresh reload

Constructors

constructor

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

Properties

cancellable

cancellable: boolean

key

key: string

plex relative url

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

progress

progress: number

`Readonly`server

server: PlexServer

subtitle

subtitle: string

title

title: string

type

type: string

userID

userID: number

uuid

uuid: string

`Static`TAG

TAG: string = 'Activity'

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Methods

cancel

cancel(): Promise<void>
Cancel the activity.

Returns Promise<void>
- Defined in src/serverModels.ts:26

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