Struct PartnerLogin 

pub struct PartnerLogin {
    pub username: String,
    pub password: String,
    pub device_model: String,
    pub version: String,
    pub optional: HashMap<String, Value>,
}

This request additionally serves as API version validation, time synchronization and endpoint detection and must be sent over a TLS-encrypted link. The POST body however is not encrypted.

| Name | Type | Description | | username | string | See Partner passwords | | password | string | See Partner passwords | | deviceModel | string | See Partner passwords | | version | string | Current version number, “5”. | | includeUrls | boolean | | | returnDeviceType | boolean | | | returnUpdatePromptVersions | boolean | |

{
    "username": "pandora one",
    "password": "TVCKIBGS9AO9TSYLNNFUML0743LH82D",
    "deviceModel": "D01",
    "version": "5"
}

Fields

username: String

The partner login name (not the account-holder’s username) used to authenticate the application with the Pandora service.

password: String

The partner login password (not the account-holder’s username) used to authenticate the application with the Pandora service.

device_model: String

The partner device model name.

version: String

The Pandora JSON API version

optional: HashMap<String, Value>

Optional parameters on the call

Implementations

impl PartnerLogin

pub fn new( username: &str, password: &str, device_model: &str, version: Option<String>, ) -> Self

Create a new PartnerLogin with some values. All Optional fields are set to None.

pub fn and_boolean_option(self, option: &str, value: bool) -> Self

Convenience function for setting boolean flags in the request. (Chaining call)

pub fn include_urls(self, value: bool) -> Self

Whether to request to include urls in the response. (Chaining call)

pub fn return_device_type(self, value: bool) -> Self

Whether to request to include the device type in the response. (Chaining call)

pub fn return_update_prompt_versions(self, value: bool) -> Self

Whether to request to return a prompt to update versions in the response. (Chaining call)

pub async fn merge_response( &self, session: &mut PandoraSession, ) -> Result<PartnerLoginResponse, Error>

This is a wrapper around the response method from the PandoraJsonApiRequest trait that automatically merges the partner tokens from the response back into the session.

Trait Implementations

impl Clone for PartnerLogin

fn clone(&self) -> PartnerLogin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PartnerLogin

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

Formats the value using the given formatter.

impl PandoraJsonApiRequest for PartnerLogin

type Response = PartnerLoginResponse

The type that the json response will be deserialized to.

type Error = Error

The Error type to be returned by fallible calls on this trait.

fn encrypt_request(&self) -> bool

Whether the json body of the API call is expected to be encrypted before transmission.

fn get_method(&self) -> String

Returns the name of the Pandora JSON API call in the form that it must appear when making that call.

fn get_json(&self) -> Result<Value, Self::Error>

Returns the root json Value that should be serialized into the body of the API call.

fn request( &self, session: &PandoraSession, ) -> Result<RequestBuilder, Self::Error>

Generate an HTTP request that, when send() is called on it, will submit the built request.

fn response<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 mut PandoraSession, ) -> Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Build the request, submit it, and extract the response content from the body json, and deserialize it into the Self::Response type.

impl Serialize for PartnerLogin

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.