Struct GetPlaylist 

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

This method must be sent over a TLS-encrypted connection.

| Name | Type | Description | | stationToken | string | station token from Retrieve station list | | additionalAudioUrl | string | Comma separated list of additional audio formats to return. (optional) | | stationIsStarting | boolean | (optional) | | includeTrackLength | boolean | (optional) | | includeAudioToken | boolean | (optional) | | xplatformAdCapable | boolean | (optional) | | includeAudioReceiptUrl | boolean | (optional) | | includeBackstageAdUrl | boolean | (optional) | | includeSharingAdUrl | boolean | (optional) | | includeSocialAdUrl | boolean | (optional) | | includeCompetitiveSepIndicator | boolean | (optional) | | includeCompletePlaylist | boolean | (optional) | | includeTrackOptions | boolean | (optional) | | audioAdPodCapable | boolean | (optional) |

Valid values for additionalAudioUrl are:

• HTTP_40_AAC_MONO
• HTTP_64_AAC
• HTTP_32_AACPLUS
• HTTP_64_AACPLUS
• HTTP_24_AACPLUS_ADTS
• HTTP_32_AACPLUS_ADTS
• HTTP_64_AACPLUS_ADTS
• HTTP_128_MP3
• HTTP_32_WMA

Usually a playlist contains four tracks.

{
     "userAuthToken": "XXX",
     "additionalAudioUrl":  "HTTP_32_AACPLUS_ADTS,HTTP_64_AACPLUS_ADTS",
     "syncTime": 1335841463,
     "stationToken": "121193154444133035"
}

Fields

station_token: String

The unique id (token) for the station to request a playlist from

optional: HashMap<String, Value>

Optional parameters on the call

Implementations

impl GetPlaylist

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

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

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

Additional (non-default) audio formats that should be included in the response. Repeat call to include additional formats. (Chaining call)

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

Whether request should also mark the station as starting. (Chaining call)

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

Whether playlist entries should include the track length in the response. (Chaining call)

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

Whether playlist entries should include the audio token in the response. (Chaining call)

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

Whether the client is cross-platform ad capable. (Chaining call)

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

Whether to include audio receipt url in the response. (Chaining call)

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

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

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

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

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

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

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

Whether to include competitive sep indicator in the response. (Chaining call)

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

Whether to include complete playlist in the response. (Chaining call)

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

Whether to include track options in the response. (Chaining call)

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

Indicate to Pandora whether the client is audio ad pod capable. (Chaining call)

Trait Implementations

impl Clone for GetPlaylist

fn clone(&self) -> GetPlaylist

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetPlaylist

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

Formats the value using the given formatter.

impl<TS: ToString> From<&TS> for GetPlaylist

fn from(station_token: &TS) -> Self

Converts to this type from the input type.

impl PandoraJsonApiRequest for GetPlaylist

type Response = GetPlaylistResponse

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 GetPlaylist

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

where __S: Serializer,

Serialize this value into the given Serde serializer.