Class PhotoSection

Base class for a single library section.

Hierarchy (View Summary)

LibrarySection<Photoalbum>
- PhotoSection

Index

Constructors

constructor

Constructors

constructor

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

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 = 'photo'

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.

METADATA_TYPE

METADATA_TYPE: "photo" = ...

Default item type used by smart filters in this section.

`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: typeof Photoalbum = Photoalbum

`Readonly`server

server: PlexServer

thumb

thumb: string

Thumbnail image used to represent this section.

title

title: string

Title of this section.

type

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 = 'Directory'

xml element tag

`Static`TYPE

TYPE: string = 'photo'

xml element type

Methods

addLocations

addLocations(locations: string | string[]): Promise<Section>
Add new file paths to the library section.
Parameters
- locations: string | string[]
  One or more file paths to add.
Returns Promise<Section>
Inherited from LibrarySection.addLocations
- Defined in src/library.ts:1476

agents

agents(): Promise<Agent[]>
Returns Promise<Agent[]>
Inherited from LibrarySection.agents
- Defined in src/library.ts:1532

all

all<
    T extends
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
>(
    options: Omit<Partial<SearchArgs>, "maxresults" | "libtype"> & {
        libtype?:
            | "track"
            | "artist"
            | "album"
            | "movie"
            | "show"
            | "season"
            | "episode"
            | "trailer"
            | "comic"
            | "person"
            | "picture"
            | "clip"
            | "photo"
            | "photoalbum"
            | "playlist"
            | "playlistFolder"
            | "collection"
            | "optimizedVersion"
            | "userPlaylistItem";
        maxResults?: number;
    } & { libtype: T },
): Promise<SearchClassForLibtype<T>[]>
Returns photo library items.

Photo sections default to albums to match Plex's photo library behavior. Pass libtype: 'photo' to return individual photos instead.
Type Parameters
- T extends
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"
Parameters
- options: Omit<Partial<SearchArgs>, "maxresults" | "libtype"> & {
      libtype?:
          | "track"
          | "artist"
          | "album"
          | "movie"
          | "show"
          | "season"
          | "episode"
          | "trailer"
          | "comic"
          | "person"
          | "picture"
          | "clip"
          | "photo"
          | "photoalbum"
          | "playlist"
          | "playlistFolder"
          | "collection"
          | "optimizedVersion"
          | "userPlaylistItem";
      maxResults?: number;
  } & { libtype: T }
  - Optionallibtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem"
    
    Return a specific library item type instead of the section default.
    
    Passing this narrows section.all({ libtype }) to the matching model type.
  - OptionalmaxResults?: number
    
    Maximum number of items to return.
    
    Plex may ignore the container size hint on some endpoints, so this method also applies the limit locally before returning.
  - libtype: T
Returns Promise<SearchClassForLibtype<T>[]>
Example
```
const albums = await photoSection.all()
const photos = await photoSection.all({ libtype: 'photo', maxResults: 50 })
```
Overrides LibrarySection.all
- Defined in src/library.ts:3033
all(): Promise<Photoalbum[]>
Returns photo library items.

Photo sections default to albums to match Plex's photo library behavior. Pass libtype: 'photo' to return individual photos instead.

Returns Promise<Photoalbum[]>
Example
```
const albums = await photoSection.all()
const photos = await photoSection.all({ libtype: 'photo', maxResults: 50 })
```
Overrides LibrarySection.all
- Defined in src/library.ts:3036
all(options: LibrarySectionAllOptions): Promise<LibrarySearchItem[]>
Returns photo library items.

Photo sections default to albums to match Plex's photo library behavior. Pass libtype: 'photo' to return individual photos instead.
Parameters
- options: LibrarySectionAllOptions
Returns Promise<LibrarySearchItem[]>
Example
```
const albums = await photoSection.all()
const photos = await photoSection.all({ libtype: 'photo', maxResults: 50 })
```
Overrides LibrarySection.all
- Defined in src/library.ts:3037

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>
Inherited from LibrarySection.analyze
- Defined in src/library.ts:1693

buildSearchKey

buildSearchKey(args?: Partial<SearchArgs>): Promise<string>
Build and validate a server-side search key for smart playlists and collections. Local-only filters are rejected because Plex cannot persist them in a smart filter.
Parameters
- args: Partial<SearchArgs> = {}
Returns Promise<string>
Inherited from LibrarySection.buildSearchKey
- Defined in src/library.ts:1677

cancelUpdate

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

Returns Promise<void>
Inherited from LibrarySection.cancelUpdate
- Defined in src/library.ts:1719

collection

collection(title: string): Promise<Collections<Photoalbum>>
Returns the collection with the exact title.
Parameters
- title: string
Returns Promise<Collections<Photoalbum>>
Inherited from LibrarySection.collection
- Defined in src/library.ts:1980

collections

collections(): Promise<Collections<Photoalbum>[]>
Photo libraries do not support collections.

Returns Promise<Collections<Photoalbum>[]>
Overrides LibrarySection.collections
- Defined in src/library.ts:3054

common

common(items: EditableLibraryItem | EditableLibraryItem[]): Promise<Common>
Returns fields common to all provided items.
Parameters
- items: EditableLibraryItem | EditableLibraryItem[]
Returns Promise<Common>
Inherited from LibrarySection.common
- Defined in src/library.ts:2166

continueWatching

continueWatching(): Promise<LibrarySearchItem[]>
Returns items from this library section's Continue Watching hub.

Returns Promise<LibrarySearchItem[]>
Inherited from LibrarySection.continueWatching
- Defined in src/library.ts:2013

createCollection

createCollection(
title: string,
items: RatingKeyItem[],
): Promise<Collections<Photoalbum>>
Create a regular collection in this library section.
Parameters
- title: string
- items: RatingKeyItem[]
Returns Promise<Collections<Photoalbum>>
Inherited from LibrarySection.createCollection
- Defined in src/library.ts:1957
createCollection(
    title: string,
    options:
        | Omit<CreateRegularCollectionOptions<RatingKeyItem>, "section">
        | Omit<CreateSmartCollectionOptions<RatingKeyItem>, "section">,
): Promise<Collections<Photoalbum>>
Create a regular collection in this library section.
Parameters
- title: string
- options:
  | Omit<CreateRegularCollectionOptions<RatingKeyItem>, "section">
  | Omit<CreateSmartCollectionOptions<RatingKeyItem>, "section">
Returns Promise<Collections<Photoalbum>>
Inherited from LibrarySection.createCollection
- Defined in src/library.ts:1958

createPlaylist

createPlaylist(
    title: string,
    options:
        | CreateRegularPlaylistOptions
        | Omit<CreateSmartPlaylistOptions, "section">,
): Promise<Playlist>
Create a regular or smart playlist scoped to this library section.
Parameters
- title: string
- options: CreateRegularPlaylistOptions | Omit<CreateSmartPlaylistOptions, "section">
Returns Promise<Playlist>
Inherited from LibrarySection.createPlaylist
- Defined in src/library.ts:1925

defaultAdvanced

defaultAdvanced(): Promise<Section>
Reset this library section's advanced preference settings to their defaults.

Returns Promise<Section>
Inherited from LibrarySection.defaultAdvanced
- Defined in src/library.ts:1818

delete

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

Returns Promise<void>
Inherited from LibrarySection.delete
- Defined in src/library.ts:1743

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>
Inherited from LibrarySection.deleteMediaPreviews
- Defined in src/library.ts:1737

edit

edit(__namedParameters?: LibrarySectionEditOptions): Promise<Section>
Edit this library section's agent, locations, or raw Plex preferences.

locations replaces the section's complete path list. To add or remove one path while preserving the rest, use addLocations or removeLocations.
Parameters
- __namedParameters: LibrarySectionEditOptions = {}
Returns Promise<Section>
Example
```
await movieSection.edit({
  agent: 'com.plexapp.agents.imdb',
  locations: ['/media/movies', '/media/archived-movies'],
  preferences: { includeInGlobal: true },
})
```
Inherited from LibrarySection.edit
- Defined in src/library.ts:1764

editAdvanced

editAdvanced(changes: SectionAdvancedSettings): Promise<Section>
Edit this library section's advanced preference settings.
Parameters
- changes: SectionAdvancedSettings
Returns Promise<Section>
Inherited from LibrarySection.editAdvanced
- Defined in src/library.ts:1798

emptyTrash

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

Returns Promise<void>
Inherited from LibrarySection.emptyTrash
- Defined in src/library.ts:1701

fieldTypes

fieldTypes(): Promise<FilteringFieldType[]>
Returns Promise<FilteringFieldType[]>
Inherited from LibrarySection.fieldTypes
- Defined in src/library.ts:2155

filterTypes

filterTypes(): Promise<FilteringType[]>
Returns Promise<FilteringType[]>
Inherited from LibrarySection.filterTypes
- Defined in src/library.ts:2147

firstCharacter

firstCharacter(): Promise<FirstCharacter[]>
Returns the list of first characters for items in this library section. This is the data used to populate the alphabet bar in the Plex UI.

Returns Promise<FirstCharacter[]>
Inherited from LibrarySection.firstCharacter
- Defined in src/library.ts:2045

folders

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

Returns Promise<Folder[]>
Inherited from LibrarySection.folders
- Defined in src/library.ts:1992

genres

genres(): Promise<FilterChoice[]>
Returns Promise<FilterChoice[]>
Inherited from LibrarySection.genres
- Defined in src/library.ts:1997

get

get<
    T extends
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
>(
    options: Omit<
        Partial<SearchArgs>,
        "limit" | "title" | "maxresults" | "libtype",
    > & {
        libtype?:
            | "track"
            | "artist"
            | "album"
            | "movie"
            | "show"
            | "season"
            | "episode"
            | "trailer"
            | "comic"
            | "person"
            | "picture"
            | "clip"
            | "photo"
            | "photoalbum"
            | "playlist"
            | "playlistFolder"
            | "collection"
            | "optimizedVersion"
            | "userPlaylistItem";
        title: string;
    } & { libtype: T },
): Promise<SearchClassForLibtype<T>>
Returns one item by exact title, optionally narrowed with normal search filters.

Use filters to disambiguate duplicate titles. When libtype is provided, the returned item is typed to that Plex model.
Type Parameters
- T extends
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"
Parameters
- options: Omit<Partial<SearchArgs>, "limit" | "title" | "maxresults" | "libtype"> & {
      libtype?:
          | "track"
          | "artist"
          | "album"
          | "movie"
          | "show"
          | "season"
          | "episode"
          | "trailer"
          | "comic"
          | "person"
          | "picture"
          | "clip"
          | "photo"
          | "photoalbum"
          | "playlist"
          | "playlistFolder"
          | "collection"
          | "optimizedVersion"
          | "userPlaylistItem";
      title: string;
  } & { libtype: T }
  - Optionallibtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem"
    
    Return a specific Plex item type instead of the section default.
  - title: string
    
    Exact item title to return.
  - libtype: T
Returns Promise<SearchClassForLibtype<T>>
Example
```
const movie = await movieSection.get({ title: 'Big Buck Bunny', year: 2008 })
const episode = await showSection.get({ title: 'Minimum Viable Product', libtype: 'episode' })
```
Inherited from LibrarySection.get
- Defined in src/library.ts:1561
get(options: LibrarySectionGetOptions): Promise<Photoalbum>
Returns one item by exact title, optionally narrowed with normal search filters.

Use filters to disambiguate duplicate titles. When libtype is provided, the returned item is typed to that Plex model.
Parameters
- options: LibrarySectionGetOptions
Returns Promise<Photoalbum>
Example
```
const movie = await movieSection.get({ title: 'Big Buck Bunny', year: 2008 })
const episode = await showSection.get({ title: 'Minimum Viable Product', libtype: 'episode' })
```
Inherited from LibrarySection.get
- Defined in src/library.ts:1564

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>
Inherited from LibrarySection.getFieldType
- Defined in src/library.ts:2075

getFilterType

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

getGuid

getGuid(guid: string): Promise<Photoalbum>
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<Photoalbum>
Inherited from LibrarySection.getGuid
- Defined in src/library.ts:1613

getWebURL

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

history

history(
__namedParameters?: LibrarySectionHistoryOptions,
): Promise<HistoryResult[]>
Get watched history for this library section.
Parameters
- __namedParameters: LibrarySectionHistoryOptions = {}
Returns Promise<HistoryResult[]>
Inherited from LibrarySection.history
- Defined in src/library.ts:1831

hubs

hubs(options?: LibrarySectionHubsOptions): Promise<Hub[]>
Parameters
- options: LibrarySectionHubsOptions = {}
Returns Promise<Hub[]>
Inherited from LibrarySection.hubs
- Defined in src/library.ts:1857

hubSearch

hubSearch(query: string, __namedParameters?: HubSearchOptions): Promise<Hub[]>
Returns section-scoped hub search results.
Parameters
- query: string
- __namedParameters: HubSearchOptions = {}
Returns Promise<Hub[]>
Inherited from LibrarySection.hubSearch
- Defined in src/library.ts:1869

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from LibrarySection.isChildOf
- Defined in src/base/plexObject.ts:61

listFields

listFields(
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "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:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem" = ...
Returns Promise<FilteringField[]>
Inherited from LibrarySection.listFields
- Defined in src/library.ts:2054

listFilterChoices

listFilterChoices(
    field: string | FilteringFilter,
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilterChoice[]>
Returns the available values for a custom filter field.
Parameters
- field: string | FilteringFilter
- Optionallibtype:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"
Returns Promise<FilterChoice[]>
Inherited from LibrarySection.listFilterChoices
- Defined in src/library.ts:2114

listFilters

listFilters(
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilteringFilter[]>
Parameters
- Optionallibtype:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "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)
```
Inherited from LibrarySection.listFilters
- Defined in src/library.ts:2100

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[]>
Inherited from LibrarySection.listOperators
- Defined in src/library.ts:2143

listSorts

listSorts(
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<FilteringSort[]>
Returns a list of available sorting fields for the specified libtype.
Parameters
- Optionallibtype:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem"
Returns Promise<FilteringSort[]>
Inherited from LibrarySection.listSorts
- Defined in src/library.ts:2107

lockAllField

lockAllField(
    field: string,
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<PhotoSection>
Lock a field for all items of a libtype in this library.
Parameters
- field: string
- libtype:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem" = ...
Returns Promise<PhotoSection>
Inherited from LibrarySection.lockAllField
- Defined in src/library.ts:2210

managedHubs

managedHubs(): Promise<ManagedHub[]>
Returns the managed recommendation hubs for this library section.

Returns Promise<ManagedHub[]>
Inherited from LibrarySection.managedHubs
- Defined in src/library.ts:1844

multiEdit

multiEdit(
items: EditableLibraryItem | EditableLibraryItem[],
changes: Record<string, string | number | boolean>,
): Promise<PhotoSection>
Edit multiple items at once using Plex field keys.
Parameters
- items: EditableLibraryItem | EditableLibraryItem[]
- changes: Record<string, string | number | boolean>
Returns Promise<PhotoSection>
Inherited from LibrarySection.multiEdit
- Defined in src/library.ts:2187

onDeck

onDeck(): Promise<Photoalbum[]>
Returns a list of items currently on deck (in progress) for this library section.

Returns Promise<Photoalbum[]>
Inherited from LibrarySection.onDeck
- Defined in src/library.ts:2005

playlist

playlist(title: string): Promise<Playlist>
Returns the playlist with the exact title.
Parameters
- title: string
Returns Promise<Playlist>
Inherited from LibrarySection.playlist
- Defined in src/library.ts:1939

playlists

playlists(args?: PlaylistSearchOptions): Promise<Playlist[]>
Returns a list of playlists from this library section.
Parameters
- args: PlaylistSearchOptions = {}
Returns Promise<Playlist[]>
Inherited from LibrarySection.playlists
- Defined in src/library.ts:1900

recentlyAdded

recentlyAdded(maxResults?: number): Promise<Photoalbum[]>
Returns recently added photo albums from this library section.
Parameters
- maxResults: number = 50
Returns Promise<Photoalbum[]>
Overrides LibrarySection.recentlyAdded
- Defined in src/library.ts:3082

recentlyAddedAlbums

recentlyAddedAlbums(maxResults?: number): Promise<Photoalbum[]>
Returns recently added photo albums from this library section.
Parameters
- maxResults: number = 50
Returns Promise<Photoalbum[]>
- Defined in src/library.ts:3069

recentlyAddedPhotos

recentlyAddedPhotos(maxResults?: number): Promise<Photo[]>
Returns recently added photos from this library section.
Parameters
- maxResults: number = 50
Returns Promise<Photo[]>
- Defined in src/library.ts:3077

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>
Inherited from LibrarySection.refresh
- Defined in src/library.ts:1728

reload

reload(ekey?: string): Promise<void>
Reload the data for this object from this.key.
Parameters
- Optionalekey: string
Returns Promise<void>
Inherited from LibrarySection.reload
- Defined in src/base/plexObject.ts:36

removeLocations

removeLocations(locations: string | string[]): Promise<Section>
Remove file paths from the library section.
Parameters
- locations: string | string[]
  One or more file paths to remove.
Returns Promise<Section>
Inherited from LibrarySection.removeLocations
- Defined in src/library.ts:1487

resetManagedHubs

resetManagedHubs(): Promise<void>
Reset managed hub customizations for this library section.

Returns Promise<void>
Inherited from LibrarySection.resetManagedHubs
- Defined in src/library.ts:1852

search

search<C = Photoalbum>(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 = Photoalbum
Parameters
- args: Partial<SearchArgs> = {}
  Search using a number of different attributes
- OptionalCls: Class<C>
Returns Promise<C[]>
Inherited from LibrarySection.search
- Defined in src/library.ts:1662

searchAlbums

searchAlbums(args?: Partial<SearchArgs>): Promise<Photoalbum[]>
Search for a photo album.
Parameters
- args: Partial<SearchArgs> = {}
Returns Promise<Photoalbum[]>
- Defined in src/library.ts:3059

searchPhotos

searchPhotos(args?: Partial<SearchArgs>): Promise<Photo[]>
Search for a photo.
Parameters
- args: Partial<SearchArgs> = {}
Returns Promise<Photo[]>
- Defined in src/library.ts:3064

settings

settings(): Promise<Setting[]>
Returns the advanced preference settings for this library section.

Returns Promise<Setting[]>
Inherited from LibrarySection.settings
- Defined in src/library.ts:1539

timeline

timeline(): Promise<LibraryTimeline>
Returns the current library section timeline status.

Returns Promise<LibraryTimeline>
Inherited from LibrarySection.timeline
- Defined in src/library.ts:1891

totalDuration

totalDuration(): Promise<number>
Returns the total duration of all items in the library in milliseconds, or null if unavailable.

Returns Promise<number>
Inherited from LibrarySection.totalDuration
- Defined in src/library.ts:1461

totalSize

totalSize(): Promise<number>
Returns the total number of items in the library, excluding collections.

Returns Promise<number>
Inherited from LibrarySection.totalSize
- Defined in src/library.ts:1454

totalStorage

totalStorage(): Promise<number>
Returns the total storage size of all items in the library in bytes, or null if unavailable.

Returns Promise<number>
Inherited from LibrarySection.totalStorage
- Defined in src/library.ts:1468

totalViewSize

totalViewSize(
options?: { includeCollections?: boolean; libtype?: string },
): Promise<number>
Returns the total number of items in the library. Queries the library without fetching any items to get the total count.
Parameters
- Optionaloptions: { includeCollections?: boolean; libtype?: string }
  - OptionalincludeCollections?: boolean
    
    Whether to include collections in the count. Default true.
  - Optionallibtype?: string
    
    Filter by a specific library type (movie, show, episode, etc.).
Returns Promise<number>
Inherited from LibrarySection.totalViewSize
- Defined in src/library.ts:1434

unlockAllField

unlockAllField(
    field: string,
    libtype?:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem",
): Promise<PhotoSection>
Unlock a field for all items of a libtype in this library.
Parameters
- field: string
- libtype:
      | "track"
      | "artist"
      | "album"
      | "movie"
      | "show"
      | "season"
      | "episode"
      | "trailer"
      | "comic"
      | "person"
      | "picture"
      | "clip"
      | "photo"
      | "photoalbum"
      | "playlist"
      | "playlistFolder"
      | "collection"
      | "optimizedVersion"
      | "userPlaylistItem" = ...
Returns Promise<PhotoSection>
Inherited from LibrarySection.unlockAllField
- Defined in src/library.ts:2217

update

update(__namedParameters?: LibrarySectionUpdateOptions): Promise<void>
Scan this section for new media.
Parameters
- __namedParameters: LibrarySectionUpdateOptions = {}
Returns Promise<void>
Inherited from LibrarySection.update
- Defined in src/library.ts:1709

Class PhotoSection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PhotoSection

Properties

Optional_fieldTypes

Optional_filterTypes

agent

allowSync

art

composite

CONTENT_TYPE

createdAt

filters

key

language

locations

METADATA_TYPE

Optional Readonlyparent

refreshing

scannedAt

scanner

ReadonlySECTION_TYPE

Readonlyserver

thumb

title

type

updatedAt

uuid

StaticALLOWED_FILTERS

StaticALLOWED_SORT

StaticBOOLEAN_FILTERS

StaticTAG

StaticTYPE

Methods

addLocations

Parameters

Returns Promise<Section>

agents

Returns Promise<Agent[]>

all

Type Parameters

Parameters

Optionallibtype?: | "track" | "artist" | "album" | "movie" | "show" | "season" | "episode" | "trailer" | "comic" | "person" | "picture" | "clip" | "photo" | "photoalbum" | "playlist" | "playlistFolder" | "collection" | "optimizedVersion" | "userPlaylistItem"

OptionalmaxResults?: number

libtype: T

Returns Promise<SearchClassForLibtype<T>[]>

Example

Returns Promise<Photoalbum[]>

Example

Parameters

Returns Promise<LibrarySearchItem[]>

Example

analyze

Returns Promise<void>

buildSearchKey

Parameters

Returns Promise<string>

cancelUpdate

Returns Promise<void>

collection

Parameters

Returns Promise<Collections<Photoalbum>>

collections

Returns Promise<Collections<Photoalbum>[]>

common

Parameters

Returns Promise<Common>

continueWatching

Returns Promise<LibrarySearchItem[]>

createCollection

Parameters

Returns Promise<Collections<Photoalbum>>

Parameters

`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

`Optional`libtype?:
| "track"
| "artist"
| "album"
| "movie"
| "show"
| "season"
| "episode"
| "trailer"
| "comic"
| "person"
| "picture"
| "clip"
| "photo"
| "photoalbum"
| "playlist"
| "playlistFolder"
| "collection"
| "optimizedVersion"
| "userPlaylistItem"

`Optional`maxResults?: number

`Optional`libtype?:
| "track"
| "artist"
| "album"
| "movie"
| "show"
| "season"
| "episode"
| "trailer"
| "comic"
| "person"
| "picture"
| "clip"
| "photo"
| "photoalbum"
| "playlist"
| "playlistFolder"
| "collection"
| "optimizedVersion"
| "userPlaylistItem"

`Optional`base?: string

`Optional`key?: string

`Optional`tab?: string