Struct teloxide::payloads::SetWebhook

#[must_use = "Requests do nothing unless sent"]pub struct SetWebhook {
    pub url: String,
    pub certificate: Option<InputFile>,
    pub ip_address: Option<String>,
    pub max_connections: Option<u8>,
    pub allowed_updates: Option<Vec<AllowedUpdate, Global>>,
    pub drop_pending_updates: Option<bool>,
}

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

If you’d like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot’s token, you can be pretty sure it’s us.

Fields

url: String

HTTPS url to send updates to. Use an empty string to remove webhook integration

certificate: Option<InputFile>

Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

ip_address: Option<String>

The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

max_connections: Option<u8>

Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot’s server, and higher values to increase your bot’s throughput.

allowed_updates: Option<Vec<AllowedUpdate, Global>>

A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.

Please note that this parameter doesn’t affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.

drop_pending_updates: Option<bool>

Pass True to drop all pending updates

Implementations

impl SetWebhook

pub fn new(url: impl Into<String>) -> SetWebhook

Trait Implementations

impl Clone for SetWebhook

pub fn clone(&self) -> SetWebhook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetWebhook

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

Formats the value using the given formatter.

impl Eq for SetWebhook

impl Hash for SetWebhook

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl MultipartPayload for SetWebhook

impl PartialEq<SetWebhook> for SetWebhook

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Payload for SetWebhook

type Output = True

The return type of a Telegram method.

pub const NAME: &'static str

Name of a Telegram method.

impl Serialize for SetWebhook

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

Serialize this value into the given Serde serializer.

impl StructuralEq for SetWebhook

impl StructuralPartialEq for SetWebhook