mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-10 04:20:58 +00:00
21 lines
6.7 KiB
Markdown
21 lines
6.7 KiB
Markdown
# Hub
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { Hub } from "@lukehagar/plexjs/models/operations";
|
|
|
|
let value: Hub = {};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `homeVisibility` | [operations.HomeVisibility](../../models/operations/homevisibility.md) | :heavy_minus_sign: | Whether this hub is visible on the home screen<br/> - all: Visible to all users<br/> - none: Visible to no users<br/> - admin: Visible to only admin users<br/> - shared: Visible to shared users<br/> |
|
|
| `identifier` | *string* | :heavy_minus_sign: | The identifier for this hub |
|
|
| `promotedToOwnHome` | *boolean* | :heavy_minus_sign: | Whether this hub is visible to admin user home |
|
|
| `promotedToRecommended` | *boolean* | :heavy_minus_sign: | Whether this hub is promoted to all for recommendations |
|
|
| `promotedToSharedHome` | *boolean* | :heavy_minus_sign: | Whether this hub is visible to shared user's home |
|
|
| `recommendationsVisibility` | [operations.RecommendationsVisibility](../../models/operations/recommendationsvisibility.md) | :heavy_minus_sign: | The visibility of this hub in recommendations:<br/> - all: Visible to all users<br/> - none: Visible to no users<br/> - admin: Visible to only admin users<br/> - shared: Visible to shared users<br/> |
|
|
| `title` | *string* | :heavy_minus_sign: | The title of this hub | |