Struct GetStationList

pub struct GetStationList {
    pub optional: HashMap<String, Value>,
}

| Name | Type | Description | | includeStationArtUrl | boolean | Includes “artUrl” field in result (optional) | | stationArtSize | string | “W130H130” (optional) | | includeAdAttributes | boolean | (optional) | | includeStationSeeds | boolean | (optional) | | includeShuffleInsteadOfQuickMix | boolean | (optional) | | includeRecommendations | boolean | (optional) | | includeExplanations | boolean | (optional) |

{
   "userAuthToken": "XXX",
   "syncTime": XXX
}

Fields

optional: HashMap<String, Value>

Optional parameters on the call

Implementations

impl GetStationList

pub fn new() -> Self

Create a new GetStationList 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 and_string_option(self, option: &str, value: &str) -> Self

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

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

Whether to include station art url in the response. (Chaining call)

pub fn station_art_size(self, value: &str) -> Self

The size of the station art image to include in the response. (Chaining call)

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

Whether to include ad attributes in the response. (Chaining call)

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

Whether to include station seeds in the response. (Chaining call)

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

Whether to include shuffle stations instead of quickmix in the response. (Chaining call)

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

Whether to include recommendations in the response. (Chaining call)

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

Whether to include explanations in the response. (Chaining call)

Trait Implementations

impl Clone for GetStationList

fn clone(&self) -> GetStationList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetStationList

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

Formats the value using the given formatter.

impl Default for GetStationList

fn default() -> GetStationList

Returns the “default value” for a type.

impl PandoraJsonApiRequest for GetStationList

type Response = GetStationListResponse

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: &mut 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 GetStationList

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

where __S: Serializer,

Serialize this value into the given Serde serializer.