Account | perplexed - v5.19.0

A plex.tv account

class: Account
param: Plex auth token

Hierarchy

Account

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Account(client: Client, authToken?: string): Account

- Defined in account.ts:21
Parameters
- client: Client
- Optional authToken: string
Returns Account

Properties

authToken

authToken: string

client

client: Client

Methods

authenticate

authenticate(username: string, password: string): Promise<User>

- Defined in account.ts:83
Log in to a Plex account

Parameters
- username: string
- password: string
Returns Promise<User>
- User info

checkPin

checkPin(pinId: string): Promise<Pin>

- Defined in account.ts:112
Parameters
- pinId: string
Returns Promise<Pin>

devices

devices(): Promise<Device[]>

- Defined in account.ts:174
Fetch a list of devices attached to an account

Returns Promise<Device[]>

Private fetch

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

- Defined in account.ts:47
Make a JSON request to the Plex.tv API

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

Private fetchXML

fetchXML(path: string, options?: RequestOptions): Promise<unknown>

- Defined in account.ts:64
Make an XML request to the Plex.tv API

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

Private headers

headers(): Record<string, string>

- Defined in account.ts:34
Headers we need to send to Plex whenever we make a request

Returns Record<string, string>

info

info(): Promise<User>

- Defined in account.ts:127
Fetch information about the currently logged in user

Returns Promise<User>

removeDevice

removeDevice(deviceId: string): Promise<boolean>

- Defined in account.ts:183
Remove a device from the account

Parameters
- deviceId: string
Returns Promise<boolean>

removeSyncItem

removeSyncItem(deviceId: string, syncItemId: string): Promise<boolean>

- Defined in account.ts:203
Remove an item from the sync list

Parameters
- deviceId: string
- syncItemId: string
Returns Promise<boolean>

requestPin

requestPin(): Promise<Pin>

- Defined in account.ts:106
Returns Promise<Pin>

resources

resources(): Promise<ResourceContainer>

- Defined in account.ts:142
Fetch a list of servers and clients connected to this plex account. Useful for figuring out which server to connect to.

Note: this API doesn't support JSON at the moment, so we need to parse the response as XML.

Returns Promise<ResourceContainer>

servers

servers(): Promise<object>

- Defined in account.ts:158
Fetch a list of all the servers

Returns Promise<object>

syncItems

syncItems(deviceId: string): Promise<object>

- Defined in account.ts:194
Fetch a list of items that are syncing to a device

Parameters
- deviceId: string
Returns Promise<object>

Generated using TypeDoc