mastodon_api::methods::announcements

Struct AnnouncementsHandler

Source 
pub struct AnnouncementsHandler<'a> { /* private fields */ }
Expand description

Handler for announcement-related API endpoints.

Implementations§

Source§

impl<'a> AnnouncementsHandler<'a>

Source

pub fn new(client: &'a MastodonClient) -> Self

Creates a new AnnouncementsHandler for the given client.

Source

pub async fn list(&self) -> Result<Vec<Announcement>>

Fetches all active announcements from the server.

Returns:

  • Result<Vec<Announcement>>: The announcements.

Corresponds to GET /api/v1/announcements.

Source

pub async fn dismiss(&self, id: &str) -> Result<()>

Dismisses an announcement for the authenticated user.

Parameters:

  • id: The ID of the announcement to dismiss.

Returns:

  • Result<()>: Success if the announcement was dismissed.

Corresponds to POST /api/v1/announcements/:id/dismiss.

Source

pub async fn add_reaction( &self, id: &str, name: &str, ) -> Result<AnnouncementReaction>

Adds a reaction to an announcement.

Parameters:

  • id: The ID of the announcement.
  • name: The name of the reaction (emoji).

Returns:

  • Result<AnnouncementReaction>: The updated reaction.

Corresponds to POST /api/v1/announcements/:id/reactions/:name.

Source

pub async fn remove_reaction( &self, id: &str, name: &str, ) -> Result<AnnouncementReaction>

Removes a reaction from an announcement.

Parameters:

  • id: The ID of the announcement.
  • name: The name of the reaction (emoji).

Returns:

  • Result<AnnouncementReaction>: The updated reaction.

Corresponds to DELETE /api/v1/announcements/:id/reactions/:name.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more