Struct Prompt 

pub struct Prompt {
    pub id: String,
    pub text: String,
    pub buttons: Vec<PromptButton>,
    pub allowed: Vec<UserId>,
    pub cards: Vec<Card>,
    pub select: Option<Select>,
}

A message with buttons, shown in one conversation. Interactive replies (ADR 0015) add cards and a menu; a prompt with cards may have no text and nothing to answer.

Fields

id: String

Unique id, chosen by the runtime.

text: String

The message, already rendered for the channel.

buttons: Vec<PromptButton>

Up to five buttons.

allowed: Vec<UserId>

Who may answer; anyone in the conversation when empty. Others are told it is not theirs.

cards: Vec<Card>

Cards shown after the text.

select: Option<Select>

A menu shown before the buttons.

Implementations

impl Prompt

pub fn validate(&self) -> Result<(), String>

Checks the limits and ids; the message says what is wrong.

pub fn button(&self, id: &str) -> Option<&PromptButton>

The button id.

pub fn option(&self, id: &str) -> Option<&SelectOption>

The menu option id.

pub fn answers_with(&self, id: &str) -> bool

Whether id names something that answers: a button that is not a link, or an option.

pub fn is_answerable(&self) -> bool

Whether anything in it can be answered.

pub fn may_answer(&self, user: &UserId) -> bool

Whether user may answer.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl Default for Prompt

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Prompt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Prompt

impl PartialEq for Prompt

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Prompt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Prompt