Struct scoopit_api::requests::GetTopicRequest

pub struct GetTopicRequest {
    pub id: Option<u64>,
    pub url_name: Option<String>,
    pub curated: Option<u32>,
    pub page: Option<u32>,
    pub curable: Option<u32>,
    pub curable_page: Option<u32>,
    pub order: Option<String>,
    pub tag: Option<Vec<String>>,
    pub q: Option<String>,
    pub since: Option<i64>,
    pub to: Option<i64>,
    pub ncomments: Option<u32>,
    pub show_scheduled: bool,
}

Get a Topic.

Maps parameters of https://www.scoop.it/dev/api/1/urls#topic

Documentation of each field comes from the page above. Default values documented are used only ff the field is not present (None), Default implementation for this struct may differ from Scoop.it defaults to avoid retrieving the world while only looking at the user profile.

Fields

id: Option<u64>

long required, unless 'urlName' is provided - the id of the topic to lookup

url_name: Option<String>

string required, unless 'id' is provided - the urlName of the topic to lookup

curated: Option<u32>

int optional, default to 30 - number of curated posts to retrieve for this topic

page: Option<u32>

int optional, default to 0

curable: Option<u32>

int optional, default to 0 - for this topic, this parameter is ignored if the current user is not the curator of this topic

curable_page: Option<u32>

int optional, default to 0 - for this topic, this parameter is ignored if the current user is not the curator of this topic - get a given page of curable posts

order: Option<String>

string mandatory if "since" parameter is not specified - sort order of the curated posts, can be "tag" (see below), "search" (filter result on query "q" mandatory - see below), "curationDate", "user" (same order as seen in the scoop.it website)

tag: Option<Vec<String>>

string[] mandatory if "order"=="tag"

q: Option<String>

string mandatory if "order"=="search" - the query to use to search in the topic

since: Option<i64>

timestamp - only retrieve curated post newer than this timestamp

to: Option<i64>

timestamp optional - used with "since" parameter, retrieve curated posts posts older then this timestamp

ncomments: Option<u32>

int optional, default to 100 - each curated post found in this topic

show_scheduled: bool

boolean optional, default to false - if true, the response will include the scheduled posts

Trait Implementations

impl Debug for GetTopicRequest

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

Formats the value using the given formatter.

impl Default for GetTopicRequest

pub fn default() -> Self

Returns the "default value" for a type.

impl GetRequest for GetTopicRequest

type Response = TopicResponse

The type returned by the Scoop.it API.

type Output = Topic

The type returned by the client

pub fn endpoint() -> &'static str

impl Serialize for GetTopicRequest

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

Serialize this value into the given Serde serializer.