Skip to main content

RealmIncomingWebhookBot

Struct RealmIncomingWebhookBot 

Source
pub struct RealmIncomingWebhookBot { /* private fields */ }
Expand description

Represents details of the incoming webhook bot.

Modified from openapi-generator-cli output:

$ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec
/*
* Zulip REST API
*
* Powerful open source group chat
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/

See zerver/openapi/zulip.yaml for the original OpenAPI configuration.

Configuration slightly modified to work with the Rust generator of openapi-generator-cli.

Implementations§

Source§

impl RealmIncomingWebhookBot

Source

pub const fn new() -> Self

Object containing details of the bot.

Source§

impl RealmIncomingWebhookBot

Source

pub fn name(&self) -> Option<&str>

Gets the RealmIncomingWebhookBot name.

A machine-readable unique name identifying the integration, all-lower-case without spaces.

Source

pub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the RealmIncomingWebhookBot name.

A machine-readable unique name identifying the integration, all-lower-case without spaces.

Source

pub fn unset_name(&mut self) -> Option<String>

Unsets the RealmIncomingWebhookBot name.

A machine-readable unique name identifying the integration, all-lower-case without spaces.

Source

pub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the RealmIncomingWebhookBot name.

A machine-readable unique name identifying the integration, all-lower-case without spaces.

Source

pub fn display_name(&self) -> Option<&str>

Gets the RealmIncomingWebhookBot display_name.

A human-readable display name identifying the integration that this bot implements, intended to be used in menus for selecting which integration to create.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn set_display_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the RealmIncomingWebhookBot display_name.

A human-readable display name identifying the integration that this bot implements, intended to be used in menus for selecting which integration to create.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn unset_display_name(&mut self) -> Option<String>

Unsets the RealmIncomingWebhookBot display_name.

A human-readable display name identifying the integration that this bot implements, intended to be used in menus for selecting which integration to create.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn with_display_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the RealmIncomingWebhookBot display_name.

A human-readable display name identifying the integration that this bot implements, intended to be used in menus for selecting which integration to create.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn all_event_types(&self) -> Option<&[String]>

Gets the RealmIncomingWebhookBot all_event_types.

For incoming webhook integrations that support the Zulip server filtering incoming events, the list of event types supported by it.

A null value will be present if this incoming webhook integration doesn’t support such filtering.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn set_all_event_types<'a, C: Into<Cow<'a, [String]>>>(&mut self, val: C)

Sets the RealmIncomingWebhookBot all_event_types.

For incoming webhook integrations that support the Zulip server filtering incoming events, the list of event types supported by it.

A null value will be present if this incoming webhook integration doesn’t support such filtering.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn unset_all_event_types(&mut self) -> Option<Vec<String>>

Unsets the RealmIncomingWebhookBot all_event_types.

For incoming webhook integrations that support the Zulip server filtering incoming events, the list of event types supported by it.

A null value will be present if this incoming webhook integration doesn’t support such filtering.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn with_all_event_types<'a, C: Into<Cow<'a, [String]>>>( self, val: C, ) -> Self

Builder function that sets the RealmIncomingWebhookBot all_event_types.

For incoming webhook integrations that support the Zulip server filtering incoming events, the list of event types supported by it.

A null value will be present if this incoming webhook integration doesn’t support such filtering.

Changes: New in Zulip 8.0 (feature level 207).

Source

pub fn config_options(&self) -> Option<&[WebhookConfigOption]>

Gets the RealmIncomingWebhookBot config_options.

An array of configuration options that can be set when creating a bot user for this incoming webhook integration.

This is an unstable API. Please discuss in chat.zulip.org before using it.

Changes: As of Zulip 11.0 (feature level 403), this object is reserved for integration-specific configuration options that can be set when creating a bot user.

Previously, this object also included optional webhook URL parameters, which are now specified in the url_options object. Before Zulip 10.0 (feature level 318),

this field was named config, and was reserved for configuration data key-value pairs.

Source

pub fn set_config_options<'a, C: Into<Cow<'a, [WebhookConfigOption]>>>( &mut self, val: C, )

Sets the RealmIncomingWebhookBot config_options.

An array of configuration options that can be set when creating a bot user for this incoming webhook integration.

This is an unstable API. Please discuss in chat.zulip.org before using it.

Changes: As of Zulip 11.0 (feature level 403), this object is reserved for integration-specific configuration options that can be set when creating a bot user.

Previously, this object also included optional webhook URL parameters, which are now specified in the url_options object. Before Zulip 10.0 (feature level 318),

this field was named config, and was reserved for configuration data key-value pairs.

Source

pub fn unset_config_options(&mut self) -> Option<Vec<WebhookConfigOption>>

Unsets the RealmIncomingWebhookBot config_options.

An array of configuration options that can be set when creating a bot user for this incoming webhook integration.

This is an unstable API. Please discuss in chat.zulip.org before using it.

Changes: As of Zulip 11.0 (feature level 403), this object is reserved for integration-specific configuration options that can be set when creating a bot user.

Previously, this object also included optional webhook URL parameters, which are now specified in the url_options object. Before Zulip 10.0 (feature level 318),

this field was named config, and was reserved for configuration data key-value pairs.

Source

pub fn with_config_options<'a, C: Into<Cow<'a, [WebhookConfigOption]>>>( self, val: C, ) -> Self

Builder function that sets the RealmIncomingWebhookBot config_options.

An array of configuration options that can be set when creating a bot user for this incoming webhook integration.

This is an unstable API. Please discuss in chat.zulip.org before using it.

Changes: As of Zulip 11.0 (feature level 403), this object is reserved for integration-specific configuration options that can be set when creating a bot user.

Previously, this object also included optional webhook URL parameters, which are now specified in the url_options object. Before Zulip 10.0 (feature level 318),

this field was named config, and was reserved for configuration data key-value pairs.

Source

pub fn url_options(&self) -> Option<&[WebhookUrlOption]>

Gets the RealmIncomingWebhookBot url_options.

An array of optional URL parameter options for the incoming webhook integration.

In the web app, these are used when generating a URL for an integration.

This is an unstable API expected to be used only by the Zulip web app. Please discuss in chat.zulip.org before using it.

Changes: New in Zulip 11.0 (feature level 403). Previously, these optional URL parameter options were included in the config_options object.

Source

pub fn set_url_options<'a, C: Into<Cow<'a, [WebhookUrlOption]>>>( &mut self, val: C, )

Sets the RealmIncomingWebhookBot url_options.

An array of optional URL parameter options for the incoming webhook integration.

In the web app, these are used when generating a URL for an integration.

This is an unstable API expected to be used only by the Zulip web app. Please discuss in chat.zulip.org before using it.

Changes: New in Zulip 11.0 (feature level 403). Previously, these optional URL parameter options were included in the config_options object.

Source

pub fn unset_url_options(&mut self) -> Option<Vec<WebhookUrlOption>>

Unsets the RealmIncomingWebhookBot url_options.

An array of optional URL parameter options for the incoming webhook integration.

In the web app, these are used when generating a URL for an integration.

This is an unstable API expected to be used only by the Zulip web app. Please discuss in chat.zulip.org before using it.

Changes: New in Zulip 11.0 (feature level 403). Previously, these optional URL parameter options were included in the config_options object.

Source

pub fn with_url_options<'a, C: Into<Cow<'a, [WebhookUrlOption]>>>( self, val: C, ) -> Self

Builder function that sets the RealmIncomingWebhookBot url_options.

An array of optional URL parameter options for the incoming webhook integration.

In the web app, these are used when generating a URL for an integration.

This is an unstable API expected to be used only by the Zulip web app. Please discuss in chat.zulip.org before using it.

Changes: New in Zulip 11.0 (feature level 403). Previously, these optional URL parameter options were included in the config_options object.

Trait Implementations§

Source§

impl Clone for RealmIncomingWebhookBot

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RealmIncomingWebhookBot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RealmIncomingWebhookBot

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RealmIncomingWebhookBot

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for RealmIncomingWebhookBot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RealmIncomingWebhookBot

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for RealmIncomingWebhookBot

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RealmIncomingWebhookBot

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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