mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-07 04:20:49 +00:00
44 lines
11 KiB
Markdown
44 lines
11 KiB
Markdown
# LibrarySection
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { LibrarySection, MediaTypeString } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: LibrarySection = {
|
|
title: "Movies",
|
|
type: MediaTypeString.Movie,
|
|
contentChangedAt: 1556281940,
|
|
createdAt: 1556281940,
|
|
language: "<value>",
|
|
uuid: "e69655a2-ef48-4aba-bb19-d3cc3401e7d6",
|
|
scannedAt: 1556281940,
|
|
updatedAt: 1556281940,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
| `title` | *string* | :heavy_minus_sign: | The title of the library | Movies |
|
|
| `type` | [shared.MediaTypeString](../../models/shared/mediatypestring.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
|
| `agent` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `art` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `composite` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `content` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `contentChangedAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
|
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
|
| `directory` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `filters` | *boolean* | :heavy_minus_sign: | Indicates whether this section has filtering capabilities | |
|
|
| `hidden` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `key` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `language` | *string* | :heavy_check_mark: | N/A | |
|
|
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-d3cc3401e7d6 |
|
|
| `location` | [shared.LibrarySectionLocation](../../models/shared/librarysectionlocation.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `refreshing` | *boolean* | :heavy_minus_sign: | Indicates whether this library section is currently scanning | |
|
|
| `scannedAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
|
| `scanner` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 | |