ServerConnection | perplexed - v5.19.0

A connection to a Plex server

Hierarchy

ServerConnection

Index

Constructors

constructor

Properties

parent
uri

Methods

Constructors

constructor

new ServerConnection(uri: string, parent?: Parent): ServerConnection

- Defined in server-connection.ts:14
Parameters
- uri: string
- Optional parent: Parent
Returns ServerConnection

Properties

parent

parent: Parent

uri

uri: string

Methods

fetch

fetch(path: string, options?: RequestOptions): Promise<any>

- Defined in server-connection.ts:54
Fetch a path on this server as JSON. If the response is not JSON, it will return a promise of the response.

Parameters
- path: string
- Default value options: RequestOptions = {}
Returns Promise<any>

getAuthenticatedUrl

getAuthenticatedUrl(path: string, params?: Params): string

- Defined in server-connection.ts:42
Given a path, return a fully qualified URL Includes the X-Plex-Token parameter in the URL

Parameters
- path: string
- Default value params: Params = {}
Returns string

getUrl

getUrl(path: string, params?: Params): string

- Defined in server-connection.ts:33
Given a path, return a fully qualified URL

Parameters
- path: string
- Default value params: Params = {}
Returns string

headers

headers(): object

- Defined in server-connection.ts:25
Get headers

Returns object

Generated using TypeDoc