Skip to main content

ChatUnfurlRequest

Struct ChatUnfurlRequest 

Source
#[non_exhaustive]
pub struct ChatUnfurlRequest { pub channel: Option<String>, pub ts: Option<String>, pub unfurls: Option<String>, pub user_auth_message: Option<String>, pub user_auth_required: Option<bool>, pub user_auth_url: Option<String>, pub user_auth_blocks: Option<Vec<Block>>, pub unfurl_id: Option<String>, pub source: Option<String>, }
Expand description

Arguments for the Slack Web API method chat.unfurl: Provide custom unfurl behavior for user-posted URLs

Send it with SlackClient::chat_unfurl.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§channel: Option<String>

Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together. Required for public channels.

§ts: Option<String>

Timestamp of the message to add unfurl behavior to. Required for public channels.

§unfurls: Option<String>

URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl blocks or message attachments. Required for public channels.

§user_auth_message: Option<String>

Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.

§user_auth_required: Option<bool>

Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain

§user_auth_url: Option<String>

Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

§user_auth_blocks: Option<Vec<Block>>

Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

§unfurl_id: Option<String>

The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.

§source: Option<String>

The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.

Implementations§

Source§

impl ChatUnfurlRequest

Source

pub fn new() -> Self

Source

pub fn channel(self, channel: impl Into<String>) -> Self

Source

pub fn ts(self, ts: impl Into<String>) -> Self

Source

pub fn unfurls(self, unfurls: impl Into<String>) -> Self

Source

pub fn user_auth_message(self, user_auth_message: impl Into<String>) -> Self

Source

pub fn user_auth_required(self, user_auth_required: bool) -> Self

Source

pub fn user_auth_url(self, user_auth_url: impl Into<String>) -> Self

Source

pub fn user_auth_blocks(self, user_auth_blocks: Vec<Block>) -> Self

Source

pub fn unfurl_id(self, unfurl_id: impl Into<String>) -> Self

Source

pub fn source(self, source: impl Into<String>) -> Self

Trait Implementations§

Source§

impl Clone for ChatUnfurlRequest

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 ChatUnfurlRequest

Source§

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

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

impl Default for ChatUnfurlRequest

Source§

fn default() -> Self

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

impl PartialEq for ChatUnfurlRequest

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 ChatUnfurlRequest

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 SlackApiMethod for ChatUnfurlRequest

Source§

const METHOD: &'static str = "chat.unfurl"

Method name, such as chat.postMessage.
Source§

type Response = ChatUnfurlResponse

Type of a successful response.
Source§

impl StructuralPartialEq for ChatUnfurlRequest

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> 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> 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> 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, 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<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