Class Folder

Represents a Folder inside a library.

Hierarchy

  • PlexObject
    • Folder

Constructors

constructor

Properties

key parent? server title TAG TYPE

Methods

isChildOf refresh reload subfolders

Constructors

constructor

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

  • Parameters

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

    Returns Folder

Properties

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

title

title: string

StaticTAG

TAG: string = null

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>

subfolders

  • subfolders(): Promise<Folder[]>

  • Returns a list of available Folders for this folder. Continue down subfolders until a mediaType is found.

    Returns Promise<Folder[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods