1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
use crate::chat::ChatId;
use crate::user::User;
use crate::{JsonMethod, TelegramMethod};
use serde::{Deserialize, Serialize};
/// This object represents a bot command.
#[derive(Serialize, Deserialize, Clone)]
pub struct BotCommand {
/// Text of the command, 1-32 characters.
/// Can contain only lowercase English letters, digits and underscores.
pub command: String,
/// Description of the command, 3-256 characters.
pub description: String,
}
/// This object represents the scope to which bot commands are applied.
///
/// Currently, the following 7 scopes are supported:
/// - BotCommandScopeDefault
/// - BotCommandScopeAllPrivateChats
/// - BotCommandScopeAllGroupChats
/// - BotCommandScopeAllChatAdministrators
/// - BotCommandScopeChat
/// - BotCommandScopeChatAdministrators
/// - BotCommandScopeChatMember
///
/// # Determining list of commands
///
/// The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:
///
/// ## Commands in the chat with the bot
///
/// - botCommandScopeChat + language_code
/// - botCommandScopeChat
/// - botCommandScopeAllPrivateChats + language_code
/// - botCommandScopeAllPrivateChats
/// - botCommandScopeDefault + language_code
/// - botCommandScopeDefault
///
/// ## Commands in group and supergroup chats
///
/// - botCommandScopeChatMember + language_code
/// - botCommandScopeChatMember
/// - botCommandScopeChatAdministrators + language_code (admins only)
/// - botCommandScopeChatAdministrators (admins only)
/// - botCommandScopeChat + language_code
/// - botCommandScopeChat
/// - botCommandScopeAllChatAdministrators + language_code (admins only)
/// - botCommandScopeAllChatAdministrators (admins only)
/// - botCommandScopeAllGroupChats + language_code
/// - botCommandScopeAllGroupChats
/// - botCommandScopeDefault + language_code
/// - botCommandScopeDefault
#[derive(Serialize)]
pub enum BotCommandScope {
/// Default commands are used if no commands with a narrower scope are specified for the user.
Default,
/// Covers all private chats.
AllPrivateChats,
/// Covers all group and supergroup chats.
AllGroupChats,
/// Cvoers all group and supergroup chat administrators.
AllChatAdministrators,
/// Covers a specific chat.
Chat {
/// Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`)
chat_id: ChatId,
},
/// Covers all administrators of a specific group or supergroup chat.
ChatAdministrators {
/// Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`)
chat_id: ChatId,
},
/// Covers a specific member of a group or supergroup chat.
ChatMember {
/// Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`)
chat_id: ChatId,
/// Unique identifier of the target user
user_id: i64,
},
}
/// A simple method for testing your bot's auth token. Requires no parameters.
///
/// Returns basic information about the bot in form of a User object.
#[derive(Serialize)]
pub struct GetMe;
impl TelegramMethod for GetMe {
type Response = User;
fn name() -> &'static str {
"getMe"
}
}
impl JsonMethod for GetMe {}
/// Use this method to log out from the cloud Bot API server before launching the bot locally.
///
/// You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates.
/// After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes.
/// Returns *True* on success. Requires no parameters.
#[derive(Serialize)]
pub struct LogOut;
impl TelegramMethod for LogOut {
type Response = bool;
fn name() -> &'static str {
"logOut"
}
}
impl JsonMethod for LogOut {}
/// Use this method to close the bot instance before moving it from one local server to another.
/// You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart.
/// The method will return error 429 in the first 10 minutes after the bot is launched.
/// Returns True on success. Requires no parameters.
#[derive(Serialize)]
pub struct Close;
impl TelegramMethod for Close {
type Response = bool;
fn name() -> &'static str {
"close"
}
}
impl JsonMethod for Close {}
/// Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands.
/// Returns _True_ on success.
#[derive(Serialize)]
pub struct SetMyCommands {
/// A JSON-serialized list of bot commands to be set as the list of the bot's commands.
/// At most 100 commands can be specified.
pub commands: Vec<BotCommand>,
/// A JSON-serialized object, describing scope of users for which the commands are relevant.
/// Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault).
pub scope: Option<BotCommandScope>,
/// A two-letter ISO 639-1 language code.
/// If empty, commands will be applied to all users from the given scope,
/// for whose language there are no dedicated commands
pub language_code: Option<String>,
}
impl SetMyCommands {
/// Create a new setMyCommands request
pub fn new(commands: impl Into<Vec<BotCommand>>) -> Self {
Self {
commands: commands.into(),
scope: None,
language_code: None,
}
}
/// Set command scope
pub fn with_scope(self, scope: BotCommandScope) -> Self {
Self {
scope: Some(scope),
..self
}
}
/// Set language code
pub fn with_language_code(self, language_code: impl Into<String>) -> Self {
Self {
language_code: Some(language_code.into()),
..self
}
}
}
impl TelegramMethod for SetMyCommands {
type Response = bool;
fn name() -> &'static str {
"setMyCommands"
}
}
impl JsonMethod for SetMyCommands {}
/// Use this method to delete the list of the bot's commands for the given scope and user language.
/// After deletion, higher level commands will be shown to affected users.
/// Returns _True_ on success.
#[derive(Serialize)]
pub struct DeleteMyCommands {
/// A JSON-serialized object, describing scope of users for which the commands are relevant.
/// Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault).
pub scope: Option<BotCommandScope>,
/// A two-letter ISO 639-1 language code.
/// If empty, commands will be applied to all users from the given scope,
/// for whose language there are no dedicated commands
pub language_code: Option<String>,
}
impl DeleteMyCommands {
/// Create a new deleteMyCommands request
pub fn new() -> Self {
Self {
scope: None,
language_code: None,
}
}
/// Set command scope
pub fn with_scope(self, scope: BotCommandScope) -> Self {
Self {
scope: Some(scope),
..self
}
}
/// Set language code
pub fn with_language_code(self, language_code: impl Into<String>) -> Self {
Self {
language_code: Some(language_code.into()),
..self
}
}
}
impl TelegramMethod for DeleteMyCommands {
type Response = bool;
fn name() -> &'static str {
"deleteMyCommands"
}
}
/// Use this method to get the current list of the bot's commands for the given scope and user language.
/// Returns Array of [BotCommand](https://core.telegram.org/bots/api#botcommand) on success.
/// If commands aren't set, an empty list is returned.
#[derive(Serialize)]
pub struct GetMyCommands {
/// A JSON-serialized object, describing scope of users for which the commands are relevant.
/// Defaults to [BotCommandScopeDefault](https://core.telegram.org/bots/api#botcommandscopedefault).
pub scope: Option<BotCommandScope>,
/// A two-letter ISO 639-1 language code.
/// If empty, commands will be applied to all users from the given scope,
/// for whose language there are no dedicated commands
pub language_code: Option<String>,
}
impl GetMyCommands {
/// Create a new getMyCommands request
pub fn new() -> Self {
Self {
scope: None,
language_code: None,
}
}
/// Set command scope
pub fn with_scope(self, scope: BotCommandScope) -> Self {
Self {
scope: Some(scope),
..self
}
}
/// Set language code
pub fn with_language_code(self, language_code: impl Into<String>) -> Self {
Self {
language_code: Some(language_code.into()),
..self
}
}
}
impl TelegramMethod for GetMyCommands {
type Response = Vec<BotCommand>;
fn name() -> &'static str {
"getMyCommands"
}
}