Class LibrarySection<SType>`Abstract`

Base class for a single library section.

Type Parameters

SType = SectionType

Hierarchy (View Summary)

PlexObject
- LibrarySection

Constructors

constructor

new LibrarySection<SType = SectionType>(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): LibrarySection<SType>
Type Parameters
- SType = SectionType
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns LibrarySection<SType>
Inherited from PlexObject.constructor
- Defined in src/base/plexObject.ts:23

Properties

`Optional`_fieldTypes

_fieldTypes?: FilteringFieldType[]

`Optional`_filterTypes

_filterTypes?: FilteringType[]

agent

agent: string

Unknown (com.plexapp.agents.imdb, etc)

allowSync

allowSync: boolean

l True if you allow syncing content from this section.

art

art: string

Wallpaper artwork used to respresent this section.

composite

composite: string

Composit image used to represent this section.

CONTENT_TYPE

CONTENT_TYPE: string

createdAt

createdAt: Date

Datetime this library section was created.

filters

filters: boolean

Unknown

key

key: string

plex relative url

language

language: string

Language represented in this section (en, xn, etc).

locations

locations: Location[]

Paths on disk where section content is stored.

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

refreshing

refreshing: boolean

True if this section is currently being refreshed.

scannedAt

scannedAt: Date

scanner

scanner: string

Internal scanner used to find media (Plex Movie Scanner, Plex Premium Music Scanner, etc.)

`Readonly`SECTION_TYPE

SECTION_TYPE: Class<SType>

`Readonly`server

server: PlexServer

thumb

thumb: string

Thumbnail image used to represent this section.

title

title: string

Title of this section.

type

type: "movie" | "show"

Type of content section represents (movie, artist, photo, show).

updatedAt

updatedAt: Date

Datetime this library section was last updated.

uuid

uuid: string

Unique id for this section (32258d7c-3e6c-4ac5-98ad-bad7a3b78c63)

`Static`ALLOWED_FILTERS

ALLOWED_FILTERS: string[] = []

`Static`ALLOWED_SORT

ALLOWED_SORT: string[] = []

`Static`BOOLEAN_FILTERS

BOOLEAN_FILTERS: string[] = ...

`Static`TAG

TAG: string = null

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Methods

agents

agents(): Promise<Agent[]>
Returns Promise<Agent[]>
- Defined in src/library.ts:414

all

all(sort?: string): Promise<SType[]>
Parameters
- sort: string = ''
Returns Promise<SType[]>
- Defined in src/library.ts:403

analyze

analyze(): Promise<void>
Run an analysis on all of the items in this library section. See :func:~plexapi.base.PlexPartialObject.analyze for more details.

Returns Promise<void>
- Defined in src/library.ts:521

cancelUpdate

cancelUpdate(): Promise<void>
Cancel update of this Library Section.

Returns Promise<void>
- Defined in src/library.ts:554

collections

collections(
args?: Record<string, number | string | boolean>,
): Promise<Collections<SType>[]>
Parameters
- args: Record<string, number | string | boolean> = {}
Returns Promise<Collections<SType>[]>
- Defined in src/library.ts:616

delete

delete(): Promise<void>
Delete a library section.

Returns Promise<void>
- Defined in src/library.ts:578

deleteMediaPreviews

deleteMediaPreviews(): Promise<void>
Delete the preview thumbnails for items in this library. This cannot be undone. Recreating media preview files can take hours or even days.

Returns Promise<void>
- Defined in src/library.ts:572

edit

edit(kwargs: Record<string, string>): Promise<Section>
Edit a library
Parameters
- kwargs: Record<string, string>
  object of settings to edit
Returns Promise<Section>
- Defined in src/library.ts:587

emptyTrash

emptyTrash(): Promise<void>
If a section has items in the Trash, use this option to empty the Trash

Returns Promise<void>
- Defined in src/library.ts:529

fieldTypes

fieldTypes(): Promise<FilteringFieldType[]>
Returns Promise<FilteringFieldType[]>
- Defined in src/library.ts:712

filterTypes

filterTypes(): Promise<FilteringType[]>
Returns Promise<FilteringType[]>
- Defined in src/library.ts:704

folders

folders(): Promise<Folder[]>
Returns a list of available Folders for this library section.

Returns Promise<Folder[]>
- Defined in src/library.ts:632

genres

genres(): Promise<FilterChoice[]>
Returns Promise<FilterChoice[]>
- Defined in src/library.ts:637

get

get(title: string): Promise<SType>
Parameters
- title: string
  Title of the item to return.
Returns Promise<SType>
the media item with the specified title.
- Defined in src/library.ts:422

getFieldType

getFieldType(fieldType: string): Promise<FilteringFieldType>
Parameters
- fieldType: string
  The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution).
Returns Promise<FilteringFieldType>
- Defined in src/library.ts:667

getFilterType

getFilterType(
    libtype?:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilteringType>
Parameters
- libtype:
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "artist"
      | "album"
      | "track"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem" = ...
Returns Promise<FilteringType>
- Defined in src/library.ts:650

getGuid

getGuid(guid: string): Promise<SType>
Returns the media item with the specified external IMDB, TMDB, or TVDB ID. Note: This search uses a PlexAPI operator so performance may be slow. All items from the entire Plex library need to be retrieved for each guid search. It is recommended to create your own lookup dictionary if you are searching for a lot of external guids.
Parameters
- guid: string
  The external guid of the item to return. Examples: IMDB imdb://tt0944947, TMDB tmdb://1399, TVDB tvdb://121361.
  
  Example:
  
  .. code-block:: python # This will retrieve all items in the entire library 3 times result1 = library.getGuid('imdb://tt0944947') result2 = library.getGuid('tmdb://1399') result3 = library.getGuid('tvdb://121361') # This will only retrieve all items in the library once to create a lookup dictionary guidLookup = {guid.id: item for item in library.all() for guid in item.guids} result1 = guidLookup['imdb://tt0944947'] result2 = guidLookup['tmdb://1399'] result3 = guidLookup['tvdb://121361']
Returns Promise<SType>
- Defined in src/library.ts:453

getWebURL

getWebURL(base?: string, tab?: string, key?: string): string
Returns the Plex Web URL for the library.
Parameters
- Optionalbase: string
  The base URL before the fragment (#!). Default is https://app.plex.tv/desktop.
- Optionaltab: string
  The library tab (recommended, library, collections, playlists, timeline).
- Optionalkey: string
  A hub key.
Returns string
- Defined in src/library.ts:466

hubs

hubs(): Promise<Hub[]>
Returns Promise<Hub[]>
- Defined in src/library.ts:602

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

listFields

listFields(
    libtype?:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilteringField[]>
Returns a list of available FilteringField for a specified libtype. This is the list of options in the custom filter dropdown menu
Parameters
- libtype:
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "artist"
      | "album"
      | "track"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem" = ...
Returns Promise<FilteringField[]>
- Defined in src/library.ts:646

listFilters

listFilters(
    libtype?:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilteringFilter[]>
Parameters
- Optionallibtype:
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "artist"
      | "album"
      | "track"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"
  The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection).
Returns Promise<FilteringFilter[]>
Example
```
const availableFilters = (await library.listFilters()).map(f => f.filter)
```
- Defined in src/library.ts:692

listOperators

listOperators(fieldType: string): Promise<FilteringOperator[]>
Parameters
- fieldType: string
  The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution).
Returns Promise<FilteringOperator[]>
- Defined in src/library.ts:700

playlists

playlists(): Promise<Playlist[]>
Returns a list of playlists from this library section.

Returns Promise<Playlist[]>
- Defined in src/library.ts:611

refresh

refresh(): Promise<void>
Forces a download of fresh media information from the internet. This can take a long time. Any locked fields are not modified.

Returns Promise<void>
Overrides PlexObject.refresh
- Defined in src/library.ts:563

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

search

search<C = SType>(args?: Partial<SearchArgs>, Cls?: Class<C>): Promise<C[]>
Search the library. The http requests will be batched in container_size. If you are only looking for the first results, it would be wise to set the maxresults option to that amount so the search doesn't iterate over all results on the server.

Example: "studio=Comedy%20Central" or "year=1999" "title=Kung Fu" all work. Other items such as actor= seem to work, but require you already know the id of the actor. TLDR: This is untested but seems to work. Use library section search when you can.
Type Parameters
- C = SType
Parameters
- args: Partial<SearchArgs> = {}
  Search using a number of different attributes
- OptionalCls: Class<C>
Returns Promise<C[]>
- Defined in src/library.ts:491

update

update(): Promise<void>
Scan this section for new media.

Returns Promise<void>
- Defined in src/library.ts:546

Class LibrarySection<SType>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LibrarySection<SType>

Properties

Optional_fieldTypes

Optional_filterTypes

agent

allowSync

art

composite

CONTENT_TYPE

createdAt

filters

key

language

locations

Optional Readonlyparent

refreshing

scannedAt

scanner

ReadonlySECTION_TYPE

Readonlyserver

thumb

title

type

updatedAt

uuid

StaticALLOWED_FILTERS

StaticALLOWED_SORT

StaticBOOLEAN_FILTERS

StaticTAG

StaticTYPE

Methods

agents

Returns Promise<Agent[]>

all

Parameters

Returns Promise<SType[]>

analyze

Returns Promise<void>

cancelUpdate

Returns Promise<void>

collections

Parameters

Returns Promise<Collections<SType>[]>

delete

Returns Promise<void>

deleteMediaPreviews

Returns Promise<void>

edit

Parameters

Returns Promise<Section>

emptyTrash

Returns Promise<void>

fieldTypes

Returns Promise<FilteringFieldType[]>

filterTypes

Returns Promise<FilteringType[]>

folders

Returns Promise<Folder[]>

genres

Returns Promise<FilterChoice[]>

get

Parameters

Returns Promise<SType>

getFieldType

Parameters

Returns Promise<FilteringFieldType>

getFilterType

Parameters

Returns Promise<FilteringType>

Class LibrarySection<SType>`Abstract`

`Optional`_fieldTypes

`Optional`_filterTypes

`Optional` `Readonly`parent

`Readonly`SECTION_TYPE

`Readonly`server

`Static`ALLOWED_FILTERS

`Static`ALLOWED_SORT

`Static`BOOLEAN_FILTERS

`Static`TAG

`Static`TYPE