Class MyPlexAccount

MyPlex account and profile information. This object represents the data found Account on the myplex.tv servers at the url https://plex.tv/users/account. You may create this object directly by passing in your username & password (or token). There is also a convenience method provided at :class:~plexapi.server.PlexServer.myPlexAccount() which will create and return this object.

Constructors

constructor

new MyPlexAccount(
    options?: {
        baseUrl?: string;
        password?: string;
        server?: PlexServer;
        timeout?: number;
        token?: string;
        username?: string;
    },
): MyPlexAccount
Parameters
- options: {
      baseUrl?: string;
      password?: string;
      server?: PlexServer;
      timeout?: number;
      token?: string;
      username?: string;
  } = {}
  Connection + auth options.
Returns MyPlexAccount
- Defined in src/myplex.ts:178

Properties

`Optional`authenticationToken

authenticationToken?: string

auth token for user by plex

baseUrl

baseUrl: string = null

`Optional`certificateVersion

certificateVersion?: number

Unknown

`Optional`email

email?: string

Your current Plex email address

`Optional`entitlements

entitlements?: string[]

List of devices your allowed to use with this account

EXISTINGUSER

EXISTINGUSER: string = 'https://plex.tv/api/home/users?invitedEmail={username}'

FRIENDINVITE

FRIENDINVITE: string = 'https://plex.tv/api/servers/{machineId}/shared_servers'

FRIENDSERVERS

FRIENDSERVERS: string = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}'

FRIENDUPDATE

FRIENDUPDATE: string = 'https://plex.tv/api/friends/{userId}'

`Optional`guest

guest?: boolean

Unknown

`Optional`home

home?: boolean

Unknown

`Optional`homeSize

homeSize?: number

Unknown

HOMEUSERCREATE

HOMEUSERCREATE: string = 'https://plex.tv/api/home/users?title={title}'

`Optional`id

id?: number

Your Plex account ID

`Optional`locale

locale?: string

Your Plex locale

`Optional`mailingListActive

mailingListActive?: boolean

`Optional`mailingListStatus

mailingListStatus?: "active" | "inactive"

Your current mailing list status.

`Optional`maxHomeSize

maxHomeSize?: number

Unknown

`Optional`password

password?: string

PLEXSERVERS

PLEXSERVERS: string = 'https://plex.tv/api/servers/{machineId}'

`Optional`queueEmail

queueEmail?: string

Email address to add items to your Watch Later queue.

REMOVEHOMEUSER

REMOVEHOMEUSER: string = 'https://plex.tv/api/home/users/{userId}'

REMOVEINVITE

REMOVEINVITE: string = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0'

REQUESTED

REQUESTED: string = 'https://plex.tv/api/invites/requested'

REQUESTS

REQUESTS: string = 'https://plex.tv/api/invites/requests'

`Optional`restricted

restricted?: boolean

Unknown

`Optional`scrobbleTypes

scrobbleTypes?: string

Description

`Optional`server

server?: PlexServer

SIGNIN: string = 'https://plex.tv/users/sign_in.json'

`Optional`subscriptionActive

subscriptionActive?: boolean

True if your subsctiption is active

`Optional`subscriptionFeatures

subscriptionFeatures?: string[]

List of features allowed on your subscription

`Optional`subscriptionPlan

subscriptionPlan?: string

Name of subscription plan

`Optional`subscriptionStatus

subscriptionStatus?: "active" | "inactive"

String representation of subscriptionActive

`Optional`thumb

thumb?: string

URL of your account thumbnail

timeout

timeout: number = TIMEOUT

`Optional`title

title?: string

Unknown. - Looks like an alias for username

`Optional`token

token?: string

`Optional`username

username?: string

`Optional`uuid

uuid?: string

Unknown

WEBHOOKS

WEBHOOKS: string = 'https://plex.tv/api/v2/user/webhooks'

`Static`key

key: string = 'https://plex.tv/api/v2/user'

Methods

_headers

_headers(): Record<string, string>
Returns Record<string, string>
- Defined in src/myplex.ts:362

claimServer

claimServer(token: string): Promise<any>
Parameters
- token: string
  pass token from claimToken
Returns Promise<any>
- Defined in src/myplex.ts:348

claimToken

claimToken(): Promise<string>
Returns a str, a new "claim-token", which you can use to register your new Plex Server instance to your account.

Returns Promise<string>
Link
https://hub.docker.com/r/plexinc/pms-docker/

Link
https://www.plex.tv/claim/
- Defined in src/myplex.ts:339

connect

connect(): Promise<MyPlexAccount>
Returns a new :class:~server.PlexServer or :class:~client.PlexClient object. Often times there is more than one address specified for a server or client. This function will prioritize local connections before remote and HTTPS before HTTP. After trying to connect to all available addresses for this resource and assuming at least one connection was successful, the PlexServer object is built and returned.

Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:224

device

device(name?: string, clientId?: string): Promise<MyPlexDevice>
Parameters
- name: string = ''
  Name to match against.
- OptionalclientId: string
  clientIdentifier to match against.
Returns Promise<MyPlexDevice>
- Defined in src/myplex.ts:258

devices

devices(): Promise<MyPlexDevice[]>
Returns a list of all :class:~plexapi.myplex.MyPlexDevice objects connected to the server.

Returns Promise<MyPlexDevice[]>
- Defined in src/myplex.ts:274

query

query<T = any>(
    path: {
        headers?: any;
        method?: "put" | "get" | "post" | "patch" | "head" | "delete";
        password?: string;
        url: string;
        username?: string;
    },
): Promise<T>
Main method used to handle HTTPS requests to the Plex client. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. TODO: use headers
Type Parameters
- T = any
Parameters
- path: {
      headers?: any;
      method?: "put" | "get" | "post" | "patch" | "head" | "delete";
      password?: string;
      url: string;
      username?: string;
  }
Returns Promise<T>
- Defined in src/myplex.ts:289

resource

resource(name: string): Promise<MyPlexResource>
Returns the :class:~plexapi.myplex.MyPlexResource that matches the name specified.
Parameters
- name: string
Returns Promise<MyPlexResource>
- Defined in src/myplex.ts:239

resources

resources(): Promise<MyPlexResource[]>
Returns Promise<MyPlexResource[]>
- Defined in src/myplex.ts:249

`Static`getWebLogin

getWebLogin(forwardUrl?: string): Promise<WebLogin>
This follows the outline described in https://forums.plex.tv/t/authenticating-with-plex/609370 to fetch a token and potentially compromise username and password. To use first call getWebLogin() and present the returned uri to a user to go to, then await webLoginCheck(). If you pass in a forwardUrl, then send the user to the returned uri, and when a request comes in on the passed in url, then await webLoginCheck().
Parameters
- forwardUrl: string = null
Returns Promise<WebLogin>
- Defined in src/myplex.ts:37

`Static`webLoginCheck

webLoginCheck(
webLogin: WebLogin,
__namedParameters?: { timeoutSeconds?: number },
): Promise<MyPlexAccount>
Pass in the webLogin object obtained from getWebLogin() and this will poll Plex to see if the user agreed. It returns a connected MyPlexAccount or throws an error.
Parameters
- webLogin: WebLogin
- __namedParameters: { timeoutSeconds?: number } = {}
Returns Promise<MyPlexAccount>
- Defined in src/myplex.ts:67

Class MyPlexAccount

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MyPlexAccount

Properties

OptionalauthenticationToken

baseUrl

OptionalcertificateVersion

Optionalemail

Optionalentitlements

EXISTINGUSER

FRIENDINVITE

FRIENDSERVERS

FRIENDUPDATE

Optionalguest

Optionalhome

OptionalhomeSize

HOMEUSERCREATE

Optionalid

Optionallocale

OptionalmailingListActive

OptionalmailingListStatus

OptionalmaxHomeSize

Optionalpassword

PLEXSERVERS

OptionalqueueEmail

REMOVEHOMEUSER

REMOVEINVITE

REQUESTED

REQUESTS

Optionalrestricted

OptionalscrobbleTypes

Optionalserver

SIGNIN

OptionalsubscriptionActive

OptionalsubscriptionFeatures

OptionalsubscriptionPlan

OptionalsubscriptionStatus

Optionalthumb

timeout

Optionaltitle

Optionaltoken

Optionalusername

Optionaluuid

WEBHOOKS

Statickey

Methods

_headers

Returns Record<string, string>

claimServer

Parameters

Returns Promise<any>

claimToken

Returns Promise<string>

Link

Link

connect

Returns Promise<MyPlexAccount>

device

Parameters

Returns Promise<MyPlexDevice>

devices

Returns Promise<MyPlexDevice[]>

query

Type Parameters

Parameters

Returns Promise<T>

resource

Parameters

Returns Promise<MyPlexResource>

resources

Returns Promise<MyPlexResource[]>

StaticgetWebLogin

Parameters

Returns Promise<WebLogin>

`Optional`authenticationToken

`Optional`certificateVersion

`Optional`email

`Optional`entitlements

`Optional`guest

`Optional`home

`Optional`homeSize

`Optional`id

`Optional`locale

`Optional`mailingListActive

`Optional`mailingListStatus

`Optional`maxHomeSize

`Optional`password

`Optional`queueEmail

`Optional`restricted

`Optional`scrobbleTypes

`Optional`server

`Optional`subscriptionActive

`Optional`subscriptionFeatures

`Optional`subscriptionPlan

`Optional`subscriptionStatus

`Optional`thumb

`Optional`title

`Optional`token

`Optional`username

`Optional`uuid

`Static`key

`Static`getWebLogin

`Static`webLoginCheck