mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
22 KiB
22 KiB
GetAllLibrariesDirectory
Example Usage
import { GetAllLibrariesDirectory, GetAllLibrariesType, Hidden } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesDirectory = {
allowSync: false,
art: "/:/resources/show-fanart.jpg",
composite: "/library/sections/1/composite/1743824484",
filters: true,
refreshing: true,
thumb: "/:/resources/show.png",
key: "1",
type: GetAllLibrariesType.Movie,
title: "Movies",
agent: "tv.plex.agents.movie",
scanner: "Plex Movie",
language: "en-US",
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
updatedAt: 1556281940,
createdAt: 1556281940,
scannedAt: 1556281940,
content: true,
directory: true,
contentChangedAt: 9173960,
hidden: Hidden.ExcludeHomeScreen,
location: [],
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
allowSync |
boolean | ✔️ | Indicates whether syncing is allowed. | false |
art |
string | ✔️ | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
composite |
string | ✔️ | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
filters |
boolean | ✔️ | UNKNOWN | true |
refreshing |
boolean | ✔️ | Indicates whether the library is currently being refreshed or updated | true |
thumb |
string | ✔️ | URL for the thumbnail image of the media container. | /:/resources/show.png |
key |
string | ✔️ | The library key representing the unique identifier | 1 |
type |
operations.GetAllLibrariesType | ✔️ | N/A | movie |
title |
string | ✔️ | The title of the library | Movies |
agent |
string | ✔️ | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
scanner |
string | ✔️ | UNKNOWN | Plex Movie |
language |
string | ✔️ | The Plex library language that has been set | en-US |
uuid |
string | ✔️ | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
updatedAt |
number | ✔️ | Unix epoch datetime in seconds | 1556281940 |
createdAt |
number | ➖ | N/A | 1556281940 |
scannedAt |
number | ✔️ | Unix epoch datetime in seconds | 1556281940 |
content |
boolean | ✔️ | UNKNOWN | true |
directory |
boolean | ✔️ | UNKNOWN | true |
contentChangedAt |
number | ✔️ | Timestamp (in seconds) representing the last time the content was modified. NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64 |
9173960 |
hidden |
operations.Hidden | ➖ | The Plex library visibility setting | 1 |
location |
operations.GetAllLibrariesLocation[] | ✔️ | N/A |