Struct teloxide_core::payloads::SendMediaGroup

pub struct SendMediaGroup {
    pub chat_id: Recipient,
    pub media: Vec<InputMedia>,
    pub message_thread_id: Option<ThreadId>,
    pub disable_notification: Option<bool>,
    pub protect_content: Option<bool>,
    pub reply_parameters: Option<ReplyParameters>,
}

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Captions

You may want to set a “global” caption which renders in the message, underneath the set of media. However, global captions for a media group are not part of the Telegram API. They result from how the official clients (at least) render a media group where only one InputMedia has a caption set. That captioned InputMedia may be in any position of the group.

In order to set a “global” caption of a media group, set a caption for a single InputMedia in the group with the contents you wish to display underneath all media.

If multiple InputMedia have captions, including identical ones, the official clients will not render a global caption underneath the group. Each individual media will keep its own caption however, which can be shown by the client when viewing the media individually, or by separating the media in its own message (for example by forwarding a single media from the media group).

Fields

chat_id: Recipient

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

media: Vec<InputMedia>

A JSON-serialized array describing messages to be sent, must include 2-10 items

message_thread_id: Option<ThreadId>

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

disable_notification: Option<bool>

Sends the message silently. Users will receive a notification with no sound.

protect_content: Option<bool>

Protects the contents of sent messages from forwarding and saving

reply_parameters: Option<ReplyParameters>

Description of the message to reply to

Implementations

impl SendMediaGroup

pub fn new( chat_id: impl Into<Recipient>, media: impl IntoIterator<Item = InputMedia>, ) -> Self

Trait Implementations

impl Clone for SendMediaGroup

fn clone(&self) -> SendMediaGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendMediaGroup

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

Formats the value using the given formatter.

impl MultipartPayload for SendMediaGroup

fn copy_files(&self, into: &mut dyn FnMut(InputFile))

fn move_files(&mut self, into: &mut dyn FnMut(InputFile))

impl Payload for SendMediaGroup

type Output = Vec<Message>

The return type of a Telegram method.

const NAME: &'static str = "SendMediaGroup"

Name of a Telegram method.

fn timeout_hint(&self) -> Option<Duration>

If this payload may take long time to execute (e.g. GetUpdates with big timeout), the minimum timeout that should be used.

impl Serialize for SendMediaGroup

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

where __S: Serializer,

Serialize this value into the given Serde serializer.