Struct PlaylistSearchQuery

pub struct PlaylistSearchQuery {

    pub q: String,
    pub page: Option<u32>,
    pub language: Option<String>,
    pub is_published: Option<bool>,
    pub author_id: Option<UserOrMe>,
    pub author_name: Option<String>,
    pub other_keywords: Option<String>,
    pub translated_keywords: Option<String>,
    pub privacy_level: Vec<PrivacyLevel>,
    pub page_limit: Option<u32>,
    pub age_ranges: Vec<AgeRangeId>,
    pub affiliations: Vec<AffiliationId>,
    pub resource_types: Vec<ResourceTypeId>,
    pub categories: Vec<CategoryId>,
    pub items: Vec<JigId>,
    pub is_rated: Option<bool>,
}

Search for Playlists via the given query string.

Fields

q: String

The query string.

page: Option<u32>

The page number of the Playlists to get.

language: Option<String>

Optionally filter by language

is_published: Option<bool>

Optionally filter by is_published. This means that the Playlist’s publish_at < now().

author_id: Option<UserOrMe>

Optionally filter by author’s id

author_name: Option<String>

Optionally filter by the author’s name

other_keywords: Option<String>

Optionally search for Playlists using keywords

translated_keywords: Option<String>

Optionally search for Playlists using translated keyword

privacy_level: Vec<PrivacyLevel>

Optionally search for Playlists by privacy level

page_limit: Option<u32>

The hits per page to be returned

age_ranges: Vec<AgeRangeId>

Optionally filter by age_ranges

Note: Currently does nothing

affiliations: Vec<AffiliationId>

Optionally filter by affiliations

Note: Currently does nothing

resource_types: Vec<ResourceTypeId>

Optionally filter by additional resources

categories: Vec<CategoryId>

Optionally filter by categories

items: Vec<JigId>

Optionally filter by items

is_rated: Option<bool>

Optionally filter playlists based off of existence of rating

Trait Implementations

impl Clone for PlaylistSearchQuery

fn clone(&self) -> PlaylistSearchQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaylistSearchQuery

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

Formats the value using the given formatter.

impl Default for PlaylistSearchQuery

fn default() -> PlaylistSearchQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PlaylistSearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PlaylistSearchQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.