Struct plex_api::MyPlexAccount

pub struct MyPlexAccount { /* fields omitted */ }

Methods

impl MyPlexAccount

pub async fn login<'_, '_>(username: &'_ str, password: &'_ str) -> Result<Self>

Log in to MyPlex using username and password.

pub async fn by_token<'_>(auth_token: &'_ str) -> Result<Self>

Log in to MyPlex using existing authentication token.

impl MyPlexAccount

pub async fn get_claim_token<'_>(&'_ self) -> Result<String>

Returns a token which can help you to claim freshly installed Plex Server.

See https://www.plex.tv/claim, docker:plexinc/pms-docker.

impl MyPlexAccount

pub async fn get_devices<'_>(&'_ self) -> Result<Vec<Device>>

Returns the list of devices (players and servers), registered with current MyPlex account.

impl MyPlexAccount

pub async fn get_privacy<'_>(&'_ self) -> Result<Privacy>

Returns current privacy settings, see Privacy Preferences on plex.tv.

pub async fn set_privacy<'_>(
    &'_ self,
    opt_out_playback: bool,
    opt_out_library_stats: bool
) -> Result<()>

Changes privacy settings, see Privacy Preferences on plex.tv.

impl MyPlexAccount

pub async fn get_resources<'_>(&'_ self) -> Result<Vec<Device>>

Returns the list of resources, registered with current MyPlex account.

Resource is any available device, despite of its provides setting.

impl MyPlexAccount

pub async fn get_users<'_>(&'_ self) -> Result<Vec<User>>

Returns a list of users, who has access to the current server, except the owner.

impl MyPlexAccount

pub async fn get_webhooks<'_>(&'_ self) -> Result<Vec<String>>

Returns a list of URLs for currently registered WebHooks.

pub async fn set_webhooks<'_, '_, '_>(
    &'_ self,
    webhooks: &'_ [&'_ str]
) -> Result<()>

Sets a list of WebHooks to provided URLs list.

pub async fn add_webhook<'_, '_>(&'_ self, webhook: &'_ str) -> Result<()>

Add an URL to webhooks list.

pub async fn del_webhook<'_, '_>(&'_ self, webhook: &'_ str) -> Result<()>

Deletes provided URL from webhooks list.

impl MyPlexAccount

pub fn get_username(&self) -> String

Return username which was used to log in to MyPlex.

Trait Implementations

impl Debug for MyPlexAccount

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MyPlexAccount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl HasMyPlexToken for MyPlexAccount

fn get_auth_token(&self) -> &str

Returns authentication token for current account.

fn set_auth_token(&mut self, auth_token: &str)

Sets authentication token for current account.