mastodon_api::methods::push

Struct PushHandler

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

Handler for Web Push API endpoints.

Implementations§

Source§

impl<'a> PushHandler<'a>

Source

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

Creates a new PushHandler for the given client.

Source

pub async fn get_subscription(&self) -> Result<WebPushSubscription>

Fetches the current Web Push subscription.

Returns:

  • Result<WebPushSubscription>: The subscription.

Corresponds to GET /api/v1/push/subscription.

Source

pub async fn subscribe( &self, endpoint: &str, p256dh: &str, auth: &str, alerts: Option<WebPushAlerts>, ) -> Result<WebPushSubscription>

Creates or updates a Web Push subscription.

Parameters:

  • endpoint: The endpoint of the Web Push subscription.
  • p256dh: The p256dh public key.
  • auth: The authentication secret.
  • alerts: The alerts to enable.

Returns:

  • Result<WebPushSubscription>: The created/updated subscription.

Corresponds to POST /api/v1/push/subscription.

Source

pub async fn update_alerts( &self, alerts: WebPushAlerts, ) -> Result<WebPushSubscription>

Updates existing Web Push alerts.

Parameters:

  • alerts: The updated alerts.

Returns:

  • Result<WebPushSubscription>: The updated subscription.

Corresponds to PUT /api/v1/push/subscription.

Source

pub async fn unsubscribe(&self) -> Result<()>

Deletes the current Web Push subscription.

Returns:

  • Result<()>: Success if the subscription was deleted.

Corresponds to DELETE /api/v1/push/subscription.

Auto Trait Implementations§

§

impl<'a> Freeze for PushHandler<'a>

§

impl<'a> !RefUnwindSafe for PushHandler<'a>

§

impl<'a> Send for PushHandler<'a>

§

impl<'a> Sync for PushHandler<'a>

§

impl<'a> Unpin for PushHandler<'a>

§

impl<'a> !UnwindSafe for PushHandler<'a>

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