mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
29 lines
3.3 KiB
Markdown
29 lines
3.3 KiB
Markdown
# Connections
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: Connections = {
|
|
protocol: Protocol.Http,
|
|
address: "84577 W 9th Street",
|
|
port: 610910,
|
|
uri: "https://dearest-custom.net",
|
|
local: true,
|
|
relay: true,
|
|
iPv6: true,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
| `protocol` | [operations.Protocol](../../../sdk/models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
|
|
| `address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection | |
|
|
| `port` | *number* | :heavy_check_mark: | The port used for the connection | |
|
|
| `uri` | *string* | :heavy_check_mark: | The full URI of the connection | |
|
|
| `local` | *boolean* | :heavy_check_mark: | If the connection is local address | |
|
|
| `relay` | *boolean* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
|
| `iPv6` | *boolean* | :heavy_check_mark: | If the connection is using IPv6 | | |