Optionalusername: stringYour MyPlex username
Optionalpassword: stringYour MyPlex password
Optionaltoken: stringToken used to access this client.
timeout in seconds on initial connect to myplex
Optionalserver: PlexServernot often available
Optionalauthenticationauth token for user by plex
OptionalcertificateUnknown
OptionalemailYour current Plex email address
OptionalentitlementsList of devices your allowed to use with this account
OptionalguestUnknown
OptionalhomeUnknown
OptionalhomeUnknown
OptionalidYour Plex account ID
OptionallocaleYour Plex locale
OptionalmailingOptionalmailingYour current mailing list status.
OptionalmaxUnknown
OptionalpasswordYour MyPlex password
OptionalqueueEmail address to add items to your Watch Later queue.
OptionalrestrictedUnknown
OptionalscrobbleDescription
Optionalservernot often available
OptionalsubscriptionTrue if your subsctiption is active
OptionalsubscriptionList of features allowed on your subscription
OptionalsubscriptionName of subscription plan
OptionalsubscriptionString representation of subscriptionActive
OptionalthumbURL of your account thumbnail
timeout in seconds on initial connect to myplex
OptionaltitleUnknown. - Looks like an alias for username
OptionaltokenToken used to access this client.
OptionalusernameYour MyPlex username
OptionaluuidUnknown
Statickeypass token from claimToken
Returns a str, a new "claim-token", which you can use to register your new Plex Server instance to your account.
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.
Name to match against.
OptionalclientId: stringclientIdentifier to match against.
Returns a list of all :class:~plexapi.myplex.MyPlexDevice objects connected to the server.
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
Optionalheaders: anyOptionalusername: stringOptionalpassword: stringReturns the :class:~plexapi.myplex.MyPlexResource that matches the name specified.
StaticgetThis 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().
StaticwebPass 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.
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.