mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-07 20:47:49 +00:00
57 lines
22 KiB
Markdown
57 lines
22 KiB
Markdown
# GetAllLibrariesDirectory
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
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* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
|
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
|
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
|
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
|
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
|
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
|
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
|
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
|
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
|
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
|
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
|
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
|
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
|
| `contentChangedAt` | *number* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
|
| `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
|
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | | |