API_CONSTANTS
import { API_CONSTANTS } from "https://raw.githubusercontent.com/grammyjs/grammY/dc0a98dc8bca4f84fb5b9f217459c72ec4a6f495/src/convenience/constants.ts";
Contains lists of constants which are useful when working with the Bot API.
interface API_CONSTANTS {
ALL_CHAT_PERMISSIONS: ALL_CHAT_PERMISSIONS;
ALL_UPDATE_TYPES: ALL_UPDATE_TYPES;
DEFAULT_UPDATE_TYPES: DEFAULT_UPDATE_TYPES;
}const API_CONSTANTS: API_CONSTANTS;
§Properties
§
ALL_CHAT_PERMISSIONS: ALL_CHAT_PERMISSIONS
[src]An object containing all available chat permissions. Useful if you want
to lift restrictions from a user, as this action requires you to pass
true
for all permissions. Use it like so:
// On `Bot`:
await bot.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
// On `Api`:
await ctx.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
// On `Context`:
await ctx.restrictChatMember(user_id, ALL_CHAT_PERMISSIONS);
await ctx.restrictAuthor(ALL_CHAT_PERMISSIONS);
§
ALL_UPDATE_TYPES: ALL_UPDATE_TYPES
[src]List of all available update types. Useful if you want to receive all updates from the Bot API, rather than just those that are delivered by default.
The main use case for this is when you want to receive chat_member
updates, as they need to be enabled first. Use it like so:
// Built-in polling:
bot.start({ allowed_updates: ALL_UPDATE_TYPES });
// grammY runner:
run(bot, { runner: { fetch: { allowed_updates: ALL_UPDATE_TYPES } } });
// Webhooks:
await bot.api.setWebhook(url, { allowed_updates: ALL_UPDATE_TYPES });
§
DEFAULT_UPDATE_TYPES: DEFAULT_UPDATE_TYPES
[src]List of update types a bot receives by default. Useful if you want to
receive all update types but chat_member
.
// Built-in polling:
bot.start({ allowed_updates: DEFAULT_UPDATE_TYPES });
// grammY runner:
run(bot, { runner: { fetch: { allowed_updates: DEFAULT_UPDATE_TYPES } } });
// Webhooks:
await bot.api.setWebhook(url, { allowed_updates: DEFAULT_UPDATE_TYPES });