Struct GalleryConfig

pub struct GalleryConfig { /* private fields */ }

Available on crate feature unstable-msc4274 only.

Configuration for sending a gallery.

This duplicates matrix_sdk::attachment::GalleryConfig but uses an AttachmentSource so that we can delay loading the actual data until we’re inside the SendGallery future. This allows Timeline::send_gallery to return early without blocking the caller.

Implementations

impl GalleryConfig

pub fn new() -> Self

Create a new empty GalleryConfig.

pub fn txn_id(self, txn_id: OwnedTransactionId) -> Self

Set the transaction ID to send.

Arguments

• txn_id - A unique ID that can be attached to a MessageEvent held in its unsigned field as transaction_id. If not given, one is created for the message.

pub fn add_item(self, item: GalleryItemInfo) -> Self

Adds a media item to the gallery.

Arguments

• item - Information about the item to be added.

pub fn caption(self, caption: Option<String>) -> Self

Set the optional caption.

Arguments

• caption - The optional caption.

pub fn formatted_caption(self, formatted_caption: Option<FormattedBody>) -> Self

Set the optional formatted caption.

Arguments

• formatted_caption - The optional formatted caption.

pub fn mentions(self, mentions: Option<Mentions>) -> Self

Set the mentions of the message.

Arguments

• mentions - The mentions of the message.

pub fn in_reply_to(self, event_id: Option<OwnedEventId>) -> Self

Set the reply information of the message.

Arguments

• event_id - The event ID to reply to.

pub fn len(&self) -> usize

Returns the number of media items in the gallery.

pub fn is_empty(&self) -> bool

Checks whether the gallery contains any media items or not.

Trait Implementations

impl Debug for GalleryConfig

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

Formats the value using the given formatter.

impl Default for GalleryConfig

fn default() -> GalleryConfig

Returns the “default value” for a type.