WebhookBuilder

jacquard_api::place_stream::server

Struct WebhookBuilder 

Source 
pub struct WebhookBuilder<'a, S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<'a, S: State> WebhookBuilder<'a, S>

Source

pub fn build(self) -> Webhook<'a>
where S: IsComplete,

Finish building and return the requested object

Source

pub fn active(self, value: bool) -> WebhookBuilder<'a, SetActive<S>>
where S::Active: IsUnset,

Required.

Whether this webhook is currently active.

Source

pub fn created_at(self, value: Datetime) -> WebhookBuilder<'a, SetCreatedAt<S>>
where S::CreatedAt: IsUnset,

Required.

When this webhook was created.

Source

pub fn description( self, value: impl Into<CowStr<'a>>, ) -> WebhookBuilder<'a, SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters).

A description of what this webhook is used for.

Source

pub fn maybe_description( self, value: Option<impl Into<CowStr<'a>>>, ) -> WebhookBuilder<'a, SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters).

A description of what this webhook is used for.

Source

pub fn error_count( self, value: impl Into<i64>, ) -> WebhookBuilder<'a, SetErrorCount<S>>
where S::ErrorCount: IsUnset,

Optional (Some / Option setters).

Number of consecutive errors for this webhook.

Source

pub fn maybe_error_count( self, value: Option<impl Into<i64>>, ) -> WebhookBuilder<'a, SetErrorCount<S>>
where S::ErrorCount: IsUnset,

Optional (Some / Option setters).

Number of consecutive errors for this webhook.

Source

pub fn events(self, value: Vec<CowStr<'a>>) -> WebhookBuilder<'a, SetEvents<S>>
where S::Events: IsUnset,

Required.

The types of events this webhook should receive.

Source

pub fn id(self, value: impl Into<CowStr<'a>>) -> WebhookBuilder<'a, SetId<S>>
where S::Id: IsUnset,

Required.

Unique identifier for this webhook.

Source

pub fn last_triggered( self, value: impl Into<Datetime>, ) -> WebhookBuilder<'a, SetLastTriggered<S>>
where S::LastTriggered: IsUnset,

Optional (Some / Option setters).

When this webhook was last triggered.

Source

pub fn maybe_last_triggered( self, value: Option<impl Into<Datetime>>, ) -> WebhookBuilder<'a, SetLastTriggered<S>>
where S::LastTriggered: IsUnset,

Optional (Some / Option setters).

When this webhook was last triggered.

Source

pub fn mute_words( self, value: impl Into<Vec<CowStr<'a>>>, ) -> WebhookBuilder<'a, SetMuteWords<S>>
where S::MuteWords: IsUnset,

Optional (Some / Option setters).

Words to filter out from chat messages. Messages containing any of these words will not be forwarded.

Source

pub fn maybe_mute_words( self, value: Option<impl Into<Vec<CowStr<'a>>>>, ) -> WebhookBuilder<'a, SetMuteWords<S>>
where S::MuteWords: IsUnset,

Optional (Some / Option setters).

Words to filter out from chat messages. Messages containing any of these words will not be forwarded.

Source

pub fn name( self, value: impl Into<CowStr<'a>>, ) -> WebhookBuilder<'a, SetName<S>>
where S::Name: IsUnset,

Optional (Some / Option setters).

A user-friendly name for this webhook.

Source

pub fn maybe_name( self, value: Option<impl Into<CowStr<'a>>>, ) -> WebhookBuilder<'a, SetName<S>>
where S::Name: IsUnset,

Optional (Some / Option setters).

A user-friendly name for this webhook.

Source

pub fn prefix( self, value: impl Into<CowStr<'a>>, ) -> WebhookBuilder<'a, SetPrefix<S>>
where S::Prefix: IsUnset,

Optional (Some / Option setters).

Text to prepend to webhook messages.

Source

pub fn maybe_prefix( self, value: Option<impl Into<CowStr<'a>>>, ) -> WebhookBuilder<'a, SetPrefix<S>>
where S::Prefix: IsUnset,

Optional (Some / Option setters).

Text to prepend to webhook messages.

Source

pub fn rewrite( self, value: impl Into<Vec<RewriteRule<'a>>>, ) -> WebhookBuilder<'a, SetRewrite<S>>
where S::Rewrite: IsUnset,

Optional (Some / Option setters).

Text replacement rules for webhook messages.

Source

pub fn maybe_rewrite( self, value: Option<impl Into<Vec<RewriteRule<'a>>>>, ) -> WebhookBuilder<'a, SetRewrite<S>>
where S::Rewrite: IsUnset,

Optional (Some / Option setters).

Text replacement rules for webhook messages.

Source

pub fn suffix( self, value: impl Into<CowStr<'a>>, ) -> WebhookBuilder<'a, SetSuffix<S>>
where S::Suffix: IsUnset,

Optional (Some / Option setters).

Text to append to webhook messages.

Source

pub fn maybe_suffix( self, value: Option<impl Into<CowStr<'a>>>, ) -> WebhookBuilder<'a, SetSuffix<S>>
where S::Suffix: IsUnset,

Optional (Some / Option setters).

Text to append to webhook messages.

Source

pub fn updated_at( self, value: impl Into<Datetime>, ) -> WebhookBuilder<'a, SetUpdatedAt<S>>
where S::UpdatedAt: IsUnset,

Optional (Some / Option setters).

When this webhook was last updated.

Source

pub fn maybe_updated_at( self, value: Option<impl Into<Datetime>>, ) -> WebhookBuilder<'a, SetUpdatedAt<S>>
where S::UpdatedAt: IsUnset,

Optional (Some / Option setters).

When this webhook was last updated.

Source

pub fn url(self, value: Uri<'a>) -> WebhookBuilder<'a, SetUrl<S>>
where S::Url: IsUnset,

Required.

The webhook URL where events will be sent.

Source

pub fn extra_data( self, value: BTreeMap<SmolStr, Data<'a>>, ) -> WebhookBuilder<'a, SetExtraData<S>>
where S::ExtraData: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<::std::collections::BTreeMap<
    ::jacquard_common::smol_str::SmolStr,
    ::jacquard_common::types::value::Data<'a>,
> as Default>::default()
Source

pub fn maybe_extra_data( self, value: Option<BTreeMap<SmolStr, Data<'a>>>, ) -> WebhookBuilder<'a, SetExtraData<S>>
where S::ExtraData: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<::std::collections::BTreeMap<
    ::jacquard_common::smol_str::SmolStr,
    ::jacquard_common::types::value::Data<'a>,
> as Default>::default()

Auto Trait Implementations§

§

impl<'a, S> Freeze for WebhookBuilder<'a, S>

§

impl<'a, S> RefUnwindSafe for WebhookBuilder<'a, S>

§

impl<'a, S> Send for WebhookBuilder<'a, S>

§

impl<'a, S> Sync for WebhookBuilder<'a, S>

§

impl<'a, S> Unpin for WebhookBuilder<'a, S>

§

impl<'a, S> UnwindSafe for WebhookBuilder<'a, S>

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.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

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
Source§

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,