mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
73 lines
13 KiB
Markdown
73 lines
13 KiB
Markdown
# PlexDevice
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { PlexDevice, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: PlexDevice = {
|
|
name: "<value>",
|
|
product: "Incredible Steel Chair",
|
|
productVersion: "<value>",
|
|
platform: "<value>",
|
|
platformVersion: "<value>",
|
|
device: "Mobile",
|
|
clientIdentifier: "<value>",
|
|
createdAt: new Date("2019-06-24T11:38:02Z"),
|
|
lastSeenAt: new Date("2019-06-24T11:38:02Z"),
|
|
provides: "<value>",
|
|
ownerId: 341028,
|
|
sourceTitle: "<value>",
|
|
publicAddress: "<value>",
|
|
accessToken: "<value>",
|
|
owned: false,
|
|
home: false,
|
|
synced: false,
|
|
relay: false,
|
|
presence: false,
|
|
httpsRequired: false,
|
|
publicAddressMatches: false,
|
|
dnsRebindingProtection: false,
|
|
natLoopbackSupported: false,
|
|
connections: [
|
|
{
|
|
protocol: Protocol.Http,
|
|
address: "40779 Shields Turnpike",
|
|
port: 44844,
|
|
uri: "https://artistic-creator.org",
|
|
local: false,
|
|
relay: false,
|
|
iPv6: false,
|
|
},
|
|
],
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
| `name` | *string* | :heavy_check_mark: | N/A | |
|
|
| `product` | *string* | :heavy_check_mark: | N/A | |
|
|
| `productVersion` | *string* | :heavy_check_mark: | N/A | |
|
|
| `platform` | *string* | :heavy_check_mark: | N/A | |
|
|
| `platformVersion` | *string* | :heavy_check_mark: | N/A | |
|
|
| `device` | *string* | :heavy_check_mark: | N/A | |
|
|
| `clientIdentifier` | *string* | :heavy_check_mark: | N/A | |
|
|
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
|
|
| `lastSeenAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2019-06-24T11:38:02Z |
|
|
| `provides` | *string* | :heavy_check_mark: | N/A | |
|
|
| `ownerId` | *number* | :heavy_check_mark: | ownerId is null when the device is owned by the token used to send the request | |
|
|
| `sourceTitle` | *string* | :heavy_check_mark: | N/A | |
|
|
| `publicAddress` | *string* | :heavy_check_mark: | N/A | |
|
|
| `accessToken` | *string* | :heavy_check_mark: | N/A | |
|
|
| `owned` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `home` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `synced` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `relay` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `presence` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `httpsRequired` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `publicAddressMatches` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `dnsRebindingProtection` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `natLoopbackSupported` | *boolean* | :heavy_check_mark: | N/A | |
|
|
| `connections` | [operations.Connections](../../../sdk/models/operations/connections.md)[] | :heavy_check_mark: | N/A | | |