Struct newsblur_api::NewsBlurApi

pub struct NewsBlurApi { /* fields omitted */ }

Implementations

impl NewsBlurApi

pub fn new(
    url: &Url,
    username: &str,
    password: &str,
    cookie: Option<String>
) -> Self

Create a new instance of the NewsBlurApi

pub async fn login(&mut self, client: &Client) -> Result<String, ApiError>

Login to NewsBlur. This must be called before other functions

On success returns the cookie used for login

pub async fn logout(&self, client: &Client) -> Result<(), ApiError>

Logout of NewsBlur

pub async fn signup(&self, _client: &Client) -> Result<(), ApiError>

Sign up to NewsBlur

pub async fn search_feed(
    &self,
    client: &Client,
    address: &str
) -> Result<(), ApiError>

Retrieve information about a feed from its website or RSS address.

pub async fn get_feeds(&self, client: &Client) -> Result<Value, ApiError>

Retrieve a list of feeds to which a user is actively subscribed.

pub async fn favicons(
    &self,
    client: &Client,
    feed_id: &str
) -> Result<Value, ApiError>

Retrieve a list of favicons for a list of feeds. Used when combined with /reader/feeds and include_favicons=false, so the feeds request contains far less data. Useful for mobile devices, but requires a second request.

pub async fn get_original_page(
    &self,
    client: &Client,
    id: &str
) -> Result<String, ApiError>

Retrieve the original page from a single feed.

pub async fn get_original_text(
    &self,
    client: &Client,
    id: &str
) -> Result<String, ApiError>

Retrieve the original page from a single feed.

pub async fn refresh_feeds(&self, client: &Client) -> Result<Value, ApiError>

Up-to-the-second unread counts for each active feed. Poll for these counts no more than once a minute.

pub async fn get_read_stories(
    &self,
    client: &Client,
    page: u32
) -> Result<Value, ApiError>

Feed of previously read stories.

pub async fn get_stories(
    &self,
    client: &Client,
    id: &str,
    include_content: bool,
    page: u32
) -> Result<Value, ApiError>

Retrieve stories from a single feed.

pub async fn mark_stories_read(
    &self,
    client: &Client,
    story_hash: &str
) -> Result<(), ApiError>

Mark stories as read using their unique story_hash.

pub async fn mark_story_unread(
    &self,
    client: &Client,
    story_hash: &str
) -> Result<(), ApiError>

Mark a single story as unread using its unique story_hash.

pub async fn mark_story_hash_as_starred(
    &self,
    client: &Client,
    story_hash: &str
) -> Result<(), ApiError>

Mark a story as starred (saved).

pub async fn mark_story_hash_as_unstarred(
    &self,
    client: &Client,
    story_hash: &str
) -> Result<(), ApiError>

Mark a story as unstarred (unsaved).

pub async fn get_unread_story_hashes(
    &self,
    client: &Client
) -> Result<Value, ApiError>

The story_hashes of all unread stories. Useful for offline access of stories and quick unread syncing. Use include_timestamps to fetch stories in date order.

pub async fn get_stared_story_hashes(
    &self,
    client: &Client
) -> Result<Value, ApiError>

pub async fn get_river_stories(
    &self,
    client: &Client,
    hashes: &[&str]
) -> Result<Value, ApiError>

Retrieve up to 100 stories when specifying by story_hash.

pub async fn mark_feed_read(
    &self,
    client: &Client,
    feed_id: &str
) -> Result<(), ApiError>

pub async fn mark_all_read(&self, client: &Client) -> Result<(), ApiError>