Skip to main content

ChatPostEphemeralRequest

Struct ChatPostEphemeralRequest 

Source
#[non_exhaustive]
pub struct ChatPostEphemeralRequest {
Show 14 fields pub channel: String, pub user: String, pub as_user: Option<bool>, pub attachments: Option<Vec<Attachment>>, pub blocks: Option<Vec<Block>>, pub icon_emoji: Option<String>, pub icon_url: Option<String>, pub link_names: Option<bool>, pub markdown_text: Option<String>, pub metadata: Option<MessageMetadata>, pub parse: Option<String>, pub text: Option<String>, pub thread_ts: Option<String>, pub username: Option<String>,
}
Expand description

Arguments for the Slack Web API method chat.postEphemeral: Sends an ephemeral message to a user in a channel.

Send it with SlackClient::chat_post_ephemeral.

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: String

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

§user: String

id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

§as_user: Option<bool>

(Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

§attachments: Option<Vec<Attachment>>

A JSON-based array of structured attachments, presented as a URL-encoded string.

§blocks: Option<Vec<Block>>

A JSON-based array of structured blocks, presented as a URL-encoded string.

§icon_emoji: Option<String>

Emoji to use as the icon for this message. Overrides icon_url.

§icon_url: Option<String>

URL to an image to use as the icon for this message.

§link_names: Option<bool>

Find and link channel names and usernames.

§markdown_text: Option<String>

Accepts message text formatted in markdown. This argument should not be used in conjunction with blocks or text. Limit this field to 12,000 characters.

§metadata: Option<MessageMetadata>

JSON object with an entities array of work object entity metadata, presented as a URL-encoded string. Only entity metadata is supported: ephemeral messages are not persisted and never dispatch message_metadata_* events, so event_type/event_payload message metadata is ignored here. Each entity requires entity_type, entity_payload, external_ref, and url.

§parse: Option<String>

Change how messages are treated. Defaults to none. See below.

§text: Option<String>

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

§thread_ts: Option<String>

Provide another message’s ts value to post this message in a thread. Avoid using a reply’s ts value; use its parent’s value instead. Ephemeral messages in threads are only shown if there is already an active thread.

§username: Option<String>

Set your bot’s user name.

Implementations§

Source§

impl ChatPostEphemeralRequest

Source

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

Source

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

Source

pub fn attachments(self, attachments: Vec<Attachment>) -> Self

Source

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

Source

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

Source

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

Source

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

Source

pub fn metadata(self, metadata: MessageMetadata) -> Self

Source

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

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Clone for ChatPostEphemeralRequest

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 ChatPostEphemeralRequest

Source§

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

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

impl PartialEq for ChatPostEphemeralRequest

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 ChatPostEphemeralRequest

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 ChatPostEphemeralRequest

Source§

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

Method name, such as chat.postMessage.
Source§

type Response = ChatPostEphemeralResponse

Type of a successful response.
Source§

impl StructuralPartialEq for ChatPostEphemeralRequest

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