REPOSITORY / ScuroNeko/Laniakea
Pull Requests
v1.2.0 #18
@@ -9,6 +9,15 @@ jobs:
|
|||||||
- name: Checkout repository code
|
- name: Checkout repository code
|
||||||
uses: actions/checkout@v6
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v6.5.0
|
||||||
|
with:
|
||||||
|
go-version: '1.26.6'
|
||||||
|
cache-dependency-path: go.sum
|
||||||
|
|
||||||
|
- name: Print toolchain version
|
||||||
|
run: go version
|
||||||
|
|
||||||
- name: Verify formatting
|
- name: Verify formatting
|
||||||
run: |
|
run: |
|
||||||
files="$(gofmt -l .)"
|
files="$(gofmt -l .)"
|
||||||
@@ -25,4 +34,6 @@ jobs:
|
|||||||
run: go vet ./...
|
run: go vet ./...
|
||||||
|
|
||||||
- name: Run golangci-lint
|
- name: Run golangci-lint
|
||||||
run: golangci-lint run
|
uses: golangci/golangci-lint-action@v9.0.0
|
||||||
|
with:
|
||||||
|
version: v2.12.2
|
||||||
|
|||||||
@@ -1,5 +1,65 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v1.2.0
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Added cancelable background runners through `ContextRunnerFn` and `NewContextRunner`; existing `RunnerFn` and `NewRunner` remain available for compatibility.
|
||||||
|
- Added validated inline-keyboard APIs: `InlineKeyboardButtonBuilder.Validate`/`Build`, `InlineKeyboard.Validate`/`GetValidated`, and `CallbackData.EncodeValidated`, with typed errors for invalid actions, callback-data length, and oversized rows.
|
||||||
|
- Added bounded file-download helpers `GetFileByLinkLimit` and `GetFileByLinkLimitWithContext` with `ErrFileTooLarge`; existing unbounded and streaming helpers remain available.
|
||||||
|
- Added strict root rich-message parsing through `UnmarshalRichMessageStrict` and structural rich JSON depth/node limits with `ErrRichJSONDepth` and `ErrRichJSONNodes`.
|
||||||
|
- Added `APIOpts.SetMaxRetries` for Telegram 429 responses. Automatic JSON and multipart retries now default to at most three attempts after the initial request and return `ErrRetryLimit` when exhausted.
|
||||||
|
- Added `SetChatPhotoWithContext` and the correctly pluralized `DeleteAllMessageReactionsWithContext`; the old singular compatibility alias remains deprecated until v2.
|
||||||
|
- Added `PollAnswer.VoterUser` and `PollAnswer.VoterChatInfo` presence helpers without changing the v1 value-field layout.
|
||||||
|
- Added typed runtime errors for invalid scene actions, nil handlers, recovered handler panics, oversized Telegram responses, and recovered worker-pool task panics.
|
||||||
|
- Added `CommandScopeUpdateError` and command-generation validation errors so callers can inspect invalid commands, duplicate names, invalid descriptions, and partially updated Telegram scopes.
|
||||||
|
- Added rich-message editing helpers `MessageContext.EditCallbackRich`, `MessageContext.UpsertKeyboardRich`, `AnswerMessage.EditRich`, and `AnswerMessage.EditRichKeyboard`, plus `AnswerMessage.RichHTML` for rendered rich content.
|
||||||
|
- Added `NewBotWithAPI` for constructing a bot with a preconfigured, injectable Telegram API client.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Runtime observer callbacks now execute asynchronously in enqueue order on one bounded dispatcher instead of blocking update handlers and scene locks. Queue overflow drops events with sampled warnings, observer panics remain isolated, and shutdown cancels callback contexts, drains queued events, and reports callbacks that ignore cancellation.
|
||||||
|
- Scene routing now holds a lock only for the active session key; updates without an active scene and unrelated user sessions in the same chat remain concurrent.
|
||||||
|
- Multipart uploads now encode request bodies as streams instead of building a second complete in-memory copy for every attempt.
|
||||||
|
- Logger replacement and app-data logger writer registration now follow the bot configuration freeze, reject nil values safely, and install bot-token redaction before publishing replacement loggers.
|
||||||
|
- README and README_RU now document context runners, injectable API clients, bounded retries and downloads, streaming multipart uploads, keyboard validation, and asynchronous observer delivery.
|
||||||
|
- Version metadata now reports `v1.2.0`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixed HTTP transport errors exposing the bot token through Bot API request and file-download URLs while preserving error-chain inspection.
|
||||||
|
- Fixed per-chat rate-limiter lifecycle races with concurrent cleanup, cooldown waits ignoring a later extension, shorter 429 locks replacing longer locks, and busy chats consuming global capacity before obtaining chat capacity.
|
||||||
|
- Fixed scene `AsUserError` values not reaching users and producing duplicate observer errors; scene step, command, payload, and message-fallback errors now follow one consistent error path.
|
||||||
|
- Fixed nil and panicking command, payload, update, message-fallback, scene, and middleware callbacks breaking handler/observer lifecycles. Panics are recovered per invocation and matching finish/error events are emitted.
|
||||||
|
- Fixed asynchronous middleware error events and policy events bypassing the runtime observer dispatcher.
|
||||||
|
- Fixed Telegram MarkdownV2 custom emoji syntax, multiline expandable blockquotes, code/pre escaping, and unsafe code-fence language strings.
|
||||||
|
- Fixed `MessageContext.BindArgs` accepting values outside the destination integer or floating-point width.
|
||||||
|
- Fixed empty successful draft flushes leaving stale drafts in `DraftProvider`.
|
||||||
|
- Fixed generated command descriptions outside Telegram's 1–256-character range, duplicate command names across plugins, trailing usage whitespace, and silent partial multi-scope updates.
|
||||||
|
- Fixed inline keyboard auto-wrap after reducing `maxRow`; legacy non-positive unlimited rows remain compatible for v1.
|
||||||
|
- Fixed Telegram API responses larger than 10 MiB being silently truncated before JSON parsing; they now return `ErrResponseTooLarge`.
|
||||||
|
- Fixed unknown `SceneAction` values being treated as a normal unhandled result.
|
||||||
|
- Fixed worker-pool task panics terminating a worker and leaving the caller without a result.
|
||||||
|
- Fixed zero or negative Telegram `retry_after` values causing a tight retry loop.
|
||||||
|
- Fixed Telegram JSON wire names for `provider_payment_charge_id`, `owned_gift_id`, `others_can_add_tasks`, `others_can_mark_tasks_as_done`, `available_reactions`, and `quote_parse_mode`.
|
||||||
|
- Fixed `MessageContext` text, photo, caption, rich-message, and chat-action helpers omitting business connection identifiers; message-backed helpers now also reject missing chats instead of panicking, while inline edits remain supported without a chat-backed message.
|
||||||
|
- Fixed chat-admin, chat-creator, and bot-admin policies ignoring cancellation and deadlines from the active `MessageContext`.
|
||||||
|
- Fixed command parsing treating tabs and newlines as part of command names and matching addressed bot usernames case-sensitively.
|
||||||
|
- Fixed nested `RichTextArray` values bypassing rich-message depth validation and renderer limits.
|
||||||
|
- Fixed polling panics being reported only through telemetry while `RunWithContext` returned success.
|
||||||
|
- Fixed asynchronous middleware outliving the bot runtime and normal middleware denials being reported as internal handler errors.
|
||||||
|
- Fixed caller-owned or aliased bot loggers being closed by the framework, bot-owned aliases being closed more than once, and replaced internal loggers leaking resources.
|
||||||
|
- Fixed configuration codecs and JSON option encoding panicking on nil inputs.
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
- Added field-level Godoc for the complete exported API surface, including official Telegram Bot API optionality, ranges, formats, and field semantics. The repository-wide AST audit now reports no undocumented exported declarations or struct fields.
|
||||||
|
- Corrected draft-provider Godoc to avoid promising cryptographic unpredictability from `math/rand/v2` IDs.
|
||||||
|
- Marked v1 compatibility surfaces that may change in v2: `PollAnswer` voter pointers, context-required runners, error-returning keyboard builders, strict rich-message parsing, lossless unknown rich types, bounded downloads, compatibility aliases, and corrected public field names.
|
||||||
|
- Clarified that drop-overflow mode rejects outgoing API requests, one-shot asynchronous runners are awaited during shutdown, and pending uploads are drained by the shared API client.
|
||||||
|
|
||||||
|
### CI
|
||||||
|
- Pinned the lint workflow to Go `1.26.6`, `golangci/golangci-lint-action@v9.0.0`, and golangci-lint `v2.12.2` for reproducible analysis.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression coverage for limiter concurrency and cooldown behavior, scene lock scope, all scene handler error paths, polling, handler, and worker panics, asynchronous observer delivery, cancellation, and bounded shutdown, asynchronous middleware lifecycle, logger ownership, runner and policy cancellation, nil configuration inputs, draft cleanup, command parsing, command validation and partial scopes, keyboard byte boundaries and rows, MarkdownV2 vectors, numeric binding boundaries, rich JSON and renderer depth limits, strict rich roots, rich-message editing, business-message helpers and photo replacement, bounded file downloads, retry caps, streaming multipart replay, and corrected Telegram wire keys.
|
||||||
|
|
||||||
## v1.1.0
|
## v1.1.0
|
||||||
|
|
||||||
### Breaking Changes
|
### Breaking Changes
|
||||||
|
|||||||
@@ -120,6 +120,8 @@ func main() {
|
|||||||
9. `RunWebhookWithContext(...)`: Starts the bot-owned webhook runtime when Telegram should deliver updates over HTTP instead of long polling.
|
9. `RunWebhookWithContext(...)`: Starts the bot-owned webhook runtime when Telegram should deliver updates over HTTP instead of long polling.
|
||||||
10. A `Bot` instance is single-use. After `Run()`, `RunWithContext()`, or `RunWebhookWithContext()` returns, create a new bot instance for the next session.
|
10. A `Bot` instance is single-use. After `Run()`, `RunWithContext()`, or `RunWebhookWithContext()` returns, create a new bot instance for the next session.
|
||||||
|
|
||||||
|
For tests or custom transports, use `NewBotWithAPI[T](opts, api)` with a preconfigured `*tgapi.API`. The bot takes ownership of that client and closes it from `Bot.Close`; API transport, retry, and rate-limit fields in `BotOpts` do not override the supplied client.
|
||||||
|
|
||||||
## File-Based Config
|
## File-Based Config
|
||||||
|
|
||||||
`BotOpts` can also be loaded from or saved to config files through the file codec API.
|
`BotOpts` can also be loaded from or saved to config files through the file codec API.
|
||||||
@@ -217,6 +219,12 @@ This split keeps method intent explicit: JSON-only calls go through `API`, file
|
|||||||
|
|
||||||
For advanced cases, `tgapi.NewRequest(...)` and `tgapi.NewUploaderRequest(...)` remain public as low-level escape hatches. They are intentionally less safe than method-specific helpers: callers must supply the correct Telegram method name and compatible request/response types themselves.
|
For advanced cases, `tgapi.NewRequest(...)` and `tgapi.NewUploaderRequest(...)` remain public as low-level escape hatches. They are intentionally less safe than method-specific helpers: callers must supply the correct Telegram method name and compatible request/response types themselves.
|
||||||
|
|
||||||
|
Automatic retries after Telegram `429` responses are bounded to three by
|
||||||
|
default; configure the cap with `NewAPIOpts(...).SetMaxRetries(...)`. Multipart
|
||||||
|
uploads stream the encoded request instead of duplicating the complete body in
|
||||||
|
memory. For downloads with an unknown size, use `OpenFileByLinkWithContext` or
|
||||||
|
set an explicit bound with `GetFileByLinkLimitWithContext`.
|
||||||
|
|
||||||
### App Data
|
### App Data
|
||||||
|
|
||||||
The `T` in `NewBot[T]` is a powerful feature. You can pass any type, but shared dependencies such as database pools, service containers, or API clients should usually use a pointer type.
|
The `T` in `NewBot[T]` is a powerful feature. You can pass any type, but shared dependencies such as database pools, service containers, or API clients should usually use a pointer type.
|
||||||
@@ -273,7 +281,10 @@ plugin.Scene("signup").
|
|||||||
Runners are background tasks that execute alongside the bot runtime. They are registered before the bot starts and launched automatically when the bot starts.
|
Runners are background tasks that execute alongside the bot runtime. They are registered before the bot starts and launched automatically when the bot starts.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "time"
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
// One-shot runner — fires once in a goroutine when the bot starts (default).
|
// One-shot runner — fires once in a goroutine when the bot starts (default).
|
||||||
bot.AddRunner(
|
bot.AddRunner(
|
||||||
@@ -284,8 +295,8 @@ bot.AddRunner(
|
|||||||
|
|
||||||
// Periodic runner — fires every 10 minutes in a goroutine.
|
// Periodic runner — fires every 10 minutes in a goroutine.
|
||||||
bot.AddRunner(
|
bot.AddRunner(
|
||||||
laniakea.NewRunner("refresh-stats", func(b *laniakea.Bot[*MyDB]) error {
|
laniakea.NewContextRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||||
return b.GetAppData().RefreshStats()
|
return b.GetAppData().RefreshStats(ctx)
|
||||||
}).Every(10 * time.Minute),
|
}).Every(10 * time.Minute),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -301,6 +312,9 @@ Builder methods:
|
|||||||
- `Async(bool) *Runner[T]` — if `true` (default), runs in a goroutine; if `false`, blocks runtime startup.
|
- `Async(bool) *Runner[T]` — if `true` (default), runs in a goroutine; if `false`, blocks runtime startup.
|
||||||
- `Every(time.Duration) *Runner[T]` — sets the repeat interval. Zero (default) means run once; positive value repeats. Periodic runners require `Async(true)`.
|
- `Every(time.Duration) *Runner[T]` — sets the repeat interval. Zero (default) means run once; positive value repeats. Periodic runners require `Async(true)`.
|
||||||
|
|
||||||
|
Prefer `NewContextRunner` for I/O and blocking work. Its context is canceled
|
||||||
|
when polling or webhook execution stops, allowing shutdown to complete.
|
||||||
|
|
||||||
## 🧩 Middleware
|
## 🧩 Middleware
|
||||||
Middleware are functions that run before a command handler. They are perfect for cross-cutting concerns like logging, access control, rate limiting, or modifying the context.
|
Middleware are functions that run before a command handler. They are perfect for cross-cutting concerns like logging, access control, rate limiting, or modifying the context.
|
||||||
|
|
||||||
@@ -350,7 +364,9 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
|||||||
|
|
||||||
## ⚙️ Advanced Configuration
|
## ⚙️ Advanced Configuration
|
||||||
- **Inline Keyboards**: Build keyboards using `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64`, or `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` defines the default payload format, and `InlineKeyboard.SetPayloadType(...)` overrides it for one keyboard.
|
- **Inline Keyboards**: Build keyboards using `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64`, or `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` defines the default payload format, and `InlineKeyboard.SetPayloadType(...)` overrides it for one keyboard.
|
||||||
|
- **Keyboard Validation**: Call `InlineKeyboard.GetValidated()` before sending untrusted or dynamically generated callback payloads; Telegram limits `callback_data` to 1–64 bytes.
|
||||||
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
|
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
|
||||||
|
- **Observers**: Runtime observer callbacks are dispatched asynchronously in order through a bounded queue. Slow observers do not block handlers; overload drops events with sampled warnings, and shutdown drains queued events.
|
||||||
- **Localization**: `L10n` is safe for concurrent use once attached to the bot.
|
- **Localization**: `L10n` is safe for concurrent use once attached to the bot.
|
||||||
- **Custom Update Handlers**: Use `plugin.AddUpdateHandler(...)` for Telegram update types that are not part of the command/payload flow.
|
- **Custom Update Handlers**: Use `plugin.AddUpdateHandler(...)` for Telegram update types that are not part of the command/payload flow.
|
||||||
- **Lifecycle**: `RunWithContext(...)` and `RunWebhookWithContext(...)` do not call `Close()` for you. Shut the bot down explicitly, and create a fresh `Bot` for the next run.
|
- **Lifecycle**: `RunWithContext(...)` and `RunWebhookWithContext(...)` do not call `Close()` for you. Shut the bot down explicitly, and create a fresh `Bot` for the next run.
|
||||||
|
|||||||
+20
-3
@@ -121,6 +121,8 @@ func main() {
|
|||||||
9. `RunWebhookWithContext(...)`: Запускает bot-owned webhook runtime, когда Telegram должен доставлять update по HTTP вместо long polling.
|
9. `RunWebhookWithContext(...)`: Запускает bot-owned webhook runtime, когда Telegram должен доставлять update по HTTP вместо long polling.
|
||||||
10. Экземпляр `Bot` одноразовый. После завершения `Run()`, `RunWithContext()` или `RunWebhookWithContext()` для следующего запуска создавайте новый бот.
|
10. Экземпляр `Bot` одноразовый. После завершения `Run()`, `RunWithContext()` или `RunWebhookWithContext()` для следующего запуска создавайте новый бот.
|
||||||
|
|
||||||
|
Для тестов или собственного transport используй `NewBotWithAPI[T](opts, api)` с заранее настроенным `*tgapi.API`. Бот становится владельцем этого клиента и закрывает его в `Bot.Close`; настройки transport, retry и rate limit из `BotOpts` не переопределяют переданный клиент.
|
||||||
|
|
||||||
## Конфиг из файла
|
## Конфиг из файла
|
||||||
|
|
||||||
`BotOpts` можно не только собирать вручную или из environment, но и загружать и сохранять через file codec API.
|
`BotOpts` можно не только собирать вручную или из environment, но и загружать и сохранять через file codec API.
|
||||||
@@ -261,7 +263,10 @@ plugin.Scene("signup").
|
|||||||
Раннеры — фоновые задачи, которые выполняются вместе с bot runtime. Они регистрируются до запуска бота и автоматически запускаются при старте.
|
Раннеры — фоновые задачи, которые выполняются вместе с bot runtime. Они регистрируются до запуска бота и автоматически запускаются при старте.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "time"
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
// Одноразовый раннер — запускается один раз в горутине при старте (по умолчанию).
|
// Одноразовый раннер — запускается один раз в горутине при старте (по умолчанию).
|
||||||
bot.AddRunner(
|
bot.AddRunner(
|
||||||
@@ -272,8 +277,8 @@ bot.AddRunner(
|
|||||||
|
|
||||||
// Периодический раннер — запускается каждые 10 минут в горутине.
|
// Периодический раннер — запускается каждые 10 минут в горутине.
|
||||||
bot.AddRunner(
|
bot.AddRunner(
|
||||||
laniakea.NewRunner("refresh-stats", func(b *laniakea.Bot[*MyDB]) error {
|
laniakea.NewContextRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||||
return b.GetAppData().RefreshStats()
|
return b.GetAppData().RefreshStats(ctx)
|
||||||
}).Every(10 * time.Minute),
|
}).Every(10 * time.Minute),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -289,6 +294,9 @@ bot.AddRunner(
|
|||||||
- `Async(bool) *Runner[T]` — если `true` (по умолчанию), запускается в горутине; если `false`, блокирует запуск runtime.
|
- `Async(bool) *Runner[T]` — если `true` (по умолчанию), запускается в горутине; если `false`, блокирует запуск runtime.
|
||||||
- `Every(time.Duration) *Runner[T]` — задаёт интервал повторного запуска. Ноль (по умолчанию) означает одноразовый запуск; положительное значение — периодический. Периодические раннеры требуют `Async(true)`.
|
- `Every(time.Duration) *Runner[T]` — задаёт интервал повторного запуска. Ноль (по умолчанию) означает одноразовый запуск; положительное значение — периодический. Периодические раннеры требуют `Async(true)`.
|
||||||
|
|
||||||
|
Для I/O и блокирующей работы предпочитайте `NewContextRunner`. Его context
|
||||||
|
отменяется при остановке polling или webhook runtime, поэтому shutdown может завершиться.
|
||||||
|
|
||||||
### tgapi: API и Uploader
|
### tgapi: API и Uploader
|
||||||
|
|
||||||
В `tgapi` есть два клиента:
|
В `tgapi` есть два клиента:
|
||||||
@@ -298,6 +306,13 @@ bot.AddRunner(
|
|||||||
|
|
||||||
Для продвинутых сценариев `tgapi.NewRequest(...)` и `tgapi.NewUploaderRequest(...)` остаются публичными low-level escape hatch API. Они менее безопасны, чем типизированные helper-методы: вызывающая сторона сама отвечает за корректное имя Telegram-метода и совместимые типы параметров/ответа.
|
Для продвинутых сценариев `tgapi.NewRequest(...)` и `tgapi.NewUploaderRequest(...)` остаются публичными low-level escape hatch API. Они менее безопасны, чем типизированные helper-методы: вызывающая сторона сама отвечает за корректное имя Telegram-метода и совместимые типы параметров/ответа.
|
||||||
|
|
||||||
|
Автоматические повторы после ответа Telegram `429` по умолчанию ограничены
|
||||||
|
тремя; предел настраивается через `NewAPIOpts(...).SetMaxRetries(...)`.
|
||||||
|
Multipart upload кодируется потоком без второй полной копии request body в
|
||||||
|
памяти. Для download неизвестного размера используйте
|
||||||
|
`OpenFileByLinkWithContext` либо задайте явный предел через
|
||||||
|
`GetFileByLinkLimitWithContext`.
|
||||||
|
|
||||||
## 🧩 Промежуточные слои (Middleware)
|
## 🧩 Промежуточные слои (Middleware)
|
||||||
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
||||||
|
|
||||||
@@ -347,7 +362,9 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
|||||||
|
|
||||||
## ⚙️ Расширенная настройка
|
## ⚙️ Расширенная настройка
|
||||||
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
||||||
|
- **Валидация клавиатур**: Вызывайте `InlineKeyboard.GetValidated()` перед отправкой недоверенных или динамически собранных callback payload; Telegram ограничивает `callback_data` диапазоном 1–64 байта.
|
||||||
- **Ограничение запросов**: Передайте настроенный `utils.RateLimiter` через `BotOpts` для корректной обработки лимитов Telegram.
|
- **Ограничение запросов**: Передайте настроенный `utils.RateLimiter` через `BotOpts` для корректной обработки лимитов Telegram.
|
||||||
|
- **Observer**: Во время runtime callbacks observer выполняются асинхронно и по порядку через ограниченную очередь. Медленный observer не блокирует handlers; при переполнении события отбрасываются с редкими предупреждениями, а shutdown обрабатывает уже поставленные в очередь события.
|
||||||
- **Локализация**: `L10n` безопасен для конкурентного использования после подключения к боту.
|
- **Локализация**: `L10n` безопасен для конкурентного использования после подключения к боту.
|
||||||
- **Пользовательские update handlers**: Используйте `plugin.AddUpdateHandler(...)` для Telegram update types вне command/payload flow.
|
- **Пользовательские update handlers**: Используйте `plugin.AddUpdateHandler(...)` для Telegram update types вне command/payload flow.
|
||||||
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebhookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebhookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
||||||
|
|||||||
@@ -103,6 +103,10 @@ type Bot[T AppData] struct {
|
|||||||
requestLogger *sneklog.Logger // Optional request-level API logging
|
requestLogger *sneklog.Logger // Optional request-level API logging
|
||||||
useReqLogger bool
|
useReqLogger bool
|
||||||
webhookLogger *sneklog.Logger // Webhook logger. Available only after Bot.RunWebhookWithContext.
|
webhookLogger *sneklog.Logger // Webhook logger. Available only after Bot.RunWebhookWithContext.
|
||||||
|
loggerOwned bool
|
||||||
|
requestLoggerOwned bool
|
||||||
|
webhookLoggerOwned bool
|
||||||
|
detachedOwnedLoggers []*sneklog.Logger
|
||||||
extraLoggers extypes.Slice[*sneklog.Logger] // API, Uploader, and custom loggers
|
extraLoggers extypes.Slice[*sneklog.Logger] // API, Uploader, and custom loggers
|
||||||
|
|
||||||
plugins []Plugin[T] // Command/event handlers
|
plugins []Plugin[T] // Command/event handlers
|
||||||
@@ -115,6 +119,7 @@ type Bot[T AppData] struct {
|
|||||||
l10n *L10n // Localization manager
|
l10n *L10n // Localization manager
|
||||||
draftProvider *DraftProvider // Draft message builder
|
draftProvider *DraftProvider // Draft message builder
|
||||||
observer Observer // Optional event observer for instrumentation
|
observer Observer // Optional event observer for instrumentation
|
||||||
|
observerAsync *observerDispatcher
|
||||||
|
|
||||||
appData T // Injected application data
|
appData T // Injected application data
|
||||||
hasAppData bool
|
hasAppData bool
|
||||||
@@ -130,6 +135,7 @@ type Bot[T AppData] struct {
|
|||||||
updateQueue chan *tgapi.Update // Internal queue for processing updates
|
updateQueue chan *tgapi.Update // Internal queue for processing updates
|
||||||
runnerOnceWG sync.WaitGroup // Tracks one-time async runners
|
runnerOnceWG sync.WaitGroup // Tracks one-time async runners
|
||||||
runnerBgWG sync.WaitGroup // Tracks background async runners
|
runnerBgWG sync.WaitGroup // Tracks background async runners
|
||||||
|
middlewareWG sync.WaitGroup // Tracks asynchronous middleware callbacks
|
||||||
runStateMu sync.Mutex
|
runStateMu sync.Mutex
|
||||||
running bool
|
running bool
|
||||||
ran bool
|
ran bool
|
||||||
@@ -156,6 +162,20 @@ func (bot *Bot[T]) configMutable(method string) bool {
|
|||||||
// - Sets up DraftProvider with random IDs
|
// - Sets up DraftProvider with random IDs
|
||||||
// - Adds API and Uploader loggers to extraLoggers
|
// - Adds API and Uploader loggers to extraLoggers
|
||||||
func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||||
|
return newBot[T](opts, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewBotWithAPI creates a Bot using a preconfigured API client.
|
||||||
|
// The Bot takes ownership of api and closes it from Bot.Close. API transport,
|
||||||
|
// retry, and rate-limit fields in opts do not reconfigure the supplied client.
|
||||||
|
func NewBotWithAPI[T any](opts *BotOpts, api *tgapi.API) (*Bot[T], error) {
|
||||||
|
if api == nil {
|
||||||
|
return nil, ErrAPIIsNil
|
||||||
|
}
|
||||||
|
return newBot[T](opts, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBot[T any](opts *BotOpts, api *tgapi.API) (*Bot[T], error) {
|
||||||
if opts == nil {
|
if opts == nil {
|
||||||
return nil, ErrOptsIsNil
|
return nil, ErrOptsIsNil
|
||||||
}
|
}
|
||||||
@@ -181,6 +201,7 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
|||||||
// HTTP client timeout must exceed pollTimeout to avoid spurious deadline
|
// HTTP client timeout must exceed pollTimeout to avoid spurious deadline
|
||||||
// errors that the polling loop would misinterpret as context cancellation.
|
// errors that the polling loop would misinterpret as context cancellation.
|
||||||
httpTimeout := time.Duration(pollTimeout)*time.Second + 60*time.Second
|
httpTimeout := time.Duration(pollTimeout)*time.Second + 60*time.Second
|
||||||
|
if api == nil {
|
||||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||||
SetAPIURL(opts.APIURL).
|
SetAPIURL(opts.APIURL).
|
||||||
UseTestServer(opts.UseTestServer).
|
UseTestServer(opts.UseTestServer).
|
||||||
@@ -189,7 +210,8 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
|||||||
SetLogFormat(opts.LogFormat).
|
SetLogFormat(opts.LogFormat).
|
||||||
SetLogFormatter(opts.LogFormatter).
|
SetLogFormatter(opts.LogFormatter).
|
||||||
SetHTTPClient(&http.Client{Timeout: httpTimeout})
|
SetHTTPClient(&http.Client{Timeout: httpTimeout})
|
||||||
api := tgapi.NewAPI(apiOpts)
|
api = tgapi.NewAPI(apiOpts)
|
||||||
|
}
|
||||||
uploader := tgapi.NewUploader(api)
|
uploader := tgapi.NewUploader(api)
|
||||||
|
|
||||||
prefixes := append([]string(nil), opts.Prefixes...)
|
prefixes := append([]string(nil), opts.Prefixes...)
|
||||||
@@ -264,21 +286,66 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
|||||||
return bot, nil
|
return bot, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetLogger replaces the main bot logger.
|
// SetLogger replaces the main bot logger before runtime starts.
|
||||||
func (bot *Bot[T]) SetLogger(l *sneklog.Logger) *Bot[T] {
|
func (bot *Bot[T]) SetLogger(l *sneklog.Logger) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetLogger") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("SetLogger called with nil logger; nothing changed")
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == bot.logger {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.addTokenReplacer(l)
|
||||||
|
bot.closeReplacedLogger(bot.logger, bot.loggerOwned, l, bot.requestLogger, bot.webhookLogger)
|
||||||
bot.logger = l
|
bot.logger = l
|
||||||
|
bot.loggerOwned = false
|
||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetRequestLogger replaces the request-level logger.
|
// SetRequestLogger replaces the request-level logger before runtime starts.
|
||||||
func (bot *Bot[T]) SetRequestLogger(l *sneklog.Logger) *Bot[T] {
|
func (bot *Bot[T]) SetRequestLogger(l *sneklog.Logger) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetRequestLogger") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("SetRequestLogger called with nil logger; nothing changed")
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == bot.requestLogger {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.addTokenReplacer(l)
|
||||||
|
bot.closeReplacedLogger(bot.requestLogger, bot.requestLoggerOwned, l, bot.logger, bot.webhookLogger)
|
||||||
bot.requestLogger = l
|
bot.requestLogger = l
|
||||||
|
bot.requestLoggerOwned = false
|
||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetWebhookLogger replaces the webhook logger.
|
// SetWebhookLogger replaces the webhook logger before runtime starts.
|
||||||
func (bot *Bot[T]) SetWebhookLogger(l *sneklog.Logger) *Bot[T] {
|
func (bot *Bot[T]) SetWebhookLogger(l *sneklog.Logger) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetWebhookLogger") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("SetWebhookLogger called with nil logger; nothing changed")
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == bot.webhookLogger {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.addTokenReplacer(l)
|
||||||
|
bot.closeReplacedLogger(bot.webhookLogger, bot.webhookLoggerOwned, l, bot.logger, bot.requestLogger)
|
||||||
bot.webhookLogger = l
|
bot.webhookLogger = l
|
||||||
|
bot.webhookLoggerOwned = false
|
||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,10 +358,11 @@ func (bot *Bot[T]) GetUploader() *tgapi.Uploader { return bot.uploader }
|
|||||||
// Close gracefully shuts down bot-owned resources.
|
// Close gracefully shuts down bot-owned resources.
|
||||||
//
|
//
|
||||||
// Close shuts down, in order:
|
// Close shuts down, in order:
|
||||||
|
// - The asynchronous observer dispatcher, after draining queued events
|
||||||
// - Registered plugins via Plugin.Close
|
// - Registered plugins via Plugin.Close
|
||||||
// - Webhook logger (if initialized)
|
// - Webhook logger (if initialized)
|
||||||
// - Uploader (waits for pending uploads)
|
// - Uploader logger resources
|
||||||
// - API client internals
|
// - API client internals, after pending API and upload requests complete
|
||||||
// - RequestLogger (if enabled)
|
// - RequestLogger (if enabled)
|
||||||
// - Main logger
|
// - Main logger
|
||||||
//
|
//
|
||||||
@@ -314,17 +382,34 @@ func (bot *Bot[T]) Close() error {
|
|||||||
}
|
}
|
||||||
e = append(e, err)
|
e = append(e, err)
|
||||||
}
|
}
|
||||||
|
observerCtx, observerCancel := context.WithTimeout(context.Background(), observerShutdownTimeout)
|
||||||
|
logCloseErr(bot.stopObserverDispatcher(observerCtx))
|
||||||
|
observerCancel()
|
||||||
|
|
||||||
for _, p := range bot.plugins {
|
for _, p := range bot.plugins {
|
||||||
if err := p.Close(); err != nil {
|
if err := p.Close(); err != nil {
|
||||||
e = append(e, err)
|
e = append(e, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if bot.webhookLogger != nil {
|
closedLoggers := make(map[*sneklog.Logger]struct{}, 3)
|
||||||
if err := bot.webhookLogger.Close(); err != nil {
|
closeOwnedLogger := func(logger *sneklog.Logger, owned bool) {
|
||||||
logCloseErr(err)
|
if logger == nil || !owned {
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
if _, exists := closedLoggers[logger]; exists {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
closedLoggers[logger] = struct{}{}
|
||||||
|
logCloseErr(logger.Close())
|
||||||
|
}
|
||||||
|
for _, logger := range bot.detachedOwnedLoggers {
|
||||||
|
closeOwnedLogger(logger, true)
|
||||||
|
}
|
||||||
|
bot.detachedOwnedLoggers = nil
|
||||||
|
if bot.webhookLogger != nil {
|
||||||
|
closeOwnedLogger(bot.webhookLogger, bot.webhookLoggerOwned)
|
||||||
bot.webhookLogger = nil
|
bot.webhookLogger = nil
|
||||||
|
bot.webhookLoggerOwned = false
|
||||||
}
|
}
|
||||||
if bot.uploader != nil {
|
if bot.uploader != nil {
|
||||||
if err := bot.uploader.Close(); err != nil {
|
if err := bot.uploader.Close(); err != nil {
|
||||||
@@ -337,14 +422,14 @@ func (bot *Bot[T]) Close() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if bot.requestLogger != nil {
|
if bot.requestLogger != nil {
|
||||||
if err := bot.requestLogger.Close(); err != nil {
|
closeOwnedLogger(bot.requestLogger, bot.requestLoggerOwned)
|
||||||
logCloseErr(err)
|
bot.requestLogger = nil
|
||||||
}
|
bot.requestLoggerOwned = false
|
||||||
}
|
}
|
||||||
if bot.logger != nil {
|
if bot.logger != nil {
|
||||||
if err := bot.logger.Close(); err != nil {
|
closeOwnedLogger(bot.logger, bot.loggerOwned)
|
||||||
e = append(e, err)
|
bot.logger = nil
|
||||||
}
|
bot.loggerOwned = false
|
||||||
}
|
}
|
||||||
return errors.Join(e...)
|
return errors.Join(e...)
|
||||||
}
|
}
|
||||||
@@ -434,25 +519,31 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
|||||||
defer bot.finishRun()
|
defer bot.finishRun()
|
||||||
if !bot.useReqLogger && bot.requestLogger != nil {
|
if !bot.useReqLogger && bot.requestLogger != nil {
|
||||||
bot.logger.Warnln("Opts#UseRequestLogger is false, but Bot#requestLogger present. Remove Bot#SetRequestLogger or set Opts#UseRequestLogger to true!")
|
bot.logger.Warnln("Opts#UseRequestLogger is false, but Bot#requestLogger present. Remove Bot#SetRequestLogger or set Opts#UseRequestLogger to true!")
|
||||||
err := bot.requestLogger.Close()
|
if bot.requestLoggerOwned {
|
||||||
if err != nil {
|
if err := bot.requestLogger.Close(); err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
bot.requestLogger = nil
|
bot.requestLogger = nil
|
||||||
|
bot.requestLoggerOwned = false
|
||||||
}
|
}
|
||||||
if bot.webhookLogger != nil {
|
if bot.webhookLogger != nil {
|
||||||
bot.logger.Warnln("Bot#webhookLogger present. You shouldn't set this, if ran in Long Polling mode!")
|
bot.logger.Warnln("Bot#webhookLogger present. You shouldn't set this, if ran in Long Polling mode!")
|
||||||
err := bot.webhookLogger.Close()
|
if bot.webhookLoggerOwned {
|
||||||
if err != nil {
|
if err := bot.webhookLogger.Close(); err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
bot.webhookLogger = nil
|
bot.webhookLogger = nil
|
||||||
|
bot.webhookLoggerOwned = false
|
||||||
}
|
}
|
||||||
|
|
||||||
bot.ExecRunners(ctx)
|
bot.ExecRunners(ctx)
|
||||||
|
|
||||||
// Start update polling in a goroutine
|
// Start update polling in a goroutine
|
||||||
|
pollDone := make(chan error, 1)
|
||||||
go func() {
|
go func() {
|
||||||
|
var terminalErr error
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
bot.logger.Errorln(fmt.Sprintf("panic in update polling: %v", r))
|
bot.logger.Errorln(fmt.Sprintf("panic in update polling: %v", r))
|
||||||
@@ -460,6 +551,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
|||||||
if !ok {
|
if !ok {
|
||||||
err = fmt.Errorf("%v", r)
|
err = fmt.Errorf("%v", r)
|
||||||
}
|
}
|
||||||
|
terminalErr = fmt.Errorf("update polling: %w: %v", ErrHandlerPanic, err)
|
||||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
Plugin: "bot",
|
Plugin: "bot",
|
||||||
HandlerKind: HandlerPollingKind,
|
HandlerKind: HandlerPollingKind,
|
||||||
@@ -469,6 +561,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
close(bot.updateQueue)
|
close(bot.updateQueue)
|
||||||
|
pollDone <- terminalErr
|
||||||
}()
|
}()
|
||||||
backoffDelay := time.Duration(0)
|
backoffDelay := time.Duration(0)
|
||||||
retryCount := 0
|
retryCount := 0
|
||||||
@@ -533,7 +626,8 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
|||||||
|
|
||||||
bot.runnerOnceWG.Wait()
|
bot.runnerOnceWG.Wait()
|
||||||
bot.runnerBgWG.Wait()
|
bot.runnerBgWG.Wait()
|
||||||
return nil
|
bot.middlewareWG.Wait()
|
||||||
|
return <-pollDone
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run starts the bot using a background context.
|
// Run starts the bot using a background context.
|
||||||
|
|||||||
+5
-5
@@ -54,8 +54,8 @@ type BotOpts struct {
|
|||||||
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
||||||
RateLimit int
|
RateLimit int
|
||||||
|
|
||||||
// DropRateLimitOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
// DropRateLimitOverflow rejects outgoing Telegram API requests immediately when
|
||||||
// Use this to prioritize responsiveness over reliability.
|
// rate-limit capacity is unavailable instead of waiting for capacity.
|
||||||
DropRateLimitOverflow bool
|
DropRateLimitOverflow bool
|
||||||
|
|
||||||
// StrictPayloadType disables callback payload fallback decoding.
|
// StrictPayloadType disables callback payload fallback decoding.
|
||||||
@@ -96,7 +96,7 @@ type BotOpts struct {
|
|||||||
// - USE_TEST_SERVER: "true" to use Telegram test server
|
// - USE_TEST_SERVER: "true" to use Telegram test server
|
||||||
// - API_URL: custom API endpoint
|
// - API_URL: custom API endpoint
|
||||||
// - RATE_LIMIT: max requests per second (default: 30)
|
// - RATE_LIMIT: max requests per second (default: 30)
|
||||||
// - DROP_RL_OVERFLOW: "true" to drop updates on rate limit overflow
|
// - DROP_RL_OVERFLOW: "true" to reject rate-limited API requests instead of waiting
|
||||||
// - STRICT_PAYLOAD_TYPE: "true" to reject callback payloads encoded in a different format
|
// - STRICT_PAYLOAD_TYPE: "true" to reject callback payloads encoded in a different format
|
||||||
// - MAX_WORKERS: maximum number of concurrent update handlers (default: 32)
|
// - MAX_WORKERS: maximum number of concurrent update handlers (default: 32)
|
||||||
// - POLL_TIMEOUT: long-polling timeout in seconds for getUpdates (default: 30)
|
// - POLL_TIMEOUT: long-polling timeout in seconds for getUpdates (default: 30)
|
||||||
@@ -237,8 +237,8 @@ func (opts *BotOpts) SetRateLimit(limit int) *BotOpts {
|
|||||||
return opts
|
return opts
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDropRateLimitOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
// SetDropRateLimitOverflow configures outgoing Telegram API requests to fail
|
||||||
// Use this to prioritize responsiveness over reliability. Default is false.
|
// immediately when rate-limit capacity is unavailable. Default is false.
|
||||||
func (opts *BotOpts) SetDropRateLimitOverflow(drop bool) *BotOpts {
|
func (opts *BotOpts) SetDropRateLimitOverflow(drop bool) *BotOpts {
|
||||||
opts.DropRateLimitOverflow = drop
|
opts.DropRateLimitOverflow = drop
|
||||||
return opts
|
return opts
|
||||||
|
|||||||
+23
-1
@@ -34,15 +34,25 @@ type botOptsFileJSONAPI struct {
|
|||||||
|
|
||||||
// BotOptsFileJSON is the JSON file representation of BotOpts.
|
// BotOptsFileJSON is the JSON file representation of BotOpts.
|
||||||
type BotOptsFileJSON struct {
|
type BotOptsFileJSON struct {
|
||||||
|
// Version identifies the JSON configuration format version.
|
||||||
Version int `json:"version"`
|
Version int `json:"version"`
|
||||||
|
// Token is the Telegram bot token.
|
||||||
Token string `json:"token"`
|
Token string `json:"token"`
|
||||||
|
// UpdateTypes limits the update kinds requested from Telegram.
|
||||||
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||||
|
// Debug enables debug logging.
|
||||||
Debug bool `json:"debug"`
|
Debug bool `json:"debug"`
|
||||||
|
// ErrorTemplate formats user-facing handler errors.
|
||||||
ErrorTemplate string `json:"error_template"`
|
ErrorTemplate string `json:"error_template"`
|
||||||
|
// Prefixes contains accepted command prefixes.
|
||||||
Prefixes []string `json:"prefixes"`
|
Prefixes []string `json:"prefixes"`
|
||||||
|
// Logger contains file logging options.
|
||||||
Logger botOptsFileJSONLogger `json:"logger"`
|
Logger botOptsFileJSONLogger `json:"logger"`
|
||||||
|
// API contains Telegram client and rate-limit options.
|
||||||
API botOptsFileJSONAPI `json:"api"`
|
API botOptsFileJSONAPI `json:"api"`
|
||||||
|
// StrictPayloadType requires callback payloads to use the configured encoding.
|
||||||
StrictPayloadType bool `json:"strict_payload_type"`
|
StrictPayloadType bool `json:"strict_payload_type"`
|
||||||
|
// MaxWorkers limits concurrent update handlers.
|
||||||
MaxWorkers int `json:"max_workers"`
|
MaxWorkers int `json:"max_workers"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,6 +97,9 @@ func (codec BotOptsFileJSONCodec) FromBytes(data []byte) (*BotOpts, error) {
|
|||||||
|
|
||||||
// ToBytes encodes BotOpts into JSON file bytes.
|
// ToBytes encodes BotOpts into JSON file bytes.
|
||||||
func (codec BotOptsFileJSONCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
func (codec BotOptsFileJSONCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
||||||
|
if opts == nil {
|
||||||
|
return nil, ErrOptsIsNil
|
||||||
|
}
|
||||||
fileOpts := &BotOptsFileJSON{
|
fileOpts := &BotOptsFileJSON{
|
||||||
Version: ConfigVersion,
|
Version: ConfigVersion,
|
||||||
Token: opts.Token,
|
Token: opts.Token,
|
||||||
@@ -133,7 +146,7 @@ func (codec BotOptsFileJSONCodec) EscapeEnv(s string) string {
|
|||||||
return string(data[1 : len(data)-1])
|
return string(data[1 : len(data)-1])
|
||||||
}
|
}
|
||||||
|
|
||||||
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*\}\}`)
|
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*}}`)
|
||||||
|
|
||||||
type botOptsFileEnvEscaper interface {
|
type botOptsFileEnvEscaper interface {
|
||||||
EscapeEnv(string) string
|
EscapeEnv(string) string
|
||||||
@@ -149,6 +162,9 @@ type BotOptsFileCodec interface {
|
|||||||
|
|
||||||
// LoadBotOptsFile reads a config file, expands env placeholders, and decodes BotOpts.
|
// LoadBotOptsFile reads a config file, expands env placeholders, and decodes BotOpts.
|
||||||
func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error) {
|
func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error) {
|
||||||
|
if isNilValue(codec) {
|
||||||
|
return nil, ErrCodecIsNil
|
||||||
|
}
|
||||||
f, err := os.Open(filename)
|
f, err := os.Open(filename)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -164,6 +180,12 @@ func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error)
|
|||||||
|
|
||||||
// SaveBotOptsFile encodes BotOpts with codec and writes the result to filename.
|
// SaveBotOptsFile encodes BotOpts with codec and writes the result to filename.
|
||||||
func SaveBotOptsFile(codec BotOptsFileCodec, filename string, opts *BotOpts) error {
|
func SaveBotOptsFile(codec BotOptsFileCodec, filename string, opts *BotOpts) error {
|
||||||
|
if isNilValue(codec) {
|
||||||
|
return ErrCodecIsNil
|
||||||
|
}
|
||||||
|
if opts == nil {
|
||||||
|
return ErrOptsIsNil
|
||||||
|
}
|
||||||
data, err := codec.ToBytes(opts)
|
data, err := codec.ToBytes(opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
@@ -46,6 +46,21 @@ func TestBotOptsFileJSONCodecRoundTrip(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBotOptsFileRejectsNilInputs(t *testing.T) {
|
||||||
|
if _, err := (BotOptsFileJSONCodec{}).ToBytes(nil); !errors.Is(err, ErrOptsIsNil) {
|
||||||
|
t.Fatalf("ToBytes error = %v, want ErrOptsIsNil", err)
|
||||||
|
}
|
||||||
|
if _, err := LoadBotOptsFile(nil, "unused"); !errors.Is(err, ErrCodecIsNil) {
|
||||||
|
t.Fatalf("LoadBotOptsFile error = %v, want ErrCodecIsNil", err)
|
||||||
|
}
|
||||||
|
if err := SaveBotOptsFile(nil, "unused", &BotOpts{}); !errors.Is(err, ErrCodecIsNil) {
|
||||||
|
t.Fatalf("SaveBotOptsFile error = %v, want ErrCodecIsNil", err)
|
||||||
|
}
|
||||||
|
if err := SaveBotOptsFile(BotOptsFileJSONCodec{}, "unused", nil); !errors.Is(err, ErrOptsIsNil) {
|
||||||
|
t.Fatalf("SaveBotOptsFile nil opts error = %v, want ErrOptsIsNil", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||||
t.Setenv("TG_TOKEN", "TOKEN_FROM_ENV")
|
t.Setenv("TG_TOKEN", "TOKEN_FROM_ENV")
|
||||||
t.Setenv("BOT_API_URL", "https://api.example.invalid")
|
t.Setenv("BOT_API_URL", "https://api.example.invalid")
|
||||||
|
|||||||
@@ -150,6 +150,15 @@ func (bot *Bot[T]) AddRunner(runner Runner[T]) *Bot[T] {
|
|||||||
// return data.QueryLogger()
|
// return data.QueryLogger()
|
||||||
// })
|
// })
|
||||||
func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddAppDataLoggerWriter") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if writer == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("AddAppDataLoggerWriter called with nil writer; nothing changed")
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
if !bot.hasAppData {
|
if !bot.hasAppData {
|
||||||
bot.logger.Warnln("app data is not set; skipping app-data logger writer")
|
bot.logger.Warnln("app data is not set; skipping app-data logger writer")
|
||||||
return bot
|
return bot
|
||||||
@@ -159,6 +168,12 @@ func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
|||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
w := writer(bot.appData)
|
w := writer(bot.appData)
|
||||||
|
if isNilValue(w) {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("app-data logger writer returned nil; nothing changed")
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
bot.logger.AddWriters(w)
|
bot.logger.AddWriters(w)
|
||||||
if bot.requestLogger != nil {
|
if bot.requestLogger != nil {
|
||||||
bot.requestLogger.AddWriters(w)
|
bot.requestLogger.AddWriters(w)
|
||||||
|
|||||||
+154
@@ -22,6 +22,14 @@ func (f pollingRoundTripFunc) RoundTrip(req *http.Request) (*http.Response, erro
|
|||||||
return f(req)
|
return f(req)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type closeCountingWriter struct{ closes int }
|
||||||
|
|
||||||
|
func (w *closeCountingWriter) Close() error { w.closes++; return nil }
|
||||||
|
func (w *closeCountingWriter) Write(p []byte) (int, error) { return len(p), nil }
|
||||||
|
func (w *closeCountingWriter) Print(sneklog.LogLevel, string, []*sneklog.MethodTraceback, ...any) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
type pollingRetryObserver struct {
|
type pollingRetryObserver struct {
|
||||||
recordingObserver
|
recordingObserver
|
||||||
cancel context.CancelFunc
|
cancel context.CancelFunc
|
||||||
@@ -48,6 +56,17 @@ func (testObserver) OnRunnerFinished(context.Context, RunnerFinishedEvent) {}
|
|||||||
func (testObserver) OnPollingRetry(context.Context, PollingRetryEvent) {}
|
func (testObserver) OnPollingRetry(context.Context, PollingRetryEvent) {}
|
||||||
func (testObserver) OnError(context.Context, ErrorEvent) {}
|
func (testObserver) OnError(context.Context, ErrorEvent) {}
|
||||||
|
|
||||||
|
type blockingObserver struct {
|
||||||
|
testObserver
|
||||||
|
started chan struct{}
|
||||||
|
release chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *blockingObserver) OnError(context.Context, ErrorEvent) {
|
||||||
|
close(o.started)
|
||||||
|
<-o.release
|
||||||
|
}
|
||||||
|
|
||||||
func TestGetUpdateTypesReturnsCopy(t *testing.T) {
|
func TestGetUpdateTypesReturnsCopy(t *testing.T) {
|
||||||
bot := &Bot[NoData]{updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage}}
|
bot := &Bot[NoData]{updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage}}
|
||||||
|
|
||||||
@@ -308,6 +327,97 @@ func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsNil(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoggerConfigurationRejectsNilAndLateMutation(t *testing.T) {
|
||||||
|
original := sneklog.NewLogger()
|
||||||
|
replacement := sneklog.NewLogger()
|
||||||
|
bot := &Bot[NoData]{logger: original, token: "secret"}
|
||||||
|
|
||||||
|
bot.SetLogger(nil)
|
||||||
|
if bot.logger != original {
|
||||||
|
t.Fatal("SetLogger(nil) replaced the logger")
|
||||||
|
}
|
||||||
|
bot.SetAppData(NoData{})
|
||||||
|
bot.AddAppDataLoggerWriter(nil)
|
||||||
|
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
defer bot.finishRun()
|
||||||
|
bot.SetLogger(replacement)
|
||||||
|
bot.SetRequestLogger(replacement)
|
||||||
|
bot.SetWebhookLogger(replacement)
|
||||||
|
if bot.logger != original || bot.requestLogger != nil || bot.webhookLogger != nil {
|
||||||
|
t.Fatal("logger configuration changed after runtime freeze")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCloseRespectsLoggerOwnershipAndAliases(t *testing.T) {
|
||||||
|
ownedWriter := new(closeCountingWriter)
|
||||||
|
owned := sneklog.NewLogger().AddWriter(ownedWriter)
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: owned, loggerOwned: true,
|
||||||
|
requestLogger: owned, requestLoggerOwned: false,
|
||||||
|
}
|
||||||
|
if err := bot.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
if ownedWriter.closes != 1 {
|
||||||
|
t.Fatalf("owned aliased logger closed %d times, want 1", ownedWriter.closes)
|
||||||
|
}
|
||||||
|
|
||||||
|
callerWriter := new(closeCountingWriter)
|
||||||
|
callerLogger := sneklog.NewLogger().AddWriter(callerWriter)
|
||||||
|
bot = &Bot[NoData]{logger: callerLogger, requestLogger: callerLogger, webhookLogger: callerLogger}
|
||||||
|
if err := bot.Close(); err != nil {
|
||||||
|
t.Fatalf("Close with caller logger returned error: %v", err)
|
||||||
|
}
|
||||||
|
if callerWriter.closes != 0 {
|
||||||
|
t.Fatalf("caller-owned logger closed %d times", callerWriter.closes)
|
||||||
|
}
|
||||||
|
_ = callerLogger.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWithContextReturnsPollingPanic(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(), prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}}, updateQueue: make(chan *tgapi.Update, 1), maxWorkers: 1,
|
||||||
|
}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
err := bot.RunWithContext(context.Background())
|
||||||
|
if !errors.Is(err, ErrHandlerPanic) {
|
||||||
|
t.Fatalf("RunWithContext error = %v, want ErrHandlerPanic", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewBotWithAPIUsesInjectedClient(t *testing.T) {
|
||||||
|
client := &http.Client{Transport: pollingRoundTripFunc(func(*http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"id":7,"is_bot":true,"first_name":"Test","username":"test_bot"}}`)),
|
||||||
|
}, nil
|
||||||
|
})}
|
||||||
|
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("http://example.invalid").SetHTTPClient(client))
|
||||||
|
bot, err := NewBotWithAPI[NoData](&BotOpts{Token: "token"}, api)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewBotWithAPI returned error: %v", err)
|
||||||
|
}
|
||||||
|
if bot.GetAPI() != api || bot.GetUploader() == nil {
|
||||||
|
t.Fatal("injected API was not used consistently")
|
||||||
|
}
|
||||||
|
if err := bot.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddAppDataLoggerWriterRejectsNilResult(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger(), hasAppData: true}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
bot.AddAppDataLoggerWriter(func(NoData) sneklog.LoggerWriter { return nil })
|
||||||
|
}
|
||||||
|
|
||||||
func TestShouldWarnOnValueAppData(t *testing.T) {
|
func TestShouldWarnOnValueAppData(t *testing.T) {
|
||||||
type testDB struct{}
|
type testDB struct{}
|
||||||
type dbIface interface{ Ping() error }
|
type dbIface interface{ Ping() error }
|
||||||
@@ -378,6 +488,50 @@ func TestSetObserverNilClearsObserver(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRuntimeObserverDispatchIsAsyncAndDrained(t *testing.T) {
|
||||||
|
observer := &blockingObserver{
|
||||||
|
started: make(chan struct{}),
|
||||||
|
release: make(chan struct{}),
|
||||||
|
}
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger(), observer: observer}
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
emitted := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
bot.safeEmitEvent(context.Background(), ErrorEvent{Err: errors.New("boom")})
|
||||||
|
close(emitted)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-emitted:
|
||||||
|
case <-time.After(100 * time.Millisecond):
|
||||||
|
t.Fatal("safeEmitEvent blocked on observer callback")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-observer.started:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("observer callback did not start")
|
||||||
|
}
|
||||||
|
|
||||||
|
finished := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
bot.finishRun()
|
||||||
|
close(finished)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-finished:
|
||||||
|
t.Fatal("finishRun returned before the queued callback completed")
|
||||||
|
case <-time.After(10 * time.Millisecond):
|
||||||
|
}
|
||||||
|
close(observer.release)
|
||||||
|
select {
|
||||||
|
case <-finished:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("finishRun did not drain observer callbacks")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestRunWithContextRejectsSecondRun(t *testing.T) {
|
func TestRunWithContextRejectsSecondRun(t *testing.T) {
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
cancel()
|
cancel()
|
||||||
|
|||||||
+46
-1
@@ -18,6 +18,8 @@ import (
|
|||||||
"github.com/alitto/pond/v2"
|
"github.com/alitto/pond/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const observerShutdownTimeout = 5 * time.Second
|
||||||
|
|
||||||
func (bot *Bot[T]) addTokenReplacer(loggers ...*sneklog.Logger) {
|
func (bot *Bot[T]) addTokenReplacer(loggers ...*sneklog.Logger) {
|
||||||
if bot.token == "" {
|
if bot.token == "" {
|
||||||
return
|
return
|
||||||
@@ -30,6 +32,19 @@ func (bot *Bot[T]) addTokenReplacer(loggers ...*sneklog.Logger) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) closeReplacedLogger(old *sneklog.Logger, owned bool, replacements ...*sneklog.Logger) {
|
||||||
|
if old == nil || !owned || len(replacements) == 0 || replacements[0] == old {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if slices.Contains(replacements[1:], old) {
|
||||||
|
bot.detachedOwnedLoggers = appendUniqueLogger(bot.detachedOwnedLoggers, old)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := old.Close(); err != nil && bot.logger != nil && bot.logger != old {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func appendUniqueLogger(loggers []*sneklog.Logger, logger *sneklog.Logger) []*sneklog.Logger {
|
func appendUniqueLogger(loggers []*sneklog.Logger, logger *sneklog.Logger) []*sneklog.Logger {
|
||||||
if logger == nil {
|
if logger == nil {
|
||||||
return loggers
|
return loggers
|
||||||
@@ -80,26 +95,32 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
|||||||
format, formatter := opts.LogFormat, opts.LogFormatter
|
format, formatter := opts.LogFormat, opts.LogFormatter
|
||||||
if bot.logger == nil {
|
if bot.logger == nil {
|
||||||
bot.logger = utils.CreateLogger("BOT", level, format, formatter)
|
bot.logger = utils.CreateLogger("BOT", level, format, formatter)
|
||||||
|
bot.loggerOwned = true
|
||||||
if opts.WriteToFile {
|
if opts.WriteToFile {
|
||||||
path := fmt.Sprintf("%s/main.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
path := fmt.Sprintf("%s/main.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||||
logger, err := utils.CreateFileLogger("BOT", level, path, format, formatter)
|
logger, err := utils.CreateFileLogger("BOT", level, path, format, formatter)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
} else {
|
} else {
|
||||||
|
_ = bot.logger.Close()
|
||||||
bot.logger = logger
|
bot.logger = logger
|
||||||
|
bot.loggerOwned = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if opts.UseRequestLogger && bot.requestLogger == nil {
|
if opts.UseRequestLogger && bot.requestLogger == nil {
|
||||||
bot.requestLogger = utils.CreateLogger("REQUESTS", level, format, formatter)
|
bot.requestLogger = utils.CreateLogger("REQUESTS", level, format, formatter)
|
||||||
|
bot.requestLoggerOwned = true
|
||||||
if opts.WriteToFile {
|
if opts.WriteToFile {
|
||||||
path := fmt.Sprintf("%s/requests.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
path := fmt.Sprintf("%s/requests.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||||
logger, err := utils.CreateFileLogger("REQUESTS", level, path, format, formatter)
|
logger, err := utils.CreateFileLogger("REQUESTS", level, path, format, formatter)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
} else {
|
} else {
|
||||||
|
_ = bot.requestLogger.Close()
|
||||||
bot.requestLogger = logger
|
bot.requestLogger = logger
|
||||||
|
bot.requestLoggerOwned = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -110,21 +131,45 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
|||||||
|
|
||||||
func (bot *Bot[T]) beginRun() error {
|
func (bot *Bot[T]) beginRun() error {
|
||||||
bot.runStateMu.Lock()
|
bot.runStateMu.Lock()
|
||||||
defer bot.runStateMu.Unlock()
|
|
||||||
if bot.running || bot.ran {
|
if bot.running || bot.ran {
|
||||||
|
bot.runStateMu.Unlock()
|
||||||
return ErrBotAlreadyRun
|
return ErrBotAlreadyRun
|
||||||
}
|
}
|
||||||
bot.running = true
|
bot.running = true
|
||||||
bot.ran = true
|
bot.ran = true
|
||||||
|
bot.runStateMu.Unlock()
|
||||||
|
if bot.observer != nil {
|
||||||
|
bot.observerAsync = newObserverDispatcher(bot.observer, bot.logger)
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bot *Bot[T]) finishRun() {
|
func (bot *Bot[T]) finishRun() {
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), observerShutdownTimeout)
|
||||||
|
if err := bot.stopObserverDispatcher(ctx); err != nil && bot.logger != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
bot.runStateMu.Lock()
|
bot.runStateMu.Lock()
|
||||||
bot.running = false
|
bot.running = false
|
||||||
bot.runStateMu.Unlock()
|
bot.runStateMu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) stopObserverDispatcher(ctx context.Context) error {
|
||||||
|
if bot.observerAsync == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return bot.observerAsync.close(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) startAsyncTask(task func()) {
|
||||||
|
bot.middlewareWG.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer bot.middlewareWG.Done()
|
||||||
|
task()
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
func nextPollRetryDelay(prev time.Duration) time.Duration {
|
func nextPollRetryDelay(prev time.Duration) time.Duration {
|
||||||
if prev <= 0 {
|
if prev <= 0 {
|
||||||
return time.Second
|
return time.Second
|
||||||
|
|||||||
@@ -18,16 +18,26 @@ import (
|
|||||||
|
|
||||||
// BotWebhookOpts configures Telegram webhook registration and the local HTTP server.
|
// BotWebhookOpts configures Telegram webhook registration and the local HTTP server.
|
||||||
type BotWebhookOpts struct {
|
type BotWebhookOpts struct {
|
||||||
|
// Path is the local HTTP route that receives Telegram updates.
|
||||||
Path string
|
Path string
|
||||||
|
// LocalPort is the TCP port used by the webhook server.
|
||||||
LocalPort int
|
LocalPort int
|
||||||
|
// UseStatusPath enables the authenticated /status endpoint.
|
||||||
UseStatusPath bool
|
UseStatusPath bool
|
||||||
|
|
||||||
|
// URL is the public base URL Telegram uses for delivery.
|
||||||
URL string
|
URL string
|
||||||
|
// Certificate contains a self-signed public certificate to upload.
|
||||||
Certificate []byte
|
Certificate []byte
|
||||||
|
// IPAddress fixes the destination IP used by Telegram.
|
||||||
IPAddress string
|
IPAddress string
|
||||||
|
// MaxConnections limits simultaneous Telegram webhook connections to 1–100.
|
||||||
MaxConnections int8
|
MaxConnections int8
|
||||||
|
// AllowedUpdates limits the update kinds delivered to the webhook.
|
||||||
AllowedUpdates []tgapi.UpdateType
|
AllowedUpdates []tgapi.UpdateType
|
||||||
|
// DropPendingUpdates requests deletion of queued updates during registration.
|
||||||
DropPendingUpdates bool
|
DropPendingUpdates bool
|
||||||
|
// SecretToken authenticates Telegram requests and the optional status endpoint.
|
||||||
SecretToken string
|
SecretToken string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -247,10 +257,13 @@ func (bot *Bot[T]) CloseWebhook() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if bot.webhookLogger != nil {
|
if bot.webhookLogger != nil {
|
||||||
|
if bot.webhookLoggerOwned {
|
||||||
if err := bot.webhookLogger.Close(); err != nil {
|
if err := bot.webhookLogger.Close(); err != nil {
|
||||||
e = append(e, err)
|
e = append(e, err)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
bot.webhookLogger = nil
|
bot.webhookLogger = nil
|
||||||
|
bot.webhookLoggerOwned = false
|
||||||
}
|
}
|
||||||
return errors.Join(e...)
|
return errors.Join(e...)
|
||||||
}
|
}
|
||||||
@@ -273,6 +286,7 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
|||||||
|
|
||||||
if bot.webhookLogger == nil {
|
if bot.webhookLogger == nil {
|
||||||
bot.webhookLogger = utils.CreateLogger("WEBHOOK", bot.GetLoggerLevel(), bot.logFormat, bot.logFormatter)
|
bot.webhookLogger = utils.CreateLogger("WEBHOOK", bot.GetLoggerLevel(), bot.logFormat, bot.logFormatter)
|
||||||
|
bot.webhookLoggerOwned = true
|
||||||
}
|
}
|
||||||
bot.addTokenReplacer(bot.webhookLogger)
|
bot.addTokenReplacer(bot.webhookLogger)
|
||||||
bot.ExecRunners(runCtx)
|
bot.ExecRunners(runCtx)
|
||||||
@@ -287,6 +301,7 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
|||||||
cancel()
|
cancel()
|
||||||
close(bot.updateQueue)
|
close(bot.updateQueue)
|
||||||
<-workersDone
|
<-workersDone
|
||||||
|
bot.middlewareWG.Wait()
|
||||||
bot.runnerOnceWG.Wait()
|
bot.runnerOnceWG.Wait()
|
||||||
bot.runnerBgWG.Wait()
|
bot.runnerBgWG.Wait()
|
||||||
|
|
||||||
|
|||||||
+90
-10
@@ -7,6 +7,7 @@ import (
|
|||||||
"regexp"
|
"regexp"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
|
||||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
@@ -21,6 +22,39 @@ var cmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
|||||||
// bot initialization.
|
// bot initialization.
|
||||||
var ErrTooManyCommands = errors.New("too many commands. max 100")
|
var ErrTooManyCommands = errors.New("too many commands. max 100")
|
||||||
|
|
||||||
|
var (
|
||||||
|
// ErrInvalidBotCommand reports a command name that Telegram would reject.
|
||||||
|
ErrInvalidBotCommand = errors.New("invalid bot command")
|
||||||
|
// ErrInvalidBotCommandDescription reports an empty or overlong generated description.
|
||||||
|
ErrInvalidBotCommandDescription = errors.New("invalid bot command description")
|
||||||
|
// ErrDuplicateBotCommand reports the same command generated by multiple plugins.
|
||||||
|
ErrDuplicateBotCommand = errors.New("duplicate bot command")
|
||||||
|
// ErrPartialCommandScopeUpdate reports that an earlier command scope was
|
||||||
|
// updated before a later scope failed.
|
||||||
|
ErrPartialCommandScopeUpdate = errors.New("partial command scope update")
|
||||||
|
)
|
||||||
|
|
||||||
|
// CommandScopeUpdateError describes a failed multi-scope command update.
|
||||||
|
// UpdatedScopes lists scopes successfully changed before FailedScope failed.
|
||||||
|
type CommandScopeUpdateError struct {
|
||||||
|
// UpdatedScopes contains scopes changed before the failure.
|
||||||
|
UpdatedScopes []tgapi.BotCommandScopeType
|
||||||
|
// FailedScope identifies the scope whose update failed.
|
||||||
|
FailedScope tgapi.BotCommandScopeType
|
||||||
|
// Err is the Telegram API error for FailedScope.
|
||||||
|
Err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error returns a human-readable partial-update description.
|
||||||
|
func (e *CommandScopeUpdateError) Error() string {
|
||||||
|
return fmt.Sprintf("%v: updated %v; failed scope %q: %v", ErrPartialCommandScopeUpdate, e.UpdatedScopes, e.FailedScope, e.Err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unwrap exposes both the partial-update sentinel and the underlying API error.
|
||||||
|
func (e *CommandScopeUpdateError) Unwrap() []error {
|
||||||
|
return []error{ErrPartialCommandScopeUpdate, e.Err}
|
||||||
|
}
|
||||||
|
|
||||||
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
||||||
desc := ""
|
desc := ""
|
||||||
if len(cmd.description) > 0 {
|
if len(cmd.description) > 0 {
|
||||||
@@ -36,7 +70,10 @@ func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
usage := fmt.Sprintf("Usage: /%s %s", cmd.command, strings.Join(descArgs, " "))
|
usage := fmt.Sprintf("Usage: /%s", cmd.command)
|
||||||
|
if len(descArgs) > 0 {
|
||||||
|
usage += " " + strings.Join(descArgs, " ")
|
||||||
|
}
|
||||||
if desc != "" {
|
if desc != "" {
|
||||||
desc = fmt.Sprintf("%s. %s", desc, usage)
|
desc = fmt.Sprintf("%s. %s", desc, usage)
|
||||||
return tgapi.BotCommand{Command: cmd.command, Description: desc, IsEphemeral: cmd.isEphemeral}
|
return tgapi.BotCommand{Command: cmd.command, Description: desc, IsEphemeral: cmd.isEphemeral}
|
||||||
@@ -46,7 +83,7 @@ func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
|||||||
|
|
||||||
func checkCmdRegex(cmd string) bool { return cmdRegexp.MatchString(cmd) }
|
func checkCmdRegex(cmd string) bool { return cmdRegexp.MatchString(cmd) }
|
||||||
|
|
||||||
func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
func gatherCommandsForPlugin[T any](pl Plugin[T]) ([]tgapi.BotCommand, error) {
|
||||||
commands := make([]tgapi.BotCommand, 0)
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
names := make([]string, 0, len(pl.commands))
|
names := make([]string, 0, len(pl.commands))
|
||||||
for name := range pl.commands {
|
for name := range pl.commands {
|
||||||
@@ -60,23 +97,51 @@ func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if !checkCmdRegex(cmd.command) {
|
if !checkCmdRegex(cmd.command) {
|
||||||
continue
|
return nil, fmt.Errorf("%w %q in plugin %q", ErrInvalidBotCommand, cmd.command, pl.name)
|
||||||
}
|
}
|
||||||
commands = append(commands, generateBotCommand(cmd))
|
generated := generateBotCommand(cmd)
|
||||||
|
descriptionLength := utf8.RuneCountInString(generated.Description)
|
||||||
|
if descriptionLength < 1 || descriptionLength > 256 {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"%w for %q in plugin %q: got %d characters, want 1..256",
|
||||||
|
ErrInvalidBotCommandDescription,
|
||||||
|
cmd.command,
|
||||||
|
pl.name,
|
||||||
|
descriptionLength,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
return commands
|
commands = append(commands, generated)
|
||||||
|
}
|
||||||
|
return commands, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
|
func gatherCommands[T any](bot *Bot[T]) ([]tgapi.BotCommand, error) {
|
||||||
commands := make([]tgapi.BotCommand, 0)
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
|
owners := make(map[string]string)
|
||||||
for _, pl := range bot.plugins {
|
for _, pl := range bot.plugins {
|
||||||
if pl.skipAutoCmd {
|
if pl.skipAutoCmd {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
commands = append(commands, gatherCommandsForPlugin(pl)...)
|
pluginCommands, err := gatherCommandsForPlugin(pl)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for _, command := range pluginCommands {
|
||||||
|
if owner, exists := owners[command.Command]; exists {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"%w %q in plugins %q and %q",
|
||||||
|
ErrDuplicateBotCommand,
|
||||||
|
command.Command,
|
||||||
|
owner,
|
||||||
|
pl.name,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
owners[command.Command] = pl.name
|
||||||
|
commands = append(commands, command)
|
||||||
|
}
|
||||||
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
|
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
|
||||||
}
|
}
|
||||||
return commands
|
return commands, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// AutoGenerateCommands replaces plugin-defined commands in the private-chat,
|
// AutoGenerateCommands replaces plugin-defined commands in the private-chat,
|
||||||
@@ -100,7 +165,10 @@ func (bot *Bot[T]) AutoGenerateCommands() error {
|
|||||||
|
|
||||||
// AutoGenerateCommandsWithContext is the context-aware variant of AutoGenerateCommands.
|
// AutoGenerateCommandsWithContext is the context-aware variant of AutoGenerateCommands.
|
||||||
func (bot *Bot[T]) AutoGenerateCommandsWithContext(ctx context.Context) error {
|
func (bot *Bot[T]) AutoGenerateCommandsWithContext(ctx context.Context) error {
|
||||||
commands := gatherCommands(bot)
|
commands, err := gatherCommands(bot)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if len(commands) > 100 {
|
if len(commands) > 100 {
|
||||||
return ErrTooManyCommands
|
return ErrTooManyCommands
|
||||||
}
|
}
|
||||||
@@ -112,10 +180,19 @@ func (bot *Bot[T]) AutoGenerateCommandsWithContext(ctx context.Context) error {
|
|||||||
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
updatedScopes := make([]tgapi.BotCommandScopeType, 0, len(scopes))
|
||||||
for i := range scopes {
|
for i := range scopes {
|
||||||
if err := bot.setCommandsForScope(ctx, &scopes[i], commands); err != nil {
|
if err := bot.setCommandsForScope(ctx, &scopes[i], commands); err != nil {
|
||||||
|
if len(updatedScopes) > 0 {
|
||||||
|
return &CommandScopeUpdateError{
|
||||||
|
UpdatedScopes: updatedScopes,
|
||||||
|
FailedScope: scopes[i].Type,
|
||||||
|
Err: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
updatedScopes = append(updatedScopes, scopes[i].Type)
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -142,7 +219,10 @@ func (bot *Bot[T]) AutoGenerateCommandsForScope(scope *tgapi.BotCommandScope) er
|
|||||||
// AutoGenerateCommandsForScopeWithContext is the context-aware variant of
|
// AutoGenerateCommandsForScopeWithContext is the context-aware variant of
|
||||||
// AutoGenerateCommandsForScope.
|
// AutoGenerateCommandsForScope.
|
||||||
func (bot *Bot[T]) AutoGenerateCommandsForScopeWithContext(ctx context.Context, scope *tgapi.BotCommandScope) error {
|
func (bot *Bot[T]) AutoGenerateCommandsForScopeWithContext(ctx context.Context, scope *tgapi.BotCommandScope) error {
|
||||||
commands := gatherCommands(bot)
|
commands, err := gatherCommands(bot)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if len(commands) > 100 {
|
if len(commands) > 100 {
|
||||||
return ErrTooManyCommands
|
return ErrTooManyCommands
|
||||||
}
|
}
|
||||||
|
|||||||
+131
-1
@@ -72,7 +72,10 @@ func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
|||||||
plugin.Command("alpha", exec)
|
plugin.Command("alpha", exec)
|
||||||
plugin.Command("mid", exec)
|
plugin.Command("mid", exec)
|
||||||
|
|
||||||
commands := gatherCommandsForPlugin(*plugin)
|
commands, err := gatherCommandsForPlugin(*plugin)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("gatherCommandsForPlugin returned error: %v", err)
|
||||||
|
}
|
||||||
got := make([]string, 0, len(commands))
|
got := make([]string, 0, len(commands))
|
||||||
for _, cmd := range commands {
|
for _, cmd := range commands {
|
||||||
got = append(got, cmd.Command)
|
got = append(got, cmd.Command)
|
||||||
@@ -84,6 +87,133 @@ func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGeneratedCommandDescriptionBoundaries(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
description string
|
||||||
|
wantLength int
|
||||||
|
wantErr error
|
||||||
|
}{
|
||||||
|
{name: "generated usage", wantLength: len("Usage: /start")},
|
||||||
|
{name: "exact limit", description: strings.Repeat("я", 241), wantLength: 256},
|
||||||
|
{name: "over limit", description: strings.Repeat("я", 242), wantErr: ErrInvalidBotCommandDescription},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("commands")
|
||||||
|
plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil }).SetDescription(tt.description)
|
||||||
|
commands, err := gatherCommandsForPlugin(*plugin)
|
||||||
|
if !errors.Is(err, tt.wantErr) {
|
||||||
|
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||||
|
}
|
||||||
|
if err == nil {
|
||||||
|
if got := len([]rune(commands[0].Description)); got != tt.wantLength {
|
||||||
|
t.Fatalf("description length = %d, want %d", got, tt.wantLength)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAutoGenerateCommandsValidatesBeforeRequest(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
plugins func(CommandExecutor[NoData]) []Plugin[NoData]
|
||||||
|
wantErr error
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "invalid command",
|
||||||
|
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||||
|
plugin := NewPlugin[NoData]("invalid")
|
||||||
|
plugin.Command("UPPER", exec)
|
||||||
|
return []Plugin[NoData]{*plugin}
|
||||||
|
},
|
||||||
|
wantErr: ErrInvalidBotCommand,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "description too long",
|
||||||
|
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||||
|
plugin := NewPlugin[NoData]("long")
|
||||||
|
plugin.Command("start", exec).SetDescription(strings.Repeat("я", 257))
|
||||||
|
return []Plugin[NoData]{*plugin}
|
||||||
|
},
|
||||||
|
wantErr: ErrInvalidBotCommandDescription,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "duplicate across plugins",
|
||||||
|
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||||
|
first := NewPlugin[NoData]("first")
|
||||||
|
second := NewPlugin[NoData]("second")
|
||||||
|
first.Command("start", exec)
|
||||||
|
second.Command("start", exec)
|
||||||
|
return []Plugin[NoData]{*first, *second}
|
||||||
|
},
|
||||||
|
wantErr: ErrDuplicateBotCommand,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
var calls atomic.Int64
|
||||||
|
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
calls.Add(1)
|
||||||
|
return nil, errors.New("unexpected request")
|
||||||
|
})}
|
||||||
|
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
|
||||||
|
exec := func(ctx *MessageContext, db NoData) error { return nil }
|
||||||
|
bot := &Bot[NoData]{api: api, logger: sneklog.NewLogger(), plugins: tt.plugins(exec)}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
err := bot.AutoGenerateCommands()
|
||||||
|
if !errors.Is(err, tt.wantErr) {
|
||||||
|
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||||
|
}
|
||||||
|
if calls.Load() != 0 {
|
||||||
|
t.Fatalf("expected no requests, got %d", calls.Load())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAutoGenerateCommandsReportsPartialScopeUpdate(t *testing.T) {
|
||||||
|
var calls atomic.Int64
|
||||||
|
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
call := calls.Add(1)
|
||||||
|
body := `{"ok":true,"result":true}`
|
||||||
|
if call == 2 {
|
||||||
|
body = `{"ok":false,"error_code":500,"description":"boom"}`
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(body)),
|
||||||
|
}, nil
|
||||||
|
})}
|
||||||
|
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
plugin := NewPlugin[NoData]("commands")
|
||||||
|
plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil })
|
||||||
|
bot := &Bot[NoData]{api: api, logger: sneklog.NewLogger(), plugins: []Plugin[NoData]{*plugin}}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
err := bot.AutoGenerateCommands()
|
||||||
|
if !errors.Is(err, ErrPartialCommandScopeUpdate) {
|
||||||
|
t.Fatalf("expected ErrPartialCommandScopeUpdate, got %v", err)
|
||||||
|
}
|
||||||
|
var partial *CommandScopeUpdateError
|
||||||
|
if !errors.As(err, &partial) {
|
||||||
|
t.Fatalf("expected CommandScopeUpdateError, got %T", err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(partial.UpdatedScopes, []tgapi.BotCommandScopeType{tgapi.BotCommandScopePrivateType}) {
|
||||||
|
t.Fatalf("unexpected updated scopes: %v", partial.UpdatedScopes)
|
||||||
|
}
|
||||||
|
if partial.FailedScope != tgapi.BotCommandScopeGroupType {
|
||||||
|
t.Fatalf("unexpected failed scope: %q", partial.FailedScope)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestAutoGenerateCommandsForNilScopeUsesSingleAtomicReplacement(t *testing.T) {
|
func TestAutoGenerateCommandsForNilScopeUsesSingleAtomicReplacement(t *testing.T) {
|
||||||
var methods []string
|
var methods []string
|
||||||
client := &http.Client{
|
client := &http.Client{
|
||||||
|
|||||||
@@ -45,10 +45,8 @@ type DraftProvider struct {
|
|||||||
generator draftIDGenerator
|
generator draftIDGenerator
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewRandomDraftProvider creates a new DraftProvider using random draft IDs.
|
// NewRandomDraftProvider creates a DraftProvider using non-cryptographic random IDs.
|
||||||
//
|
// Zero values and collisions with active drafts are retried.
|
||||||
// The provider will use random numbers for draft IDs.
|
|
||||||
// All drafts created via this provider will have unpredictable, unique IDs.
|
|
||||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||||
return &DraftProvider{
|
return &DraftProvider{
|
||||||
api: api, generator: &RandomDraftIDGenerator{},
|
api: api, generator: &RandomDraftIDGenerator{},
|
||||||
@@ -121,7 +119,9 @@ type Draft struct {
|
|||||||
parseMode tgapi.ParseMode
|
parseMode tgapi.ParseMode
|
||||||
entities []tgapi.MessageEntity
|
entities []tgapi.MessageEntity
|
||||||
|
|
||||||
|
// ID uniquely identifies the draft within its provider.
|
||||||
ID uint64
|
ID uint64
|
||||||
|
// Message contains the current draft text.
|
||||||
Message string
|
Message string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -221,6 +221,7 @@ func (d *Draft) Delete() {
|
|||||||
// If the draft is empty, Flush() returns nil without calling the API.
|
// If the draft is empty, Flush() returns nil without calling the API.
|
||||||
func (d *Draft) Flush() error {
|
func (d *Draft) Flush() error {
|
||||||
if d.Message == "" {
|
if d.Message == "" {
|
||||||
|
d.Delete()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if d.chatID == 0 {
|
if d.chatID == 0 {
|
||||||
|
|||||||
@@ -29,6 +29,32 @@ func TestDraftFlushRequiresChatID(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDraftFlushEmptyRemovesDraft(t *testing.T) {
|
||||||
|
provider := NewLinearDraftProvider(nil, 0)
|
||||||
|
draft := provider.NewDraft(tgapi.ParseNone)
|
||||||
|
|
||||||
|
if err := draft.Flush(); err != nil {
|
||||||
|
t.Fatalf("Flush returned error: %v", err)
|
||||||
|
}
|
||||||
|
if _, ok := provider.GetDraft(draft.ID); ok {
|
||||||
|
t.Fatal("empty flushed draft remained in provider")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDraftFlushAllRemovesClearedDrafts(t *testing.T) {
|
||||||
|
provider := NewLinearDraftProvider(nil, 0)
|
||||||
|
draft := provider.NewDraft(tgapi.ParseNone)
|
||||||
|
draft.Message = "discarded"
|
||||||
|
draft.Clear()
|
||||||
|
|
||||||
|
if err := provider.FlushAll(); err != nil {
|
||||||
|
t.Fatalf("FlushAll returned error: %v", err)
|
||||||
|
}
|
||||||
|
if _, ok := provider.GetDraft(draft.ID); ok {
|
||||||
|
t.Fatal("cleared draft remained in provider")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestMsgContextNewDraftWorksWithoutLimiter(t *testing.T) {
|
func TestMsgContextNewDraftWorksWithoutLimiter(t *testing.T) {
|
||||||
ctx := &MessageContext{
|
ctx := &MessageContext{
|
||||||
API: &tgapi.API{},
|
API: &tgapi.API{},
|
||||||
|
|||||||
@@ -38,6 +38,8 @@ var (
|
|||||||
ErrAPIIsNil = errors.New("api is nil")
|
ErrAPIIsNil = errors.New("api is nil")
|
||||||
// ErrMessageIDZero reports that an operation requires a non-zero message ID.
|
// ErrMessageIDZero reports that an operation requires a non-zero message ID.
|
||||||
ErrMessageIDZero = errors.New("message ID is zero")
|
ErrMessageIDZero = errors.New("message ID is zero")
|
||||||
|
// ErrCodecIsNil reports that a config operation received a nil codec.
|
||||||
|
ErrCodecIsNil = errors.New("codec is nil")
|
||||||
)
|
)
|
||||||
var (
|
var (
|
||||||
// ErrBindArgsTargetNotPointer reports that BindArgs received a nil or non-pointer destination.
|
// ErrBindArgsTargetNotPointer reports that BindArgs received a nil or non-pointer destination.
|
||||||
@@ -60,6 +62,20 @@ var (
|
|||||||
ErrSceneEntryNotSet = errors.New("scene entry step not set")
|
ErrSceneEntryNotSet = errors.New("scene entry step not set")
|
||||||
// ErrSceneRuntimeNil reports that scene APIs were used without an attached runtime.
|
// ErrSceneRuntimeNil reports that scene APIs were used without an attached runtime.
|
||||||
ErrSceneRuntimeNil = errors.New("scene runtime is nil")
|
ErrSceneRuntimeNil = errors.New("scene runtime is nil")
|
||||||
|
// ErrInvalidSceneAction reports a SceneResult with an unknown action.
|
||||||
|
ErrInvalidSceneAction = errors.New("invalid scene action")
|
||||||
|
// ErrHandlerExecutorNil reports an attempted registration or execution of a nil handler.
|
||||||
|
ErrHandlerExecutorNil = errors.New("handler executor is nil")
|
||||||
|
// ErrHandlerPanic reports a panic recovered from a user handler.
|
||||||
|
ErrHandlerPanic = errors.New("handler panicked")
|
||||||
|
// ErrObserverShutdownTimeout reports that observer callbacks did not stop before shutdown timed out.
|
||||||
|
ErrObserverShutdownTimeout = errors.New("observer shutdown timed out")
|
||||||
|
// ErrInlineKeyboardButtonAction reports a button without exactly one action.
|
||||||
|
ErrInlineKeyboardButtonAction = errors.New("inline keyboard button must have exactly one action")
|
||||||
|
// ErrCallbackDataLength reports callback data outside Telegram's 1-64 byte range.
|
||||||
|
ErrCallbackDataLength = errors.New("callback data must be between 1 and 64 bytes")
|
||||||
|
// ErrInlineKeyboardRowTooLong reports a row exceeding the configured maximum.
|
||||||
|
ErrInlineKeyboardRowTooLong = errors.New("inline keyboard row exceeds maximum size")
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|||||||
+7
-4
@@ -51,13 +51,13 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
|||||||
draftProvider: bot.draftProvider,
|
draftProvider: bot.draftProvider,
|
||||||
sceneRuntime: bot,
|
sceneRuntime: bot,
|
||||||
observer: bot.observer,
|
observer: bot.observer,
|
||||||
|
eventEmitter: bot.safeEmitEvent,
|
||||||
|
asyncTask: bot.startAsyncTask,
|
||||||
payloadType: bot.payloadType,
|
payloadType: bot.payloadType,
|
||||||
botID: bot.userID,
|
botID: bot.userID,
|
||||||
ctx: ctx,
|
ctx: ctx,
|
||||||
}
|
}
|
||||||
bot.prepareUpdateCtx(u, msgCtx)
|
bot.prepareUpdateCtx(u, msgCtx)
|
||||||
unlockScenes := bot.sceneLocks.lock(sceneKeysForContext(msgCtx))
|
|
||||||
defer unlockScenes()
|
|
||||||
bot.safeEmitEvent(ctx, UpdateReceivedEvent{
|
bot.safeEmitEvent(ctx, UpdateReceivedEvent{
|
||||||
UpdateID: u.UpdateID,
|
UpdateID: u.UpdateID,
|
||||||
UpdateType: u.Type,
|
UpdateType: u.Type,
|
||||||
@@ -81,7 +81,7 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
|||||||
|
|
||||||
sceneHandled, err := bot.tryHandleScene(msgCtx)
|
sceneHandled, err := bot.tryHandleScene(msgCtx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.logger.Errorln(err)
|
msgCtx.error(err)
|
||||||
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||||
UpdateID: u.UpdateID,
|
UpdateID: u.UpdateID,
|
||||||
UpdateType: u.Type,
|
UpdateType: u.Type,
|
||||||
@@ -90,6 +90,8 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
|||||||
Duration: time.Since(startTime),
|
Duration: time.Since(startTime),
|
||||||
Handled: false,
|
Handled: false,
|
||||||
})
|
})
|
||||||
|
var reported *reportedSceneError
|
||||||
|
if !errors.As(err, &reported) {
|
||||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
UpdateID: u.UpdateID,
|
UpdateID: u.UpdateID,
|
||||||
UpdateType: u.Type,
|
UpdateType: u.Type,
|
||||||
@@ -99,8 +101,9 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
|||||||
FromID: msgCtx.FromID,
|
FromID: msgCtx.FromID,
|
||||||
ChatID: msgCtx.ChatID,
|
ChatID: msgCtx.ChatID,
|
||||||
Err: err,
|
Err: err,
|
||||||
UserFacing: false,
|
UserFacing: IsUserError(err),
|
||||||
})
|
})
|
||||||
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if sceneHandled {
|
if sceneHandled {
|
||||||
|
|||||||
+217
-3
@@ -3,7 +3,11 @@ package laniakea
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
@@ -1298,6 +1302,8 @@ func TestParseCommandTable(t *testing.T) {
|
|||||||
{name: "plain text", text: "hello", wantPrefix: "", wantCmd: "", wantArgs: ""},
|
{name: "plain text", text: "hello", wantPrefix: "", wantCmd: "", wantArgs: ""},
|
||||||
{name: "command no args", text: "/start", wantPrefix: "/", wantCmd: "start", wantArgs: ""},
|
{name: "command no args", text: "/start", wantPrefix: "/", wantCmd: "start", wantArgs: ""},
|
||||||
{name: "command with args", text: "/ban 42 reason", wantPrefix: "/", wantCmd: "ban", wantArgs: "42 reason"},
|
{name: "command with args", text: "/ban 42 reason", wantPrefix: "/", wantCmd: "ban", wantArgs: "42 reason"},
|
||||||
|
{name: "tab separator", text: "/ban\t42", wantPrefix: "/", wantCmd: "ban", wantArgs: "42"},
|
||||||
|
{name: "newline separator", text: "/ban\n42", wantPrefix: "/", wantCmd: "ban", wantArgs: "42"},
|
||||||
{name: "alternate prefix", text: "!ping", wantPrefix: "!", wantCmd: "ping", wantArgs: ""},
|
{name: "alternate prefix", text: "!ping", wantPrefix: "!", wantCmd: "ping", wantArgs: ""},
|
||||||
{name: "leading space after prefix", text: "/ start now", wantPrefix: "/", wantCmd: "start", wantArgs: "now"},
|
{name: "leading space after prefix", text: "/ start now", wantPrefix: "/", wantCmd: "start", wantArgs: "now"},
|
||||||
{name: "command with botname", text: "/start@mybot extra", wantPrefix: "/", wantCmd: "start@mybot", wantArgs: "extra"},
|
{name: "command with botname", text: "/start@mybot extra", wantPrefix: "/", wantCmd: "start@mybot", wantArgs: "extra"},
|
||||||
@@ -1329,6 +1335,7 @@ func TestHandleMessageStripsBotUsernameSuffix(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{name: "matching botname", botUsername: "mybot", text: "/start@mybot hello", wantCalled: true},
|
{name: "matching botname", botUsername: "mybot", text: "/start@mybot hello", wantCalled: true},
|
||||||
{name: "matching botname no args", botUsername: "mybot", text: "/start@mybot", wantCalled: true},
|
{name: "matching botname no args", botUsername: "mybot", text: "/start@mybot", wantCalled: true},
|
||||||
|
{name: "matching botname ignores case", botUsername: "MyBot", text: "/start@mybot", wantCalled: true},
|
||||||
{name: "other botname", botUsername: "mybot", text: "/start@otherbot hello", wantCalled: false},
|
{name: "other botname", botUsername: "mybot", text: "/start@otherbot hello", wantCalled: false},
|
||||||
{name: "no botname", botUsername: "mybot", text: "/start hello", wantCalled: true},
|
{name: "no botname", botUsername: "mybot", text: "/start hello", wantCalled: true},
|
||||||
{name: "bot has no username", botUsername: "", text: "/start@mybot hello", wantCalled: false},
|
{name: "bot has no username", botUsername: "", text: "/start@mybot hello", wantCalled: false},
|
||||||
@@ -1378,14 +1385,14 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
|||||||
name: "error value",
|
name: "error value",
|
||||||
panicWith: errors.New("boom"),
|
panicWith: errors.New("boom"),
|
||||||
matchErr: func(err error) bool {
|
matchErr: func(err error) bool {
|
||||||
return err != nil && err.Error() == "boom"
|
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "boom")
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "string value",
|
name: "string value",
|
||||||
panicWith: "kaboom",
|
panicWith: "kaboom",
|
||||||
matchErr: func(err error) bool {
|
matchErr: func(err error) bool {
|
||||||
return err != nil && err.Error() == "kaboom"
|
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "kaboom")
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -1419,7 +1426,7 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
|||||||
panicEvent := (*ErrorEvent)(nil)
|
panicEvent := (*ErrorEvent)(nil)
|
||||||
for i := range observer.errors {
|
for i := range observer.errors {
|
||||||
ev := observer.errors[i]
|
ev := observer.errors[i]
|
||||||
if ev.Plugin == "" && ev.HandlerKind == "" && ev.UpdateID == 100 {
|
if ev.Plugin == "test" && ev.HandlerKind == HandlerCommandKind && ev.UpdateID == 100 {
|
||||||
panicEvent = &ev
|
panicEvent = &ev
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
@@ -1436,10 +1443,217 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
|||||||
if !tt.matchErr(panicEvent.Err) {
|
if !tt.matchErr(panicEvent.Err) {
|
||||||
t.Fatalf("unexpected panic Err: %v", panicEvent.Err)
|
t.Fatalf("unexpected panic Err: %v", panicEvent.Err)
|
||||||
}
|
}
|
||||||
|
if len(observer.finished) != 1 || !errors.Is(observer.finished[0].Err, ErrHandlerPanic) {
|
||||||
|
t.Fatalf("expected balanced HandlerFinishedEvent, got %#v", observer.finished)
|
||||||
|
}
|
||||||
|
if len(observer.handled) != 1 || !observer.handled[0].Handled {
|
||||||
|
t.Fatalf("expected completed handled update, got %#v", observer.handled)
|
||||||
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSceneUserErrorIsDeliveredOnce(t *testing.T) {
|
||||||
|
failing := func(*SceneContext, NoData) (SceneResult, error) {
|
||||||
|
return SceneResult{}, AsUserError(errors.New("try again"))
|
||||||
|
}
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
step string
|
||||||
|
kind HandlerEventKind
|
||||||
|
setup func(*Scene[NoData])
|
||||||
|
update func() tgapi.Update
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "step", step: "start", kind: HandlerSceneStepKind,
|
||||||
|
setup: func(scene *Scene[NoData]) { scene.OnStep("start", failing) },
|
||||||
|
update: func() tgapi.Update { return sceneMessageUpdate(101, "hello") },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "command", step: "start", kind: HandlerSceneCommandKind,
|
||||||
|
setup: func(scene *Scene[NoData]) { scene.OnCommand("fail", failing) },
|
||||||
|
update: func() tgapi.Update { return sceneMessageUpdate(102, "/fail") },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "payload", step: "start", kind: HandlerScenePayloadKind,
|
||||||
|
setup: func(scene *Scene[NoData]) { scene.OnPayload("fail", failing) },
|
||||||
|
update: func() tgapi.Update {
|
||||||
|
data, err := encodeJSONPayload(CallbackData{Command: "fail"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
return tgapi.Update{
|
||||||
|
UpdateID: 103,
|
||||||
|
Type: tgapi.UpdateTypeCallbackQuery,
|
||||||
|
CallbackQuery: &tgapi.CallbackQuery{
|
||||||
|
ID: "callback", Data: data, From: tgapi.User{ID: 1},
|
||||||
|
Message: &tgapi.Message{MessageID: 1, Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "message fallback", step: "missing", kind: HandlerSceneMessageKind,
|
||||||
|
setup: func(scene *Scene[NoData]) { scene.OnMessage(failing) },
|
||||||
|
update: func() tgapi.Update { return sceneMessageUpdate(104, "hello") },
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
requests := 0
|
||||||
|
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
result := `true`
|
||||||
|
if !strings.HasSuffix(req.URL.Path, "/answerCallbackQuery") {
|
||||||
|
result = `{"message_id":1,"date":0,"chat":{"id":42,"type":"private"}}`
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":` + result + `}`)),
|
||||||
|
Header: make(http.Header),
|
||||||
|
}, nil
|
||||||
|
})}
|
||||||
|
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
|
||||||
|
scene := NewScene[NoData]("signup")
|
||||||
|
tt.setup(scene)
|
||||||
|
plugin := NewPlugin[NoData]("scene-plugin")
|
||||||
|
plugin.AddScene(scene)
|
||||||
|
store := NewMemorySessionStore()
|
||||||
|
if err := store.Set("user_id:1:chat_id:42", SceneSession{Scene: "signup", Step: tt.step}); err != nil {
|
||||||
|
t.Fatalf("Set returned error: %v", err)
|
||||||
|
}
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
api: api, logger: sneklog.NewLogger(), errorTemplate: "error: %s",
|
||||||
|
plugins: []Plugin[NoData]{clonePlugin(plugin)}, observer: observer,
|
||||||
|
sessionStore: store, sceneScopePriority: []SceneScope{SceneScopeUserChat},
|
||||||
|
prefixes: []string{"/"}, payloadType: BotPayloadJSON,
|
||||||
|
}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
update := tt.update()
|
||||||
|
bot.handle(context.Background(), &update)
|
||||||
|
|
||||||
|
if requests != 1 {
|
||||||
|
t.Fatalf("expected one user-facing reply, got %d requests", requests)
|
||||||
|
}
|
||||||
|
if len(observer.errors) != 1 {
|
||||||
|
t.Fatalf("expected one ErrorEvent, got %#v", observer.errors)
|
||||||
|
}
|
||||||
|
if event := observer.errors[0]; event.Plugin != "scene-plugin" || event.HandlerKind != tt.kind || !event.UserFacing {
|
||||||
|
t.Fatalf("unexpected scene ErrorEvent: %#v", event)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPolicyEventsUseConfiguredEmitter(t *testing.T) {
|
||||||
|
directObserver := &recordingObserver{}
|
||||||
|
emitted := 0
|
||||||
|
ctx := &MessageContext{
|
||||||
|
observer: directObserver,
|
||||||
|
eventEmitter: func(_ context.Context, event Event) {
|
||||||
|
if _, ok := event.(PolicyCheckedEvent); !ok {
|
||||||
|
t.Fatalf("unexpected event type %T", event)
|
||||||
|
}
|
||||||
|
emitted++
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.emitPolicyChecked(PolicyCheckedEvent{Name: "admin", Passed: true})
|
||||||
|
if emitted != 1 {
|
||||||
|
t.Fatalf("emitter call count = %d, want 1", emitted)
|
||||||
|
}
|
||||||
|
if len(directObserver.policies) != 0 {
|
||||||
|
t.Fatalf("policy bypassed configured emitter: %#v", directObserver.policies)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func sceneMessageUpdate(updateID int, text string) tgapi.Update {
|
||||||
|
return tgapi.Update{
|
||||||
|
UpdateID: updateID,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 1,
|
||||||
|
Text: text,
|
||||||
|
From: &tgapi.User{ID: 1},
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHandleDoesNotSerializeUnrelatedUsersWithoutScene(t *testing.T) {
|
||||||
|
started := make(chan struct{}, 2)
|
||||||
|
release := make(chan struct{})
|
||||||
|
plugin := NewPlugin[NoData]("commands")
|
||||||
|
plugin.Command("work", func(*MessageContext, NoData) error {
|
||||||
|
started <- struct{}{}
|
||||||
|
<-release
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
updateFor := func(id int) tgapi.Update {
|
||||||
|
return tgapi.Update{UpdateID: id, Type: tgapi.UpdateTypeMessage, Message: &tgapi.Message{
|
||||||
|
MessageID: id, Text: "/work", From: &tgapi.User{ID: int64(id)},
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypeSupergroup},
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
done := make(chan struct{}, 2)
|
||||||
|
for id := 1; id <= 2; id++ {
|
||||||
|
update := updateFor(id)
|
||||||
|
go func() {
|
||||||
|
bot.handle(context.Background(), &update)
|
||||||
|
done <- struct{}{}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
for range 2 {
|
||||||
|
select {
|
||||||
|
case <-started:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
close(release)
|
||||||
|
t.Fatal("updates from unrelated users in one chat were serialized")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
close(release)
|
||||||
|
<-done
|
||||||
|
<-done
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCommandMiddlewareBlockIsNotReportedAsError(t *testing.T) {
|
||||||
|
called := false
|
||||||
|
plugin := NewPlugin[NoData]("commands")
|
||||||
|
plugin.Command("blocked", func(*MessageContext, NoData) error {
|
||||||
|
called = true
|
||||||
|
return nil
|
||||||
|
}).Use(NewMiddleware("deny", func(*MessageContext, NoData) bool { return false }))
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(), plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||||
|
prefixes: []string{"/"}, observer: observer, sessionStore: NewMemorySessionStore(),
|
||||||
|
}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
update := sceneMessageUpdate(201, "/blocked")
|
||||||
|
bot.handle(context.Background(), &update)
|
||||||
|
|
||||||
|
if called {
|
||||||
|
t.Fatal("command executed after middleware blocked it")
|
||||||
|
}
|
||||||
|
if len(observer.errors) != 0 {
|
||||||
|
t.Fatalf("middleware block emitted errors: %#v", observer.errors)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestHandleCallbackObserverEmitsDecodeErrors(t *testing.T) {
|
func TestHandleCallbackObserverEmitsDecodeErrors(t *testing.T) {
|
||||||
observer := &recordingObserver{}
|
observer := &recordingObserver{}
|
||||||
bot := &Bot[NoData]{
|
bot := &Bot[NoData]{
|
||||||
|
|||||||
+97
-7
@@ -24,7 +24,7 @@ const (
|
|||||||
// - SetURL() — makes button open a URL
|
// - SetURL() — makes button open a URL
|
||||||
// - SetCallbackDataJSON() — attaches structured command + args for bot handling
|
// - SetCallbackDataJSON() — attaches structured command + args for bot handling
|
||||||
//
|
//
|
||||||
// Call build() to produce the final tgapi.InlineKeyboardButton.
|
// Call Build to validate and produce the final tgapi.InlineKeyboardButton.
|
||||||
// Builder methods are immutable — each returns a copy.
|
// Builder methods are immutable — each returns a copy.
|
||||||
type InlineKeyboardButtonBuilder struct {
|
type InlineKeyboardButtonBuilder struct {
|
||||||
text string
|
text string
|
||||||
@@ -138,6 +138,20 @@ func (b InlineKeyboardButtonBuilder) build() tgapi.InlineKeyboardButton {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate checks that the button has exactly one action and valid callback data.
|
||||||
|
func (b InlineKeyboardButtonBuilder) Validate() error {
|
||||||
|
return validateInlineKeyboardButton(b.build())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build validates and returns the configured inline keyboard button.
|
||||||
|
func (b InlineKeyboardButtonBuilder) Build() (tgapi.InlineKeyboardButton, error) {
|
||||||
|
button := b.build()
|
||||||
|
if err := validateInlineKeyboardButton(button); err != nil {
|
||||||
|
return tgapi.InlineKeyboardButton{}, err
|
||||||
|
}
|
||||||
|
return button, nil
|
||||||
|
}
|
||||||
|
|
||||||
// InlineKeyboard is a stateful builder for constructing Telegram inline keyboard layouts.
|
// InlineKeyboard is a stateful builder for constructing Telegram inline keyboard layouts.
|
||||||
//
|
//
|
||||||
// Buttons are added row-by-row. When a row reaches maxRow, it is automatically flushed.
|
// Buttons are added row-by-row. When a row reaches maxRow, it is automatically flushed.
|
||||||
@@ -145,8 +159,10 @@ func (b InlineKeyboardButtonBuilder) build() tgapi.InlineKeyboardButton {
|
|||||||
//
|
//
|
||||||
// The keyboard is not thread-safe. Build it in a single goroutine.
|
// The keyboard is not thread-safe. Build it in a single goroutine.
|
||||||
type InlineKeyboard struct {
|
type InlineKeyboard struct {
|
||||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
// CurrentLine is the row currently being built.
|
||||||
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton]
|
||||||
|
// Lines contains completed keyboard rows.
|
||||||
|
Lines [][]tgapi.InlineKeyboardButton
|
||||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||||
|
|
||||||
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
||||||
@@ -203,7 +219,8 @@ func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
|
|||||||
func (in *InlineKeyboard) GetPayloadType() BotPayloadType { return in.payloadType }
|
func (in *InlineKeyboard) GetPayloadType() BotPayloadType { return in.payloadType }
|
||||||
|
|
||||||
// SetMaxRow sets the maximum number of buttons appended to a row before the
|
// SetMaxRow sets the maximum number of buttons appended to a row before the
|
||||||
// keyboard automatically starts a new line.
|
// keyboard automatically starts a new line. Values <= 0 retain the legacy
|
||||||
|
// unlimited-row behavior; this convention is subject to change in v2.
|
||||||
func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
||||||
in.maxRow = maxRow
|
in.maxRow = maxRow
|
||||||
return in
|
return in
|
||||||
@@ -213,7 +230,7 @@ func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
|||||||
func (in *InlineKeyboard) GetMaxRow() int { return in.maxRow }
|
func (in *InlineKeyboard) GetMaxRow() int { return in.maxRow }
|
||||||
|
|
||||||
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||||
if in.CurrentLine.Len() == in.maxRow {
|
if in.maxRow > 0 && in.CurrentLine.Len() >= in.maxRow {
|
||||||
in.AddLine()
|
in.AddLine()
|
||||||
}
|
}
|
||||||
in.CurrentLine = in.CurrentLine.Push(button)
|
in.CurrentLine = in.CurrentLine.Push(button)
|
||||||
@@ -283,6 +300,62 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
|||||||
return &tgapi.ReplyMarkup{InlineKeyboard: lines}
|
return &tgapi.ReplyMarkup{InlineKeyboard: lines}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetValidated finalizes and validates the keyboard before returning it.
|
||||||
|
//
|
||||||
|
// Existing fluent Add* methods remain error-free for v1 compatibility. Their
|
||||||
|
// signatures are subject to change in v2; new code should use GetValidated.
|
||||||
|
func (in *InlineKeyboard) GetValidated() (*tgapi.ReplyMarkup, error) {
|
||||||
|
markup := in.Get()
|
||||||
|
if err := in.validateMarkup(markup); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return markup, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate checks completed and pending rows without finalizing the keyboard.
|
||||||
|
func (in *InlineKeyboard) Validate() error {
|
||||||
|
lines := make([][]tgapi.InlineKeyboardButton, 0, len(in.Lines)+1)
|
||||||
|
lines = append(lines, in.Lines...)
|
||||||
|
if len(in.CurrentLine) > 0 {
|
||||||
|
lines = append(lines, in.CurrentLine)
|
||||||
|
}
|
||||||
|
return in.validateMarkup(&tgapi.ReplyMarkup{InlineKeyboard: lines})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (in *InlineKeyboard) validateMarkup(markup *tgapi.ReplyMarkup) error {
|
||||||
|
for rowIndex, row := range markup.InlineKeyboard {
|
||||||
|
if in.maxRow > 0 && len(row) > in.maxRow {
|
||||||
|
return fmt.Errorf("%w: row %d has %d buttons, limit %d", ErrInlineKeyboardRowTooLong, rowIndex, len(row), in.maxRow)
|
||||||
|
}
|
||||||
|
for columnIndex, button := range row {
|
||||||
|
if err := validateInlineKeyboardButton(button); err != nil {
|
||||||
|
return fmt.Errorf("row %d button %d: %w", rowIndex, columnIndex, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateInlineKeyboardButton(button tgapi.InlineKeyboardButton) error {
|
||||||
|
actions := 0
|
||||||
|
if button.URL != "" {
|
||||||
|
actions++
|
||||||
|
}
|
||||||
|
if button.CallbackData != "" {
|
||||||
|
actions++
|
||||||
|
}
|
||||||
|
if actions != 1 {
|
||||||
|
return ErrInlineKeyboardButtonAction
|
||||||
|
}
|
||||||
|
if button.CallbackData != "" {
|
||||||
|
length := len([]byte(button.CallbackData))
|
||||||
|
if length < 1 || length > 64 {
|
||||||
|
return fmt.Errorf("%w: got %d", ErrCallbackDataLength, length)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// CallbackData represents the structured payload sent when an inline button
|
// CallbackData represents the structured payload sent when an inline button
|
||||||
// with callback data is pressed.
|
// with callback data is pressed.
|
||||||
//
|
//
|
||||||
@@ -293,8 +366,10 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
|||||||
//
|
//
|
||||||
// {"cmd":"delete_user","args":["123","confirm"]}
|
// {"cmd":"delete_user","args":["123","confirm"]}
|
||||||
type CallbackData struct {
|
type CallbackData struct {
|
||||||
Command string `json:"cmd"` // The command name to route to
|
// Command is the command name used for payload routing.
|
||||||
Args []string `json:"args"` // Arguments passed as strings
|
Command string `json:"cmd"`
|
||||||
|
// Args contains the string arguments passed to the payload handler.
|
||||||
|
Args []string `json:"args"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewCallbackData creates a new CallbackData instance with the given command and args.
|
// NewCallbackData creates a new CallbackData instance with the given command and args.
|
||||||
@@ -377,3 +452,18 @@ func (d CallbackData) Encode(t BotPayloadType) string {
|
|||||||
}
|
}
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// EncodeValidated serializes callback data and enforces Telegram's 1-64 byte limit.
|
||||||
|
func (d CallbackData) EncodeValidated(t BotPayloadType) (string, error) {
|
||||||
|
encoded := d.Encode(t)
|
||||||
|
if encoded == "" {
|
||||||
|
if t != BotPayloadBase64 && t != BotPayloadJSON && t != BotPayloadCompact && t != BotPayloadCompactBase64 {
|
||||||
|
return "", ErrInvalidPayloadType
|
||||||
|
}
|
||||||
|
return "", ErrCallbackDataLength
|
||||||
|
}
|
||||||
|
if length := len([]byte(encoded)); length > 64 {
|
||||||
|
return "", fmt.Errorf("%w: got %d", ErrCallbackDataLength, length)
|
||||||
|
}
|
||||||
|
return encoded, nil
|
||||||
|
}
|
||||||
|
|||||||
@@ -252,3 +252,60 @@ func TestDecodePayloadStrictRejectsMismatchedType(t *testing.T) {
|
|||||||
t.Fatalf("expected ErrPayloadTypeMismatch, got %v", err)
|
t.Fatalf("expected ErrPayloadTypeMismatch, got %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestInlineKeyboardValidation(t *testing.T) {
|
||||||
|
if err := NewInlineKeyboardButton("missing action").Validate(); !errors.Is(err, ErrInlineKeyboardButtonAction) {
|
||||||
|
t.Fatalf("expected ErrInlineKeyboardButtonAction, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
long := strings.Repeat("я", 33)
|
||||||
|
button := NewInlineKeyboardButton("long").SetCallbackDataCompact(long)
|
||||||
|
if err := button.Validate(); !errors.Is(err, ErrCallbackDataLength) {
|
||||||
|
t.Fatalf("expected ErrCallbackDataLength, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
keyboard := NewInlineKeyboardCompact(1).AddButton(button)
|
||||||
|
if _, err := keyboard.GetValidated(); !errors.Is(err, ErrCallbackDataLength) {
|
||||||
|
t.Fatalf("expected validated keyboard to reject callback data, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCallbackDataEncodeValidatedBoundaries(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
command string
|
||||||
|
wantLen int
|
||||||
|
wantErr error
|
||||||
|
}{
|
||||||
|
{name: "one byte", command: "", wantLen: 1},
|
||||||
|
{name: "64 bytes", command: strings.Repeat("a", 63), wantLen: 64},
|
||||||
|
{name: "65 bytes", command: strings.Repeat("a", 64), wantErr: ErrCallbackDataLength},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
encoded, err := (CallbackData{Command: tt.command}).EncodeValidated(BotPayloadCompact)
|
||||||
|
if !errors.Is(err, tt.wantErr) {
|
||||||
|
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||||
|
}
|
||||||
|
if err == nil && len([]byte(encoded)) != tt.wantLen {
|
||||||
|
t.Fatalf("encoded length = %d, want %d", len([]byte(encoded)), tt.wantLen)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if _, err := (CallbackData{Command: "ok"}).EncodeValidated(BotPayloadType("unknown")); !errors.Is(err, ErrInvalidPayloadType) {
|
||||||
|
t.Fatalf("expected ErrInvalidPayloadType, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInlineKeyboardLoweredMaxRowStillWraps(t *testing.T) {
|
||||||
|
keyboard := NewInlineKeyboardJSON(3).
|
||||||
|
AddURLButton("A", "https://example.test/a").
|
||||||
|
AddURLButton("B", "https://example.test/b").
|
||||||
|
SetMaxRow(1).
|
||||||
|
AddURLButton("C", "https://example.test/c")
|
||||||
|
|
||||||
|
markup := keyboard.Get()
|
||||||
|
if len(markup.InlineKeyboard) != 2 || len(markup.InlineKeyboard[0]) != 2 || len(markup.InlineKeyboard[1]) != 1 {
|
||||||
|
t.Fatalf("lowered maxRow stopped automatic wrapping: %#v", markup.InlineKeyboard)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+151
-31
@@ -31,7 +31,9 @@ import (
|
|||||||
// reply helpers need Msg, while inline callback edit helpers can work through
|
// reply helpers need Msg, while inline callback edit helpers can work through
|
||||||
// InlineMsgID when there is no chat message.
|
// InlineMsgID when there is no chat message.
|
||||||
type MessageContext struct {
|
type MessageContext struct {
|
||||||
|
// API is the Telegram API client used by context helpers.
|
||||||
API *tgapi.API
|
API *tgapi.API
|
||||||
|
// Update is the Telegram update being handled.
|
||||||
Update tgapi.Update
|
Update tgapi.Update
|
||||||
|
|
||||||
// Msg is the normalized Telegram message for message-backed update kinds.
|
// Msg is the normalized Telegram message for message-backed update kinds.
|
||||||
@@ -81,42 +83,60 @@ type MessageContext struct {
|
|||||||
payloadType BotPayloadType
|
payloadType BotPayloadType
|
||||||
sceneRuntime sceneRuntime
|
sceneRuntime sceneRuntime
|
||||||
observer Observer
|
observer Observer
|
||||||
|
eventEmitter func(context.Context, Event)
|
||||||
|
asyncTask func(func())
|
||||||
botID int64
|
botID int64
|
||||||
|
|
||||||
ctx context.Context
|
ctx context.Context
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (ctx *MessageContext) buildEditMessageTextParams(messageID int, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) (tgapi.EditMessageText, error) {
|
||||||
|
params := tgapi.EditMessageText{}
|
||||||
|
switch {
|
||||||
|
case messageID > 0 && ctx.Msg != nil && ctx.Msg.Chat != nil:
|
||||||
|
params.MessageID = messageID
|
||||||
|
params.ChatID = ctx.Msg.Chat.ID
|
||||||
|
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||||
|
case ctx.InlineMsgID != "":
|
||||||
|
params.InlineMessageID = ctx.InlineMsgID
|
||||||
|
default:
|
||||||
|
return params, ErrEditTargetMissing
|
||||||
|
}
|
||||||
|
if parseMode != "" {
|
||||||
|
params.ParseMode = parseMode
|
||||||
|
}
|
||||||
|
if keyboard != nil {
|
||||||
|
params.ReplyMarkup = keyboard.Get()
|
||||||
|
}
|
||||||
|
return params, nil
|
||||||
|
}
|
||||||
|
|
||||||
// AnswerMessage represents a message sent or edited via MessageContext.
|
// AnswerMessage represents a message sent or edited via MessageContext.
|
||||||
// It holds metadata to allow further editing or deletion.
|
// It holds metadata to allow further editing or deletion.
|
||||||
type AnswerMessage struct {
|
type AnswerMessage struct {
|
||||||
|
// MessageID identifies the sent Telegram message.
|
||||||
MessageID int
|
MessageID int
|
||||||
|
// Text contains the text or caption sent with the message.
|
||||||
|
// For rich messages, it contains rendered HTML for v1 compatibility.
|
||||||
Text string
|
Text string
|
||||||
|
// RichHTML contains the rendered HTML of a rich message.
|
||||||
|
RichHTML string // Since: Bot API 10.2
|
||||||
|
// IsMedia reports whether the answer contains media.
|
||||||
IsMedia bool
|
IsMedia bool
|
||||||
ctx *MessageContext // internal back-reference
|
ctx *MessageContext // internal back-reference
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ctx *MessageContext) edit(messageID int, text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
func (ctx *MessageContext) edit(messageID int, text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
params, err := ctx.buildEditMessageTextParams(messageID, keyboard, parseMode)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
if err := validateMessageText(text); err != nil {
|
if err := validateMessageText(text); err != nil {
|
||||||
ctx.Logger.Errorln(err)
|
ctx.Logger.Errorln(err)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
params := tgapi.EditMessageText{
|
params.Text = text
|
||||||
Text: text,
|
|
||||||
ParseMode: parseMode,
|
|
||||||
}
|
|
||||||
switch {
|
|
||||||
case messageID > 0 && ctx.Msg != nil:
|
|
||||||
params.MessageID = messageID
|
|
||||||
params.ChatID = ctx.Msg.Chat.ID
|
|
||||||
case ctx.InlineMsgID != "":
|
|
||||||
params.InlineMessageID = ctx.InlineMsgID
|
|
||||||
default:
|
|
||||||
ctx.Logger.Errorln(ErrEditTargetMissing)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if keyboard != nil {
|
|
||||||
params.ReplyMarkup = keyboard.Get()
|
|
||||||
}
|
|
||||||
msg, _, err := ctx.API.EditMessageTextWithContext(ctx.Context(), params)
|
msg, _, err := ctx.API.EditMessageTextWithContext(ctx.Context(), params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
ctx.Logger.Errorln(err)
|
ctx.Logger.Errorln(err)
|
||||||
@@ -187,9 +207,10 @@ func (ctx *MessageContext) editPhotoText(messageID int, text string, kb *InlineK
|
|||||||
ParseMode: parseMode,
|
ParseMode: parseMode,
|
||||||
}
|
}
|
||||||
switch {
|
switch {
|
||||||
case messageID > 0 && ctx.Msg != nil:
|
case messageID > 0 && ctx.Msg != nil && ctx.Msg.Chat != nil:
|
||||||
params.ChatID = ctx.Msg.Chat.ID
|
params.ChatID = ctx.Msg.Chat.ID
|
||||||
params.MessageID = messageID
|
params.MessageID = messageID
|
||||||
|
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||||
case ctx.InlineMsgID != "":
|
case ctx.InlineMsgID != "":
|
||||||
params.InlineMessageID = ctx.InlineMsgID
|
params.InlineMessageID = ctx.InlineMsgID
|
||||||
default:
|
default:
|
||||||
@@ -239,7 +260,7 @@ func (m *AnswerMessage) EditCaptionKeyboardMarkdown(text string, kb *InlineKeybo
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (ctx *MessageContext) answer(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
func (ctx *MessageContext) answer(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -248,6 +269,7 @@ func (ctx *MessageContext) answer(text string, keyboard *InlineKeyboard, parseMo
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
params := tgapi.SendMessage{
|
params := tgapi.SendMessage{
|
||||||
|
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
Text: text,
|
Text: text,
|
||||||
ParseMode: parseMode,
|
ParseMode: parseMode,
|
||||||
@@ -333,7 +355,7 @@ func (ctx *MessageContext) answerLong(text string, keyboard *InlineKeyboard, par
|
|||||||
ctx.Logger.Errorln(ErrMessageSplitImpossible)
|
ctx.Logger.Errorln(ErrMessageSplitImpossible)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -368,7 +390,7 @@ func (ctx *MessageContext) answerLong(text string, keyboard *InlineKeyboard, par
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (ctx *MessageContext) answerPhoto(photoID, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
func (ctx *MessageContext) answerPhoto(photoID, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -377,6 +399,7 @@ func (ctx *MessageContext) answerPhoto(photoID, text string, kb *InlineKeyboard,
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
params := tgapi.SendPhoto{
|
params := tgapi.SendPhoto{
|
||||||
|
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
Caption: text,
|
Caption: text,
|
||||||
ParseMode: parseMode,
|
ParseMode: parseMode,
|
||||||
@@ -443,7 +466,7 @@ func (ctx *MessageContext) delete(messageID int) {
|
|||||||
ctx.Logger.Errorln(ErrMessageIDZero)
|
ctx.Logger.Errorln(ErrMessageIDZero)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -495,12 +518,14 @@ func (ctx *MessageContext) AnswerCallbackURL(u string) { ctx.answerCallbackQuery
|
|||||||
|
|
||||||
// SendAction sends a chat action (typing, uploading_photo, etc.) to indicate bot activity.
|
// SendAction sends a chat action (typing, uploading_photo, etc.) to indicate bot activity.
|
||||||
func (ctx *MessageContext) SendAction(action tgapi.ChatActionType) {
|
func (ctx *MessageContext) SendAction(action tgapi.ChatActionType) {
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
params := tgapi.SendChatAction{
|
params := tgapi.SendChatAction{
|
||||||
ChatID: ctx.Msg.Chat.ID, Action: action,
|
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||||
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
|
Action: action,
|
||||||
}
|
}
|
||||||
if ctx.Msg.MessageThreadID > 0 {
|
if ctx.Msg.MessageThreadID > 0 {
|
||||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||||
@@ -537,7 +562,7 @@ func (ctx *MessageContext) error(err error) {
|
|||||||
func (ctx *MessageContext) Error(err error) { ctx.error(err) }
|
func (ctx *MessageContext) Error(err error) { ctx.error(err) }
|
||||||
|
|
||||||
func (ctx *MessageContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
func (ctx *MessageContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -631,19 +656,19 @@ func bindPositional(args []string, dst any) error {
|
|||||||
case reflect.String:
|
case reflect.String:
|
||||||
field.SetString(raw)
|
field.SetString(raw)
|
||||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
n, err := strconv.ParseInt(raw, 10, 64)
|
n, err := strconv.ParseInt(raw, 10, field.Type().Bits())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
}
|
}
|
||||||
field.SetInt(n)
|
field.SetInt(n)
|
||||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||||
n, err := strconv.ParseUint(raw, 10, 64)
|
n, err := strconv.ParseUint(raw, 10, field.Type().Bits())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
}
|
}
|
||||||
field.SetUint(n)
|
field.SetUint(n)
|
||||||
case reflect.Float32, reflect.Float64:
|
case reflect.Float32, reflect.Float64:
|
||||||
f, err := strconv.ParseFloat(raw, 64)
|
f, err := strconv.ParseFloat(raw, field.Type().Bits())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
}
|
}
|
||||||
@@ -686,7 +711,14 @@ func (ctx *MessageContext) Context() context.Context {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (ctx *MessageContext) emitPolicyChecked(event PolicyCheckedEvent) {
|
func (ctx *MessageContext) emitPolicyChecked(event PolicyCheckedEvent) {
|
||||||
if ctx == nil || ctx.observer == nil {
|
if ctx == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if ctx.eventEmitter != nil {
|
||||||
|
ctx.eventEmitter(ctx.Context(), event)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if ctx.observer == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer func() {
|
defer func() {
|
||||||
@@ -814,7 +846,7 @@ func (ctx *MessageContext) UpsertKeyboardMarkdown(text string, keyboard *InlineK
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *InlineKeyboard) *AnswerMessage {
|
func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *InlineKeyboard) *AnswerMessage {
|
||||||
if ctx.Msg == nil {
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -831,6 +863,9 @@ func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *Inl
|
|||||||
if ctx.Msg.DirectMessageTopic != nil {
|
if ctx.Msg.DirectMessageTopic != nil {
|
||||||
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||||
}
|
}
|
||||||
|
if ctx.Msg.BusinessConnectionID != "" {
|
||||||
|
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||||
|
}
|
||||||
|
|
||||||
msg, err := ctx.API.SendRichMessageWithContext(ctx.Context(), params)
|
msg, err := ctx.API.SendRichMessageWithContext(ctx.Context(), params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -838,7 +873,11 @@ func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *Inl
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return &AnswerMessage{
|
return &AnswerMessage{
|
||||||
MessageID: msg.MessageID, ctx: ctx, Text: rich.HTML, IsMedia: false,
|
MessageID: msg.MessageID,
|
||||||
|
Text: rich.HTML,
|
||||||
|
RichHTML: rich.HTML,
|
||||||
|
IsMedia: false,
|
||||||
|
ctx: ctx,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -864,3 +903,84 @@ func (ctx *MessageContext) RichAnswer(blocks ...tgapi.InputRichBlock) *AnswerMes
|
|||||||
func (ctx *MessageContext) RichAnswerKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
func (ctx *MessageContext) RichAnswerKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
return ctx.richBlocksAnswer(keyboard, blocks...)
|
return ctx.richBlocksAnswer(keyboard, blocks...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (ctx *MessageContext) editRich(messageID int, keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
params, err := ctx.buildEditMessageTextParams(messageID, keyboard, "")
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
rich, err := tgrich.BuildHTML(blocks...)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
params.RichMessage = &rich
|
||||||
|
msg, _, err := ctx.API.EditMessageTextWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
resultMessageID := messageID
|
||||||
|
if msg.MessageID > 0 {
|
||||||
|
resultMessageID = msg.MessageID
|
||||||
|
}
|
||||||
|
return &AnswerMessage{
|
||||||
|
MessageID: resultMessageID, Text: rich.HTML, RichHTML: rich.HTML, IsMedia: false, ctx: ctx,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func (ctx *MessageContext) editRichCallback(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
if ctx.CallbackMsgID == 0 && ctx.InlineMsgID == "" {
|
||||||
|
ctx.Logger.Errorln(ErrCallbackMessageMissing)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return ctx.editRich(ctx.CallbackMsgID, keyboard, blocks...)
|
||||||
|
}
|
||||||
|
func (ctx *MessageContext) upsertRichKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
if ctx.IsCallback() {
|
||||||
|
if ctx.HasPhoto() {
|
||||||
|
rich, err := tgrich.BuildHTML(blocks...)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
ctx.CallbackDelete()
|
||||||
|
return ctx.richAnswer(rich, keyboard)
|
||||||
|
}
|
||||||
|
return ctx.editRichCallback(keyboard, blocks...)
|
||||||
|
}
|
||||||
|
return ctx.richBlocksAnswer(keyboard, blocks...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditCallbackRich builds rich blocks and replaces the callback message content and inline keyboard.
|
||||||
|
// It doesn't upload local files referenced with attach://.
|
||||||
|
//
|
||||||
|
// Since: Bot API 10.2
|
||||||
|
func (ctx *MessageContext) EditCallbackRich(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
return ctx.editRichCallback(keyboard, blocks...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpsertKeyboardRich builds rich blocks and either edits the callback message or sends a new message.
|
||||||
|
// Photo callback messages are replaced because their text content can't be edited directly.
|
||||||
|
// It doesn't upload local files referenced with attach://.
|
||||||
|
//
|
||||||
|
// Since: Bot API 10.2
|
||||||
|
func (ctx *MessageContext) UpsertKeyboardRich(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
return ctx.upsertRichKeyboard(keyboard, blocks...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditRich builds rich blocks and replaces the message content without changing its inline keyboard.
|
||||||
|
// It doesn't upload local files referenced with attach://.
|
||||||
|
//
|
||||||
|
// Since: Bot API 10.2
|
||||||
|
func (m *AnswerMessage) EditRich(blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
return m.ctx.editRich(m.MessageID, nil, blocks...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditRichKeyboard builds rich blocks and replaces the message content and inline keyboard.
|
||||||
|
// It doesn't upload local files referenced with attach://.
|
||||||
|
//
|
||||||
|
// Since: Bot API 10.2
|
||||||
|
func (m *AnswerMessage) EditRichKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||||
|
return m.ctx.editRich(m.MessageID, keyboard, blocks...)
|
||||||
|
}
|
||||||
|
|||||||
+312
-1
@@ -14,6 +14,101 @@ import (
|
|||||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func newMessageContextTestAPI(t *testing.T, transport roundTripFunc) *tgapi.API {
|
||||||
|
t.Helper()
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{Transport: transport}),
|
||||||
|
)
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return api
|
||||||
|
}
|
||||||
|
|
||||||
|
func readMessageContextRequest(t *testing.T, req *http.Request) map[string]any {
|
||||||
|
t.Helper()
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
var decoded map[string]any
|
||||||
|
if err := json.Unmarshal(body, &decoded); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return decoded
|
||||||
|
}
|
||||||
|
|
||||||
|
func messageContextResponse(result string) *http.Response {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":` + result + `}`)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMessageContextPropagatesBusinessConnection(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
wantMethod string
|
||||||
|
result string
|
||||||
|
invoke func(*MessageContext)
|
||||||
|
}{
|
||||||
|
{name: "send message", wantMethod: "sendMessage", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { ctx.Answer("text") }},
|
||||||
|
{name: "send photo", wantMethod: "sendPhoto", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { ctx.AnswerPhoto("photo-id", "caption") }},
|
||||||
|
{name: "edit caption", wantMethod: "editMessageCaption", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { (&AnswerMessage{MessageID: 7, ctx: ctx}).EditCaption("caption") }},
|
||||||
|
{name: "send action", wantMethod: "sendChatAction", result: `true`, invoke: func(ctx *MessageContext) { ctx.SendAction(tgapi.ChatActionTyping) }},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
var gotBody map[string]any
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
if !strings.HasSuffix(req.URL.Path, "/"+tt.wantMethod) {
|
||||||
|
t.Fatalf("request path = %q, want method %q", req.URL.Path, tt.wantMethod)
|
||||||
|
}
|
||||||
|
gotBody = readMessageContextRequest(t, req)
|
||||||
|
return messageContextResponse(tt.result), nil
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
BusinessConnectionID: "business-1",
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
tt.invoke(ctx)
|
||||||
|
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||||
|
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMessageContextHelpersRejectMissingChat(t *testing.T) {
|
||||||
|
requests := 0
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
return nil, errors.New("unexpected request")
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{API: api, Msg: &tgapi.Message{}, CallbackMsgID: 7, Logger: sneklog.NewLogger()}
|
||||||
|
|
||||||
|
if answer := ctx.Answer("text"); answer != nil {
|
||||||
|
t.Fatalf("Answer returned %#v for a message without a chat", answer)
|
||||||
|
}
|
||||||
|
if answer := ctx.EditCallback("text", nil); answer != nil {
|
||||||
|
t.Fatalf("EditCallback returned %#v for a message without a chat", answer)
|
||||||
|
}
|
||||||
|
if requests != 0 {
|
||||||
|
t.Fatalf("missing-chat helpers made %d requests", requests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestRichAnswerBuildsInputBlocks(t *testing.T) {
|
func TestRichAnswerBuildsInputBlocks(t *testing.T) {
|
||||||
var gotBody map[string]any
|
var gotBody map[string]any
|
||||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
@@ -34,7 +129,10 @@ func TestRichAnswerBuildsInputBlocks(t *testing.T) {
|
|||||||
defer func() { _ = api.Close() }()
|
defer func() { _ = api.Close() }()
|
||||||
ctx := &MessageContext{
|
ctx := &MessageContext{
|
||||||
API: api,
|
API: api,
|
||||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
Msg: &tgapi.Message{
|
||||||
|
BusinessConnectionID: "business-1",
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
Logger: sneklog.NewLogger(),
|
Logger: sneklog.NewLogger(),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -49,6 +147,12 @@ func TestRichAnswerBuildsInputBlocks(t *testing.T) {
|
|||||||
if _, exists := rich["skip_entity_detection"]; exists {
|
if _, exists := rich["skip_entity_detection"]; exists {
|
||||||
t.Fatalf("rich_message unexpectedly disables entity detection: %#v", rich)
|
t.Fatalf("rich_message unexpectedly disables entity detection: %#v", rich)
|
||||||
}
|
}
|
||||||
|
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||||
|
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||||
|
}
|
||||||
|
if answer.Text != "<p><b>ready</b></p>" || answer.RichHTML != answer.Text {
|
||||||
|
t.Fatalf("unexpected answer content: Text=%q RichHTML=%q", answer.Text, answer.RichHTML)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRichAnswerRejectsInvalidBlocksWithoutRequest(t *testing.T) {
|
func TestRichAnswerRejectsInvalidBlocksWithoutRequest(t *testing.T) {
|
||||||
@@ -69,6 +173,190 @@ func TestRichAnswerRejectsInvalidBlocksWithoutRequest(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAnswerMessageEditRich(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
withKeyboard bool
|
||||||
|
}{
|
||||||
|
{name: "content only"},
|
||||||
|
{name: "content and keyboard", withKeyboard: true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
var gotPath string
|
||||||
|
var gotBody map[string]any
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
gotPath = req.URL.Path
|
||||||
|
gotBody = readMessageContextRequest(t, req)
|
||||||
|
return messageContextResponse(`{"message_id":11,"date":1}`), nil
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
BusinessConnectionID: "business-1",
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
original := &AnswerMessage{MessageID: 7, ctx: ctx}
|
||||||
|
block := tgrich.P(tgrich.Bold(tgrich.Text("updated")))
|
||||||
|
|
||||||
|
var answer *AnswerMessage
|
||||||
|
if tt.withKeyboard {
|
||||||
|
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||||
|
answer = original.EditRichKeyboard(kb, block)
|
||||||
|
} else {
|
||||||
|
answer = original.EditRich(block)
|
||||||
|
}
|
||||||
|
|
||||||
|
if answer == nil {
|
||||||
|
t.Fatal("rich edit returned nil")
|
||||||
|
}
|
||||||
|
if gotPath != "/bottoken/editMessageText" {
|
||||||
|
t.Fatalf("unexpected request path: %s", gotPath)
|
||||||
|
}
|
||||||
|
if got := gotBody["chat_id"]; got != float64(42) {
|
||||||
|
t.Fatalf("chat_id = %v, want 42", got)
|
||||||
|
}
|
||||||
|
if got := gotBody["message_id"]; got != float64(7) {
|
||||||
|
t.Fatalf("message_id = %v, want 7", got)
|
||||||
|
}
|
||||||
|
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||||
|
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||||
|
}
|
||||||
|
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||||
|
if !ok || rich["html"] != "<p><b>updated</b></p>" {
|
||||||
|
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||||
|
}
|
||||||
|
if _, exists := gotBody["text"]; exists {
|
||||||
|
t.Fatalf("edit request unexpectedly contains text: %#v", gotBody)
|
||||||
|
}
|
||||||
|
_, hasKeyboard := gotBody["reply_markup"]
|
||||||
|
if hasKeyboard != tt.withKeyboard {
|
||||||
|
t.Fatalf("reply_markup presence = %v, want %v", hasKeyboard, tt.withKeyboard)
|
||||||
|
}
|
||||||
|
if answer.MessageID != 11 || answer.Text != "<p><b>updated</b></p>" || answer.RichHTML != answer.Text {
|
||||||
|
t.Fatalf("unexpected answer: %#v", answer)
|
||||||
|
}
|
||||||
|
if answer.ctx != ctx {
|
||||||
|
t.Fatal("edited answer lost its message context")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEditCallbackRichEditsInlineMessage(t *testing.T) {
|
||||||
|
var gotBody map[string]any
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
gotBody = readMessageContextRequest(t, req)
|
||||||
|
return messageContextResponse("true"), nil
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
InlineMsgID: "inline-1",
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||||
|
|
||||||
|
answer := ctx.EditCallbackRich(kb, tgrich.P(tgrich.Text("inline")))
|
||||||
|
if answer == nil {
|
||||||
|
t.Fatal("EditCallbackRich returned nil")
|
||||||
|
}
|
||||||
|
if got := gotBody["inline_message_id"]; got != "inline-1" {
|
||||||
|
t.Fatalf("inline_message_id = %v, want inline-1", got)
|
||||||
|
}
|
||||||
|
if _, exists := gotBody["chat_id"]; exists {
|
||||||
|
t.Fatalf("inline edit unexpectedly contains chat_id: %#v", gotBody)
|
||||||
|
}
|
||||||
|
if _, exists := gotBody["business_connection_id"]; exists {
|
||||||
|
t.Fatalf("inline edit unexpectedly contains business_connection_id: %#v", gotBody)
|
||||||
|
}
|
||||||
|
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||||
|
if !ok || rich["html"] != "<p>inline</p>" {
|
||||||
|
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||||
|
}
|
||||||
|
if _, exists := gotBody["reply_markup"]; !exists {
|
||||||
|
t.Fatal("inline rich edit has no reply_markup")
|
||||||
|
}
|
||||||
|
if answer.MessageID != 0 || answer.Text != "<p>inline</p>" || answer.RichHTML != answer.Text {
|
||||||
|
t.Fatalf("unexpected inline answer: %#v", answer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpsertKeyboardRichValidatesPhotoBeforeDelete(t *testing.T) {
|
||||||
|
requests := 0
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
t.Fatalf("unexpected request to %s", req.URL.Path)
|
||||||
|
return nil, nil
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
CallbackMsgID: 7,
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
Photo: []tgapi.PhotoSize{{FileID: "photo-1"}},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
answer := ctx.UpsertKeyboardRich(nil, tgrich.H(tgrich.Text("invalid"), 0))
|
||||||
|
if answer != nil {
|
||||||
|
t.Fatalf("UpsertKeyboardRich returned an answer for invalid blocks: %#v", answer)
|
||||||
|
}
|
||||||
|
if requests != 0 {
|
||||||
|
t.Fatalf("invalid photo upsert made %d requests", requests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpsertKeyboardRichReplacesPhotoCallback(t *testing.T) {
|
||||||
|
var paths []string
|
||||||
|
var sendBody map[string]any
|
||||||
|
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
paths = append(paths, req.URL.Path)
|
||||||
|
switch req.URL.Path {
|
||||||
|
case "/bottoken/deleteMessage":
|
||||||
|
return messageContextResponse("true"), nil
|
||||||
|
case "/bottoken/sendRichMessage":
|
||||||
|
sendBody = readMessageContextRequest(t, req)
|
||||||
|
return messageContextResponse(`{"message_id":12,"date":1}`), nil
|
||||||
|
default:
|
||||||
|
t.Fatalf("unexpected request path: %s", req.URL.Path)
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
CallbackMsgID: 7,
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
Photo: []tgapi.PhotoSize{{FileID: "photo-1"}},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||||
|
|
||||||
|
answer := ctx.UpsertKeyboardRich(kb, tgrich.P(tgrich.Text("replacement")))
|
||||||
|
if answer == nil {
|
||||||
|
t.Fatal("UpsertKeyboardRich returned nil")
|
||||||
|
}
|
||||||
|
wantPaths := []string{"/bottoken/deleteMessage", "/bottoken/sendRichMessage"}
|
||||||
|
if !reflect.DeepEqual(paths, wantPaths) {
|
||||||
|
t.Fatalf("request paths = %#v, want %#v", paths, wantPaths)
|
||||||
|
}
|
||||||
|
rich, ok := sendBody["rich_message"].(map[string]any)
|
||||||
|
if !ok || rich["html"] != "<p>replacement</p>" {
|
||||||
|
t.Fatalf("rich_message = %#v", sendBody["rich_message"])
|
||||||
|
}
|
||||||
|
if _, exists := sendBody["reply_markup"]; !exists {
|
||||||
|
t.Fatal("replacement rich message has no reply_markup")
|
||||||
|
}
|
||||||
|
if answer.MessageID != 12 || answer.Text != "<p>replacement</p>" || answer.RichHTML != answer.Text {
|
||||||
|
t.Fatalf("unexpected replacement answer: %#v", answer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
||||||
var gotBody map[string]any
|
var gotBody map[string]any
|
||||||
|
|
||||||
@@ -223,6 +511,29 @@ func TestBindArgsReportsConversionFailures(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBindArgsRejectsNumericOverflow(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
arg string
|
||||||
|
dst any
|
||||||
|
}{
|
||||||
|
{name: "int8 positive", arg: "128", dst: &struct{ Value int8 }{}},
|
||||||
|
{name: "int8 negative", arg: "-129", dst: &struct{ Value int8 }{}},
|
||||||
|
{name: "uint8 positive", arg: "256", dst: &struct{ Value uint8 }{}},
|
||||||
|
{name: "uint8 negative", arg: "-1", dst: &struct{ Value uint8 }{}},
|
||||||
|
{name: "float32", arg: "3.5e39", dst: &struct{ Value float32 }{}},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
ctx := &MessageContext{Args: []string{tt.arg}}
|
||||||
|
if err := ctx.BindArgs(tt.dst); !errors.Is(err, ErrBindArgsConversion) {
|
||||||
|
t.Fatalf("expected ErrBindArgsConversion, got %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestBindArgsRejectsUnsupportedFieldTypes(t *testing.T) {
|
func TestBindArgsRejectsUnsupportedFieldTypes(t *testing.T) {
|
||||||
type input struct {
|
type input struct {
|
||||||
Tags []string
|
Tags []string
|
||||||
|
|||||||
+13
-4
@@ -1,8 +1,10 @@
|
|||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
"unicode"
|
||||||
|
|
||||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
@@ -21,8 +23,9 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MessageContext) bool
|
|||||||
|
|
||||||
if strings.Contains(cmd, "@") {
|
if strings.Contains(cmd, "@") {
|
||||||
botUsername := bot.username
|
botUsername := bot.username
|
||||||
if botUsername != "" && strings.HasSuffix(cmd, "@"+botUsername) {
|
at := strings.LastIndexByte(cmd, '@')
|
||||||
cmd = cmd[:len(cmd)-len("@"+botUsername)] // remove @botname
|
if at > 0 && botUsername != "" && strings.EqualFold(cmd[at+1:], botUsername) {
|
||||||
|
cmd = cmd[:at] // remove @botname
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -52,6 +55,9 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MessageContext) bool
|
|||||||
})
|
})
|
||||||
|
|
||||||
err := plugin.executeCmd(cmd, ctx, bot.appData)
|
err := plugin.executeCmd(cmd, ctx, bot.appData)
|
||||||
|
if errors.Is(err, errMiddlewareBlocked) {
|
||||||
|
err = nil
|
||||||
|
}
|
||||||
handlerEndEvent := HandlerFinishedEvent{
|
handlerEndEvent := HandlerFinishedEvent{
|
||||||
UpdateID: update.UpdateID,
|
UpdateID: update.UpdateID,
|
||||||
UpdateType: update.Type,
|
UpdateType: update.Type,
|
||||||
@@ -125,7 +131,7 @@ func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MessageContext) boo
|
|||||||
FromID: pluginCtx.FromID,
|
FromID: pluginCtx.FromID,
|
||||||
ChatID: pluginCtx.ChatID,
|
ChatID: pluginCtx.ChatID,
|
||||||
})
|
})
|
||||||
err := plugin.messageFallback(pluginCtx, bot.appData)
|
err := callCommandExecutor(plugin.messageFallback, pluginCtx, bot.appData)
|
||||||
endEvent := HandlerFinishedEvent{
|
endEvent := HandlerFinishedEvent{
|
||||||
UpdateID: update.UpdateID,
|
UpdateID: update.UpdateID,
|
||||||
UpdateType: update.Type,
|
UpdateType: update.Type,
|
||||||
@@ -227,6 +233,9 @@ func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MessageContext) boo
|
|||||||
ChatID: ctx.ChatID,
|
ChatID: ctx.ChatID,
|
||||||
})
|
})
|
||||||
err := plugin.executePayload(data.Command, ctx, bot.appData)
|
err := plugin.executePayload(data.Command, ctx, bot.appData)
|
||||||
|
if errors.Is(err, errMiddlewareBlocked) {
|
||||||
|
err = nil
|
||||||
|
}
|
||||||
|
|
||||||
endEvent := HandlerFinishedEvent{
|
endEvent := HandlerFinishedEvent{
|
||||||
UpdateID: update.UpdateID,
|
UpdateID: update.UpdateID,
|
||||||
@@ -282,7 +291,7 @@ func (bot *Bot[T]) checkPrefixes(text string) (string, bool) {
|
|||||||
func (bot *Bot[T]) parseCommand(text string) (prefix, cmd, args string) {
|
func (bot *Bot[T]) parseCommand(text string) (prefix, cmd, args string) {
|
||||||
if prefix, hasPrefix := bot.checkPrefixes(text); hasPrefix {
|
if prefix, hasPrefix := bot.checkPrefixes(text); hasPrefix {
|
||||||
text = strings.TrimSpace(text[len(prefix):])
|
text = strings.TrimSpace(text[len(prefix):])
|
||||||
spaceIndex := strings.Index(text, " ")
|
spaceIndex := strings.IndexFunc(text, unicode.IsSpace)
|
||||||
var cmd string
|
var cmd string
|
||||||
var args string
|
var args string
|
||||||
if spaceIndex == -1 {
|
if spaceIndex == -1 {
|
||||||
|
|||||||
+83
-9
@@ -50,6 +50,10 @@ func emitContextError(ctx *MessageContext, event ErrorEvent) {
|
|||||||
if ctx.Logger != nil {
|
if ctx.Logger != nil {
|
||||||
ctx.Logger.Errorln(event.Err)
|
ctx.Logger.Errorln(event.Err)
|
||||||
}
|
}
|
||||||
|
if ctx.eventEmitter != nil {
|
||||||
|
ctx.eventEmitter(ctx.Context(), event)
|
||||||
|
return
|
||||||
|
}
|
||||||
if ctx.observer == nil {
|
if ctx.observer == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -63,93 +67,149 @@ func emitContextError(ctx *MessageContext, event ErrorEvent) {
|
|||||||
|
|
||||||
// UpdateReceivedEvent describes an update entering the bot runtime.
|
// UpdateReceivedEvent describes an update entering the bot runtime.
|
||||||
type UpdateReceivedEvent struct {
|
type UpdateReceivedEvent struct {
|
||||||
|
// UpdateID identifies the Telegram update.
|
||||||
UpdateID int
|
UpdateID int
|
||||||
|
// UpdateType identifies the normalized update kind.
|
||||||
UpdateType tgapi.UpdateType
|
UpdateType tgapi.UpdateType
|
||||||
|
// FromID identifies the originating user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the originating chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// UpdateHandledEvent describes a completed update execution path.
|
// UpdateHandledEvent describes a completed update execution path.
|
||||||
type UpdateHandledEvent struct {
|
type UpdateHandledEvent struct {
|
||||||
|
// UpdateID identifies the Telegram update.
|
||||||
UpdateID int
|
UpdateID int
|
||||||
|
// UpdateType identifies the normalized update kind.
|
||||||
UpdateType tgapi.UpdateType
|
UpdateType tgapi.UpdateType
|
||||||
|
// FromID identifies the originating user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the originating chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
|
// Duration is the total framework handling time.
|
||||||
Duration time.Duration
|
Duration time.Duration
|
||||||
|
// Handled reports whether a registered path handled the update.
|
||||||
Handled bool
|
Handled bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandlerStartedEvent describes a handler about to execute.
|
// HandlerStartedEvent describes a handler about to execute.
|
||||||
type HandlerStartedEvent struct {
|
type HandlerStartedEvent struct {
|
||||||
|
// UpdateID identifies the Telegram update.
|
||||||
UpdateID int
|
UpdateID int
|
||||||
|
// UpdateType identifies the normalized update kind.
|
||||||
UpdateType tgapi.UpdateType
|
UpdateType tgapi.UpdateType
|
||||||
|
// Plugin names the plugin that owns the handler.
|
||||||
Plugin string
|
Plugin string
|
||||||
|
// HandlerKind classifies the handler.
|
||||||
HandlerKind HandlerEventKind
|
HandlerKind HandlerEventKind
|
||||||
|
// HandlerName identifies the handler within its plugin and kind.
|
||||||
HandlerName string
|
HandlerName string
|
||||||
|
// FromID identifies the originating user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the originating chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandlerFinishedEvent describes a handler that has completed.
|
// HandlerFinishedEvent describes a handler that has completed.
|
||||||
type HandlerFinishedEvent struct {
|
type HandlerFinishedEvent struct {
|
||||||
|
// UpdateID identifies the Telegram update.
|
||||||
UpdateID int
|
UpdateID int
|
||||||
|
// UpdateType identifies the normalized update kind.
|
||||||
UpdateType tgapi.UpdateType
|
UpdateType tgapi.UpdateType
|
||||||
|
// Plugin names the plugin that owns the handler.
|
||||||
Plugin string
|
Plugin string
|
||||||
|
// HandlerKind classifies the handler.
|
||||||
HandlerKind HandlerEventKind
|
HandlerKind HandlerEventKind
|
||||||
|
// HandlerName identifies the handler within its plugin and kind.
|
||||||
HandlerName string
|
HandlerName string
|
||||||
|
// FromID identifies the originating user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the originating chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
|
// Duration is the handler execution time.
|
||||||
Duration time.Duration
|
Duration time.Duration
|
||||||
|
// Err is the error returned or recovered from the handler.
|
||||||
Err error
|
Err error
|
||||||
|
// UserFacing reports whether Err is safe to show to the user.
|
||||||
UserFacing bool
|
UserFacing bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// SceneTransitionEvent describes a scene state transition.
|
// SceneTransitionEvent describes a scene state transition.
|
||||||
type SceneTransitionEvent struct {
|
type SceneTransitionEvent struct {
|
||||||
|
// Plugin names the plugin that owns the scene.
|
||||||
Plugin string
|
Plugin string
|
||||||
|
// Scene names the transitioning scene.
|
||||||
Scene string
|
Scene string
|
||||||
|
// From is the previous scene step.
|
||||||
From string
|
From string
|
||||||
|
// To is the resulting scene step.
|
||||||
To string
|
To string
|
||||||
|
// Action identifies the requested state transition.
|
||||||
Action SceneAction
|
Action SceneAction
|
||||||
|
// FromID identifies the session user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the session chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// PolicyCheckedEvent describes the result of a policy evaluation.
|
// PolicyCheckedEvent describes the result of a policy evaluation.
|
||||||
type PolicyCheckedEvent struct {
|
type PolicyCheckedEvent struct {
|
||||||
|
// Name identifies the evaluated policy.
|
||||||
Name string
|
Name string
|
||||||
|
// Plugin names the plugin that requested the policy check.
|
||||||
Plugin string
|
Plugin string
|
||||||
|
// FromID identifies the evaluated user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the evaluated chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
|
// Passed reports whether the policy accepted the context.
|
||||||
Passed bool
|
Passed bool
|
||||||
|
// Err is the policy evaluation error, if any.
|
||||||
Err error
|
Err error
|
||||||
|
// Internal reports whether evaluation failed internally rather than denying access.
|
||||||
Internal bool
|
Internal bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// RunnerFinishedEvent describes a completed background runner execution.
|
// RunnerFinishedEvent describes a completed background runner execution.
|
||||||
type RunnerFinishedEvent struct {
|
type RunnerFinishedEvent struct {
|
||||||
|
// Name identifies the runner.
|
||||||
Name string
|
Name string
|
||||||
|
// Duration is the callback execution time.
|
||||||
Duration time.Duration
|
Duration time.Duration
|
||||||
|
// Err is the callback error or recovered panic.
|
||||||
Err error
|
Err error
|
||||||
}
|
}
|
||||||
|
|
||||||
// PollingRetryEvent describes a polling retry after a failed getUpdates call.
|
// PollingRetryEvent describes a polling retry after a failed getUpdates call.
|
||||||
type PollingRetryEvent struct {
|
type PollingRetryEvent struct {
|
||||||
|
// Attempt is the one-based retry number.
|
||||||
Attempt int
|
Attempt int
|
||||||
|
// Delay is the time before the next polling attempt.
|
||||||
Delay time.Duration
|
Delay time.Duration
|
||||||
|
// Err is the polling error that triggered the retry.
|
||||||
Err error
|
Err error
|
||||||
}
|
}
|
||||||
|
|
||||||
// ErrorEvent describes an error routed through framework error handling.
|
// ErrorEvent describes an error routed through framework error handling.
|
||||||
type ErrorEvent struct {
|
type ErrorEvent struct {
|
||||||
|
// UpdateID identifies the Telegram update when available.
|
||||||
UpdateID int
|
UpdateID int
|
||||||
|
// UpdateType identifies the normalized update kind when available.
|
||||||
UpdateType tgapi.UpdateType
|
UpdateType tgapi.UpdateType
|
||||||
|
// Plugin names the component that reported the error.
|
||||||
Plugin string
|
Plugin string
|
||||||
|
// HandlerKind classifies the failing handler or runtime component.
|
||||||
HandlerKind HandlerEventKind
|
HandlerKind HandlerEventKind
|
||||||
|
// HandlerName identifies the failing handler within its kind.
|
||||||
HandlerName string
|
HandlerName string
|
||||||
|
// FromID identifies the originating user when available.
|
||||||
FromID int64
|
FromID int64
|
||||||
|
// ChatID identifies the originating chat when available.
|
||||||
ChatID int64
|
ChatID int64
|
||||||
|
// Err is the reported error.
|
||||||
Err error
|
Err error
|
||||||
|
// UserFacing reports whether Err is safe to show to the user.
|
||||||
UserFacing bool
|
UserFacing bool
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -164,6 +224,12 @@ func (PollingRetryEvent) isEvent() {}
|
|||||||
func (ErrorEvent) isEvent() {}
|
func (ErrorEvent) isEvent() {}
|
||||||
|
|
||||||
// Observer receives best-effort runtime instrumentation events.
|
// Observer receives best-effort runtime instrumentation events.
|
||||||
|
//
|
||||||
|
// During RunWithContext and RunWebhookWithContext, callbacks execute on a
|
||||||
|
// dedicated dispatcher goroutine in enqueue order and never block update
|
||||||
|
// handlers. The queue is bounded; overload drops events and emits sampled
|
||||||
|
// warnings. Runtime shutdown cancels callback contexts and drains queued events;
|
||||||
|
// Bot.Close returns ErrObserverShutdownTimeout if a callback ignores cancellation.
|
||||||
type Observer interface {
|
type Observer interface {
|
||||||
OnUpdateReceived(ctx context.Context, event UpdateReceivedEvent)
|
OnUpdateReceived(ctx context.Context, event UpdateReceivedEvent)
|
||||||
OnUpdateHandled(ctx context.Context, event UpdateHandledEvent)
|
OnUpdateHandled(ctx context.Context, event UpdateHandledEvent)
|
||||||
@@ -180,6 +246,10 @@ func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) {
|
|||||||
if bot.observer == nil {
|
if bot.observer == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if bot.observerAsync != nil {
|
||||||
|
bot.observerAsync.enqueue(ctx, event)
|
||||||
|
return
|
||||||
|
}
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
if bot.logger != nil {
|
if bot.logger != nil {
|
||||||
@@ -191,24 +261,28 @@ func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (bot *Bot[T]) emitEvent(ctx context.Context, event Event) {
|
func (bot *Bot[T]) emitEvent(ctx context.Context, event Event) {
|
||||||
|
emitObserverEvent(bot.observer, ctx, event)
|
||||||
|
}
|
||||||
|
|
||||||
|
func emitObserverEvent(observer Observer, ctx context.Context, event Event) {
|
||||||
switch e := event.(type) {
|
switch e := event.(type) {
|
||||||
case UpdateReceivedEvent:
|
case UpdateReceivedEvent:
|
||||||
bot.observer.OnUpdateReceived(ctx, e)
|
observer.OnUpdateReceived(ctx, e)
|
||||||
case UpdateHandledEvent:
|
case UpdateHandledEvent:
|
||||||
bot.observer.OnUpdateHandled(ctx, e)
|
observer.OnUpdateHandled(ctx, e)
|
||||||
case HandlerStartedEvent:
|
case HandlerStartedEvent:
|
||||||
bot.observer.OnHandlerStarted(ctx, e)
|
observer.OnHandlerStarted(ctx, e)
|
||||||
case HandlerFinishedEvent:
|
case HandlerFinishedEvent:
|
||||||
bot.observer.OnHandlerFinished(ctx, e)
|
observer.OnHandlerFinished(ctx, e)
|
||||||
case SceneTransitionEvent:
|
case SceneTransitionEvent:
|
||||||
bot.observer.OnSceneTransition(ctx, e)
|
observer.OnSceneTransition(ctx, e)
|
||||||
case PolicyCheckedEvent:
|
case PolicyCheckedEvent:
|
||||||
bot.observer.OnPolicyChecked(ctx, e)
|
observer.OnPolicyChecked(ctx, e)
|
||||||
case RunnerFinishedEvent:
|
case RunnerFinishedEvent:
|
||||||
bot.observer.OnRunnerFinished(ctx, e)
|
observer.OnRunnerFinished(ctx, e)
|
||||||
case PollingRetryEvent:
|
case PollingRetryEvent:
|
||||||
bot.observer.OnPollingRetry(ctx, e)
|
observer.OnPollingRetry(ctx, e)
|
||||||
case ErrorEvent:
|
case ErrorEvent:
|
||||||
bot.observer.OnError(ctx, e)
|
observer.OnError(ctx, e)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,125 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
const observerQueueSize = 1024
|
||||||
|
|
||||||
|
type queuedObserverEvent struct {
|
||||||
|
ctx context.Context
|
||||||
|
event Event
|
||||||
|
}
|
||||||
|
|
||||||
|
type observerDispatcher struct {
|
||||||
|
observer Observer
|
||||||
|
logger *sneklog.Logger
|
||||||
|
ctx context.Context
|
||||||
|
cancel context.CancelFunc
|
||||||
|
queue chan queuedObserverEvent
|
||||||
|
stop chan struct{}
|
||||||
|
mu sync.RWMutex
|
||||||
|
closed bool
|
||||||
|
wg sync.WaitGroup
|
||||||
|
stopOnce sync.Once
|
||||||
|
dropped atomic.Uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
func newObserverDispatcher(observer Observer, logger *sneklog.Logger) *observerDispatcher {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
dispatcher := &observerDispatcher{
|
||||||
|
observer: observer,
|
||||||
|
logger: logger,
|
||||||
|
ctx: ctx,
|
||||||
|
cancel: cancel,
|
||||||
|
queue: make(chan queuedObserverEvent, observerQueueSize),
|
||||||
|
stop: make(chan struct{}),
|
||||||
|
}
|
||||||
|
dispatcher.wg.Add(1)
|
||||||
|
go dispatcher.run()
|
||||||
|
return dispatcher
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *observerDispatcher) enqueue(ctx context.Context, event Event) {
|
||||||
|
if ctx == nil {
|
||||||
|
ctx = context.Background()
|
||||||
|
}
|
||||||
|
ctx = observerEventContext{Context: context.WithoutCancel(ctx), lifecycle: d.ctx}
|
||||||
|
d.mu.RLock()
|
||||||
|
defer d.mu.RUnlock()
|
||||||
|
if d.closed {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case d.queue <- queuedObserverEvent{ctx: ctx, event: event}:
|
||||||
|
default:
|
||||||
|
dropped := d.dropped.Add(1)
|
||||||
|
if d.logger != nil && (dropped == 1 || dropped&(dropped-1) == 0) {
|
||||||
|
d.logger.Warnf("observer queue full; dropped %d events", dropped)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *observerDispatcher) run() {
|
||||||
|
defer d.wg.Done()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case queued := <-d.queue:
|
||||||
|
d.dispatch(queued)
|
||||||
|
case <-d.stop:
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case queued := <-d.queue:
|
||||||
|
d.dispatch(queued)
|
||||||
|
default:
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *observerDispatcher) dispatch(queued queuedObserverEvent) {
|
||||||
|
defer func() {
|
||||||
|
if recovered := recover(); recovered != nil && d.logger != nil {
|
||||||
|
d.logger.Errorln(fmt.Sprintf("panic in observer: %v", recovered))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
emitObserverEvent(d.observer, queued.ctx, queued.event)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *observerDispatcher) close(ctx context.Context) error {
|
||||||
|
d.stopOnce.Do(func() {
|
||||||
|
d.mu.Lock()
|
||||||
|
d.closed = true
|
||||||
|
d.cancel()
|
||||||
|
close(d.stop)
|
||||||
|
d.mu.Unlock()
|
||||||
|
})
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
d.wg.Wait()
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
return nil
|
||||||
|
case <-ctx.Done():
|
||||||
|
return fmt.Errorf("%w: %v", ErrObserverShutdownTimeout, ctx.Err())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type observerEventContext struct {
|
||||||
|
context.Context
|
||||||
|
lifecycle context.Context
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx observerEventContext) Deadline() (time.Time, bool) { return ctx.lifecycle.Deadline() }
|
||||||
|
func (ctx observerEventContext) Done() <-chan struct{} { return ctx.lifecycle.Done() }
|
||||||
|
func (ctx observerEventContext) Err() error { return ctx.lifecycle.Err() }
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type cancelAwareObserver struct {
|
||||||
|
testObserver
|
||||||
|
started chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *cancelAwareObserver) OnUpdateReceived(ctx context.Context, _ UpdateReceivedEvent) {
|
||||||
|
close(o.started)
|
||||||
|
<-ctx.Done()
|
||||||
|
}
|
||||||
|
|
||||||
|
type stubbornObserver struct {
|
||||||
|
testObserver
|
||||||
|
started chan struct{}
|
||||||
|
release chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *stubbornObserver) OnUpdateReceived(context.Context, UpdateReceivedEvent) {
|
||||||
|
close(o.started)
|
||||||
|
<-o.release
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestObserverDispatcherCancelsCallbackDuringClose(t *testing.T) {
|
||||||
|
observer := &cancelAwareObserver{started: make(chan struct{})}
|
||||||
|
dispatcher := newObserverDispatcher(observer, nil)
|
||||||
|
dispatcher.enqueue(context.Background(), UpdateReceivedEvent{})
|
||||||
|
<-observer.started
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := dispatcher.close(ctx); err != nil {
|
||||||
|
t.Fatalf("close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestObserverDispatcherCloseTimeout(t *testing.T) {
|
||||||
|
observer := &stubbornObserver{started: make(chan struct{}), release: make(chan struct{})}
|
||||||
|
dispatcher := newObserverDispatcher(observer, nil)
|
||||||
|
dispatcher.enqueue(context.Background(), UpdateReceivedEvent{})
|
||||||
|
<-observer.started
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
|
||||||
|
defer cancel()
|
||||||
|
if err := dispatcher.close(ctx); !errors.Is(err, ErrObserverShutdownTimeout) {
|
||||||
|
t.Fatalf("close error = %v, want ErrObserverShutdownTimeout", err)
|
||||||
|
}
|
||||||
|
close(observer.release)
|
||||||
|
if err := dispatcher.close(context.Background()); err != nil {
|
||||||
|
t.Fatalf("second close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
+56
-9
@@ -10,6 +10,8 @@ import (
|
|||||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var errMiddlewareBlocked = errors.New("middleware blocked call")
|
||||||
|
|
||||||
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
||||||
// with shared middleware and configuration.
|
// with shared middleware and configuration.
|
||||||
//
|
//
|
||||||
@@ -54,6 +56,12 @@ func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
|||||||
}
|
}
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
if command.exec == nil {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.Warnf("command '%s' has a nil executor; skipping", command.command)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
if _, exists := p.commands[command.command]; exists && p.logger != nil {
|
if _, exists := p.commands[command.command]; exists && p.logger != nil {
|
||||||
p.logger.Warnf("command '%s' already registered in plugin '%s'; overwriting", command.command, p.name)
|
p.logger.Warnf("command '%s' already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||||
}
|
}
|
||||||
@@ -78,6 +86,12 @@ func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
|||||||
}
|
}
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
if command.exec == nil {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.Warnf("payload '%s' has a nil executor; skipping", command.command)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
if _, exists := p.payloads[command.command]; exists && p.logger != nil {
|
if _, exists := p.payloads[command.command]; exists && p.logger != nil {
|
||||||
p.logger.Warnf("payload '%s' is already registered in plugin '%s'; overwriting", command.command, p.name)
|
p.logger.Warnf("payload '%s' is already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||||
}
|
}
|
||||||
@@ -153,6 +167,12 @@ func (p *Plugin[T]) UsePolicy(name string, policy Policy[T]) *Plugin[T] {
|
|||||||
// AddUpdateHandler registers a handler for a non-command update type.
|
// AddUpdateHandler registers a handler for a non-command update type.
|
||||||
// Message, channel post, and callback query updates stay on the command/payload flow.
|
// Message, channel post, and callback query updates stay on the command/payload flow.
|
||||||
func (p *Plugin[T]) AddUpdateHandler(t tgapi.UpdateType, handler CommandExecutor[T]) *Plugin[T] {
|
func (p *Plugin[T]) AddUpdateHandler(t tgapi.UpdateType, handler CommandExecutor[T]) *Plugin[T] {
|
||||||
|
if handler == nil {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.Warnf("update handler '%s' has a nil executor; skipping", t)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
switch t {
|
switch t {
|
||||||
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost, tgapi.UpdateTypeCallbackQuery:
|
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost, tgapi.UpdateTypeCallbackQuery:
|
||||||
if p.logger == nil {
|
if p.logger == nil {
|
||||||
@@ -250,12 +270,12 @@ func (p *Plugin[T]) executeCmd(cmd string, ctx *MessageContext, db T) error {
|
|||||||
// Run command-specific middlewares
|
// Run command-specific middlewares
|
||||||
for _, m := range command.middlewares {
|
for _, m := range command.middlewares {
|
||||||
if !m.Execute(ctx, db) {
|
if !m.Execute(ctx, db) {
|
||||||
return AsInternalError(errors.New("middleware blocked call"))
|
return errMiddlewareBlocked
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Execute command
|
// Execute command
|
||||||
return command.exec(ctx, db)
|
return callCommandExecutor(command.exec, ctx, db)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *Plugin[T]) executePayload(payload string, ctx *MessageContext, db T) error {
|
func (p *Plugin[T]) executePayload(payload string, ctx *MessageContext, db T) error {
|
||||||
@@ -271,12 +291,24 @@ func (p *Plugin[T]) executePayload(payload string, ctx *MessageContext, db T) er
|
|||||||
// Run command-specific middlewares
|
// Run command-specific middlewares
|
||||||
for _, m := range command.middlewares {
|
for _, m := range command.middlewares {
|
||||||
if !m.Execute(ctx, db) {
|
if !m.Execute(ctx, db) {
|
||||||
return AsInternalError(errors.New("middleware blocked call"))
|
return errMiddlewareBlocked
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Execute payload
|
// Execute payload
|
||||||
return command.exec(ctx, db)
|
return callCommandExecutor(command.exec, ctx, db)
|
||||||
|
}
|
||||||
|
|
||||||
|
func callCommandExecutor[T AppData](executor CommandExecutor[T], ctx *MessageContext, db T) (err error) {
|
||||||
|
if executor == nil {
|
||||||
|
return ErrHandlerExecutorNil
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if recovered := recover(); recovered != nil {
|
||||||
|
err = fmt.Errorf("%w: %v", ErrHandlerPanic, recovered)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return executor(ctx, db)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *Plugin[T]) executeMiddlewares(ctx *MessageContext, db T) bool {
|
func (p *Plugin[T]) executeMiddlewares(ctx *MessageContext, db T) bool {
|
||||||
@@ -333,6 +365,7 @@ func (m Middleware[T]) SetAsync(async bool) Middleware[T] {
|
|||||||
// continue to share storage with the synchronous flow. Async middleware
|
// continue to share storage with the synchronous flow. Async middleware
|
||||||
// must treat those fields as read-only — mutating them races the sync chain
|
// must treat those fields as read-only — mutating them races the sync chain
|
||||||
// that mutates the same context concurrently.
|
// that mutates the same context concurrently.
|
||||||
|
// Bot runtimes wait for tracked asynchronous middleware before returning.
|
||||||
func (m Middleware[T]) Execute(ctx *MessageContext, db T) bool {
|
func (m Middleware[T]) Execute(ctx *MessageContext, db T) bool {
|
||||||
if m.executor == nil {
|
if m.executor == nil {
|
||||||
reportMiddlewareError(ctx, m.name, ErrMiddlewareExecutorNil)
|
reportMiddlewareError(ctx, m.name, ErrMiddlewareExecutorNil)
|
||||||
@@ -340,17 +373,31 @@ func (m Middleware[T]) Execute(ctx *MessageContext, db T) bool {
|
|||||||
}
|
}
|
||||||
if m.async {
|
if m.async {
|
||||||
ctxCopy := *ctx
|
ctxCopy := *ctx
|
||||||
go func(ctx MessageContext) {
|
task := func() {
|
||||||
defer func() {
|
defer func() {
|
||||||
if recovered := recover(); recovered != nil {
|
if recovered := recover(); recovered != nil {
|
||||||
reportMiddlewareError(&ctx, m.name, fmt.Errorf("middleware %q panicked: %v", m.name, recovered))
|
reportMiddlewareError(&ctxCopy, m.name, fmt.Errorf("%w in middleware %q: %v", ErrHandlerPanic, m.name, recovered))
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
m.executor(&ctx, db)
|
m.executor(&ctxCopy, db)
|
||||||
}(ctxCopy)
|
}
|
||||||
|
if ctx.asyncTask != nil {
|
||||||
|
ctx.asyncTask(task)
|
||||||
|
} else {
|
||||||
|
go task()
|
||||||
|
}
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
return m.executor(ctx, db)
|
result := false
|
||||||
|
func() {
|
||||||
|
defer func() {
|
||||||
|
if recovered := recover(); recovered != nil {
|
||||||
|
reportMiddlewareError(ctx, m.name, fmt.Errorf("%w in middleware %q: %v", ErrHandlerPanic, m.name, recovered))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
result = m.executor(ctx, db)
|
||||||
|
}()
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
func reportMiddlewareError(ctx *MessageContext, name string, err error) {
|
func reportMiddlewareError(ctx *MessageContext, name string, err error) {
|
||||||
|
|||||||
@@ -41,11 +41,63 @@ func TestAsyncMiddlewareRecoversPanic(t *testing.T) {
|
|||||||
if event.Err == nil {
|
if event.Err == nil {
|
||||||
t.Fatal("panic error was not reported")
|
t.Fatal("panic error was not reported")
|
||||||
}
|
}
|
||||||
|
if !errors.Is(event.Err, ErrHandlerPanic) {
|
||||||
|
t.Fatalf("expected ErrHandlerPanic, got %v", event.Err)
|
||||||
|
}
|
||||||
case <-time.After(time.Second):
|
case <-time.After(time.Second):
|
||||||
t.Fatal("timed out waiting for async middleware error")
|
t.Fatal("timed out waiting for async middleware error")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAsyncMiddlewareUsesContextTaskTracker(t *testing.T) {
|
||||||
|
bot := new(Bot[NoData])
|
||||||
|
started := make(chan struct{})
|
||||||
|
release := make(chan struct{})
|
||||||
|
ctx := &MessageContext{asyncTask: bot.startAsyncTask}
|
||||||
|
middleware := NewMiddleware[NoData]("tracked", func(*MessageContext, NoData) bool {
|
||||||
|
close(started)
|
||||||
|
<-release
|
||||||
|
return true
|
||||||
|
}).SetAsync(true)
|
||||||
|
|
||||||
|
if !middleware.Execute(ctx, NoData{}) {
|
||||||
|
t.Fatal("async middleware blocked execution")
|
||||||
|
}
|
||||||
|
<-started
|
||||||
|
waited := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
bot.middlewareWG.Wait()
|
||||||
|
close(waited)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-waited:
|
||||||
|
t.Fatal("task tracker finished before middleware returned")
|
||||||
|
case <-time.After(20 * time.Millisecond):
|
||||||
|
}
|
||||||
|
close(release)
|
||||||
|
select {
|
||||||
|
case <-waited:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("task tracker did not finish after middleware returned")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSyncMiddlewareRecoversPanic(t *testing.T) {
|
||||||
|
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||||
|
ctx := &MessageContext{observer: observer}
|
||||||
|
middleware := NewMiddleware[NoData]("panic", func(ctx *MessageContext, db NoData) bool {
|
||||||
|
panic("boom")
|
||||||
|
})
|
||||||
|
|
||||||
|
if middleware.Execute(ctx, NoData{}) {
|
||||||
|
t.Fatal("panicking synchronous middleware continued execution")
|
||||||
|
}
|
||||||
|
event := <-observer.errors
|
||||||
|
if !errors.Is(event.Err, ErrHandlerPanic) {
|
||||||
|
t.Fatalf("expected ErrHandlerPanic, got %v", event.Err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestMiddlewareRejectsNilExecutor(t *testing.T) {
|
func TestMiddlewareRejectsNilExecutor(t *testing.T) {
|
||||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||||
ctx := &MessageContext{observer: observer}
|
ctx := &MessageContext{observer: observer}
|
||||||
@@ -171,3 +223,14 @@ func TestPluginCommandGroupRegistersBuiltCommands(t *testing.T) {
|
|||||||
plugin.CommandGroup("ignored", nil)
|
plugin.CommandGroup("ignored", nil)
|
||||||
plugin.AddCommandGroup(nil)
|
plugin.AddCommandGroup(nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPluginSkipsNilHandlers(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("nil")
|
||||||
|
plugin.AddCommand(NewCommand[NoData]("command", nil))
|
||||||
|
plugin.AddPayload(NewCommand[NoData]("payload", nil))
|
||||||
|
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedMessage, nil)
|
||||||
|
|
||||||
|
if len(plugin.commands) != 0 || len(plugin.payloads) != 0 || len(plugin.handlers) != 0 {
|
||||||
|
t.Fatalf("nil handlers were registered: commands=%d payloads=%d updates=%d", len(plugin.commands), len(plugin.payloads), len(plugin.handlers))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -143,7 +143,7 @@ func RequireChatAdmin[T AppData]() Policy[T] {
|
|||||||
return AsInternalError(errors.New("chat-admin policy requires message chat context"))
|
return AsInternalError(errors.New("chat-admin policy requires message chat context"))
|
||||||
}
|
}
|
||||||
|
|
||||||
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||||
ChatID: ctx.ChatID,
|
ChatID: ctx.ChatID,
|
||||||
UserID: ctx.FromID,
|
UserID: ctx.FromID,
|
||||||
})
|
})
|
||||||
@@ -166,7 +166,7 @@ func RequireChatCreator[T AppData]() Policy[T] {
|
|||||||
return AsInternalError(errors.New("chat-creator policy requires message chat context"))
|
return AsInternalError(errors.New("chat-creator policy requires message chat context"))
|
||||||
}
|
}
|
||||||
|
|
||||||
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||||
ChatID: ctx.ChatID,
|
ChatID: ctx.ChatID,
|
||||||
UserID: ctx.FromID,
|
UserID: ctx.FromID,
|
||||||
})
|
})
|
||||||
@@ -192,7 +192,7 @@ func RequireBotAdmin[T AppData]() Policy[T] {
|
|||||||
return AsInternalError(errors.New("bot ID is not set in context"))
|
return AsInternalError(errors.New("bot ID is not set in context"))
|
||||||
}
|
}
|
||||||
|
|
||||||
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||||
ChatID: ctx.ChatID, UserID: ctx.botID,
|
ChatID: ctx.ChatID, UserID: ctx.botID,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -157,6 +157,43 @@ func TestRequireChatAdminUsesNormalizedIDs(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRequireChatAdminUsesMessageContextCancellation(t *testing.T) {
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
if err := req.Context().Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"status":"administrator","user":{"id":55,"is_bot":false,"first_name":"tester"}}}`)),
|
||||||
|
}, nil
|
||||||
|
})}),
|
||||||
|
)
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
requestCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
ctx := &MessageContext{
|
||||||
|
API: api,
|
||||||
|
ChatID: -2001,
|
||||||
|
FromID: 55,
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
ctx: requestCtx,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := RequireChatAdmin[NoData]()(ctx, NoData{})
|
||||||
|
if !errors.Is(err, context.Canceled) || !IsInternalError(err) {
|
||||||
|
t.Fatalf("RequireChatAdmin error = %v, want internal context.Canceled", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestAllPoliciesReturnsFirstError(t *testing.T) {
|
func TestAllPoliciesReturnsFirstError(t *testing.T) {
|
||||||
want := AsUserError(errors.New("blocked"))
|
want := AsUserError(errors.New("blocked"))
|
||||||
policy := AllPolicies(
|
policy := AllPolicies(
|
||||||
|
|||||||
+27
-8
@@ -6,10 +6,17 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RunnerFn is the function type for a runner. It receives a pointer to
|
// RunnerFn is the legacy function type for a runner. It receives a pointer to
|
||||||
// the Bot and returns an error if execution fails.
|
// the Bot and returns an error if execution fails. New blocking or I/O work
|
||||||
|
// should use ContextRunnerFn so runtime cancellation can stop the callback.
|
||||||
|
//
|
||||||
|
// Subject to change in v2: runner callbacks may require context.Context.
|
||||||
type RunnerFn[T AppData] func(*Bot[T]) error
|
type RunnerFn[T AppData] func(*Bot[T]) error
|
||||||
|
|
||||||
|
// ContextRunnerFn is a cancelable runner function.
|
||||||
|
// The runtime context is canceled when polling or webhook execution stops.
|
||||||
|
type ContextRunnerFn[T AppData] func(context.Context, *Bot[T]) error
|
||||||
|
|
||||||
// Runner represents a configurable background or one-time task to be
|
// Runner represents a configurable background or one-time task to be
|
||||||
// executed by a Bot.
|
// executed by a Bot.
|
||||||
//
|
//
|
||||||
@@ -26,14 +33,18 @@ type Runner[T AppData] struct {
|
|||||||
async bool // If true, runs in a goroutine; else, runs synchronously
|
async bool // If true, runs in a goroutine; else, runs synchronously
|
||||||
every time.Duration // Interval between periodic executions; zero means one-shot
|
every time.Duration // Interval between periodic executions; zero means one-shot
|
||||||
fn RunnerFn[T] // The function to execute
|
fn RunnerFn[T] // The function to execute
|
||||||
|
ctxFn ContextRunnerFn[T]
|
||||||
}
|
}
|
||||||
|
|
||||||
func executeRunner[T AppData](runner Runner[T], bot *Bot[T]) (err error) {
|
func executeRunnerWithContext[T AppData](ctx context.Context, runner Runner[T], bot *Bot[T]) (err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if recovered := recover(); recovered != nil {
|
if recovered := recover(); recovered != nil {
|
||||||
err = fmt.Errorf("runner %q panicked: %v", runner.name, recovered)
|
err = fmt.Errorf("runner %q panicked: %v", runner.name, recovered)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
if runner.ctxFn != nil {
|
||||||
|
return runner.ctxFn(ctx, bot)
|
||||||
|
}
|
||||||
if runner.fn == nil {
|
if runner.fn == nil {
|
||||||
return fmt.Errorf("runner %q has no function", runner.name)
|
return fmt.Errorf("runner %q has no function", runner.name)
|
||||||
}
|
}
|
||||||
@@ -46,10 +57,18 @@ func executeRunner[T AppData](runner Runner[T], bot *Bot[T]) (err error) {
|
|||||||
// goroutine that fires once when the bot runtime starts. Use Async and Every
|
// goroutine that fires once when the bot runtime starts. Use Async and Every
|
||||||
// to customize this. Do not call builder methods concurrently or after the
|
// to customize this. Do not call builder methods concurrently or after the
|
||||||
// bot runtime has begun executing runners.
|
// bot runtime has begun executing runners.
|
||||||
|
//
|
||||||
|
// Subject to change in v2: NewContextRunner may become the primary constructor.
|
||||||
func NewRunner[T AppData](name string, fn RunnerFn[T]) Runner[T] {
|
func NewRunner[T AppData](name string, fn RunnerFn[T]) Runner[T] {
|
||||||
return Runner[T]{name: name, fn: fn, async: true, every: 0}
|
return Runner[T]{name: name, fn: fn, async: true, every: 0}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewContextRunner creates a runner whose callback observes runtime cancellation.
|
||||||
|
// It is the preferred constructor for I/O, blocking, and periodic work.
|
||||||
|
func NewContextRunner[T AppData](name string, fn ContextRunnerFn[T]) Runner[T] {
|
||||||
|
return Runner[T]{name: name, ctxFn: fn, async: true, every: 0}
|
||||||
|
}
|
||||||
|
|
||||||
// Async sets whether the runner executes synchronously or asynchronously.
|
// Async sets whether the runner executes synchronously or asynchronously.
|
||||||
// If true, the runner runs in a goroutine (non-blocking).
|
// If true, the runner runs in a goroutine (non-blocking).
|
||||||
// If false, the runner blocks the caller during execution.
|
// If false, the runner blocks the caller during execution.
|
||||||
@@ -74,7 +93,7 @@ func (r Runner[T]) Every(timeout time.Duration) Runner[T] {
|
|||||||
// ExecRunners executes all runners registered on the Bot with context-based lifecycle management.
|
// ExecRunners executes all runners registered on the Bot with context-based lifecycle management.
|
||||||
//
|
//
|
||||||
// Execution semantics by configuration:
|
// Execution semantics by configuration:
|
||||||
// - every=0, async=true: Runs once in a goroutine (fire and forget).
|
// - every=0, async=true: Runs once in a goroutine; runtime shutdown waits for it.
|
||||||
// - every=0, async=false: Runs once synchronously; warns if slower than 2 seconds.
|
// - every=0, async=false: Runs once synchronously; warns if slower than 2 seconds.
|
||||||
// - every>0, async=true: Runs in a loop with the configured interval until ctx.Done().
|
// - every>0, async=true: Runs in a loop with the configured interval until ctx.Done().
|
||||||
// - every>0, async=false: Skipped with a warning (invalid configuration).
|
// - every>0, async=false: Skipped with a warning (invalid configuration).
|
||||||
@@ -92,12 +111,12 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if runner.every == 0 && runner.async {
|
if runner.every == 0 && runner.async {
|
||||||
// One-time async: fire and forget
|
// One-time async: non-blocking startup; runtime shutdown waits for completion.
|
||||||
bot.runnerOnceWG.Add(1)
|
bot.runnerOnceWG.Add(1)
|
||||||
go func(r Runner[T]) {
|
go func(r Runner[T]) {
|
||||||
defer bot.runnerOnceWG.Done()
|
defer bot.runnerOnceWG.Done()
|
||||||
startedAt := time.Now()
|
startedAt := time.Now()
|
||||||
err := executeRunner(r, bot)
|
err := executeRunnerWithContext(ctx, r, bot)
|
||||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
Name: r.name,
|
Name: r.name,
|
||||||
Duration: time.Since(startedAt),
|
Duration: time.Since(startedAt),
|
||||||
@@ -117,7 +136,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
|||||||
} else if runner.every == 0 && !runner.async {
|
} else if runner.every == 0 && !runner.async {
|
||||||
// One-time sync: block until done
|
// One-time sync: block until done
|
||||||
t := time.Now()
|
t := time.Now()
|
||||||
err := executeRunner(runner, bot)
|
err := executeRunnerWithContext(ctx, runner, bot)
|
||||||
elapsed := time.Since(t)
|
elapsed := time.Since(t)
|
||||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
Name: runner.name,
|
Name: runner.name,
|
||||||
@@ -158,7 +177,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
startedAt := time.Now()
|
startedAt := time.Now()
|
||||||
err := executeRunner(r, bot)
|
err := executeRunnerWithContext(ctx, r, bot)
|
||||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
Name: r.name,
|
Name: r.name,
|
||||||
Duration: time.Since(startedAt),
|
Duration: time.Since(startedAt),
|
||||||
|
|||||||
@@ -122,3 +122,34 @@ func TestExecRunnersRecoversRunnerPanic(t *testing.T) {
|
|||||||
t.Fatalf("expected recovered panic in error event, got %#v", observer.errors)
|
t.Fatalf("expected recovered panic in error event, got %#v", observer.errors)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestContextRunnerStopsActiveCallbackOnCancel(t *testing.T) {
|
||||||
|
started := make(chan struct{})
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
runners: []Runner[NoData]{
|
||||||
|
NewContextRunner("cancelable", func(ctx context.Context, _ *Bot[NoData]) error {
|
||||||
|
close(started)
|
||||||
|
<-ctx.Done()
|
||||||
|
close(stopped)
|
||||||
|
return ctx.Err()
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.ExecRunners(ctx)
|
||||||
|
select {
|
||||||
|
case <-started:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("context runner did not start")
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
|
bot.runnerOnceWG.Wait()
|
||||||
|
select {
|
||||||
|
case <-stopped:
|
||||||
|
default:
|
||||||
|
t.Fatal("context runner did not observe cancellation")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package laniakea
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
"maps"
|
"maps"
|
||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
@@ -55,18 +56,27 @@ func (s *Scene[T]) setPluginName(name string) *Scene[T] {
|
|||||||
|
|
||||||
// OnStep registers a handler for a named scene step.
|
// OnStep registers a handler for a named scene step.
|
||||||
func (s *Scene[T]) OnStep(step string, handler SceneHandler[T]) *Scene[T] {
|
func (s *Scene[T]) OnStep(step string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
if handler == nil {
|
||||||
|
return s
|
||||||
|
}
|
||||||
s.steps[step] = handler
|
s.steps[step] = handler
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
|
|
||||||
// OnCommand registers a command handler active while the scene is running.
|
// OnCommand registers a command handler active while the scene is running.
|
||||||
func (s *Scene[T]) OnCommand(cmd string, handler SceneHandler[T]) *Scene[T] {
|
func (s *Scene[T]) OnCommand(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
if handler == nil {
|
||||||
|
return s
|
||||||
|
}
|
||||||
s.commands[cmd] = handler
|
s.commands[cmd] = handler
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
|
|
||||||
// OnPayload registers a callback payload handler active while the scene is running.
|
// OnPayload registers a callback payload handler active while the scene is running.
|
||||||
func (s *Scene[T]) OnPayload(cmd string, handler SceneHandler[T]) *Scene[T] {
|
func (s *Scene[T]) OnPayload(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
if handler == nil {
|
||||||
|
return s
|
||||||
|
}
|
||||||
s.payloads[cmd] = handler
|
s.payloads[cmd] = handler
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
@@ -82,7 +92,7 @@ func (s *Scene[T]) executeCommand(cmd string, ctx *SceneContext, db T) (SceneRes
|
|||||||
if !ok {
|
if !ok {
|
||||||
return SceneResult{}, false, nil
|
return SceneResult{}, false, nil
|
||||||
}
|
}
|
||||||
result, err := handler(ctx, db)
|
result, err := callSceneHandler(handler, ctx, db)
|
||||||
return result, true, err
|
return result, true, err
|
||||||
}
|
}
|
||||||
func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
@@ -90,7 +100,7 @@ func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneRes
|
|||||||
if !ok {
|
if !ok {
|
||||||
return SceneResult{}, false, nil
|
return SceneResult{}, false, nil
|
||||||
}
|
}
|
||||||
result, err := handler(ctx, db)
|
result, err := callSceneHandler(handler, ctx, db)
|
||||||
return result, true, err
|
return result, true, err
|
||||||
}
|
}
|
||||||
func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
@@ -98,17 +108,30 @@ func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResul
|
|||||||
if !ok {
|
if !ok {
|
||||||
return SceneResult{}, false, nil
|
return SceneResult{}, false, nil
|
||||||
}
|
}
|
||||||
result, err := handler(ctx, db)
|
result, err := callSceneHandler(handler, ctx, db)
|
||||||
return result, true, err
|
return result, true, err
|
||||||
}
|
}
|
||||||
func (s *Scene[T]) executeMessage(ctx *SceneContext, db T) (SceneResult, bool, error) {
|
func (s *Scene[T]) executeMessage(ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
if s.message == nil {
|
if s.message == nil {
|
||||||
return SceneResult{}, false, nil
|
return SceneResult{}, false, nil
|
||||||
}
|
}
|
||||||
result, err := s.message(ctx, db)
|
result, err := callSceneHandler(s.message, ctx, db)
|
||||||
return result, true, err
|
return result, true, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func callSceneHandler[T any](handler SceneHandler[T], ctx *SceneContext, db T) (result SceneResult, err error) {
|
||||||
|
if handler == nil {
|
||||||
|
return SceneResult{}, ErrHandlerExecutorNil
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if recovered := recover(); recovered != nil {
|
||||||
|
result = SceneResult{}
|
||||||
|
err = fmt.Errorf("%w: %v", ErrHandlerPanic, recovered)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return handler(ctx, db)
|
||||||
|
}
|
||||||
|
|
||||||
func (s *Scene[T]) clone() *Scene[T] {
|
func (s *Scene[T]) clone() *Scene[T] {
|
||||||
if s == nil {
|
if s == nil {
|
||||||
return nil
|
return nil
|
||||||
@@ -223,7 +246,9 @@ func (s *MemorySessionStore) Delete(key string) error {
|
|||||||
|
|
||||||
// SceneResult describes how scene execution should proceed after a handler returns.
|
// SceneResult describes how scene execution should proceed after a handler returns.
|
||||||
type SceneResult struct {
|
type SceneResult struct {
|
||||||
|
// Action controls the scene state transition.
|
||||||
Action SceneAction
|
Action SceneAction
|
||||||
|
// Next names the destination step for SceneActionNext.
|
||||||
Next string
|
Next string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+37
-20
@@ -1,24 +1,37 @@
|
|||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (bot *Bot[T]) tryHandleScene(ctx *MessageContext) (bool, error) {
|
func (bot *Bot[T]) tryHandleScene(ctx *MessageContext) (bool, error) {
|
||||||
key, session, err := bot.findSceneSession(ctx)
|
for _, scope := range bot.sceneScopePriority {
|
||||||
if err != nil {
|
key, ok := buildSceneKey(scope, ctx)
|
||||||
if errors.Is(err, ErrCantFindSession) {
|
if !ok {
|
||||||
return false, nil
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
unlock := bot.sceneLocks.lock([]string{key})
|
||||||
|
session, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
unlock()
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
if session.Scene == "" {
|
if session.Scene == "" {
|
||||||
return false, nil
|
unlock()
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
handled, err := bot.tryHandleSceneSession(ctx, key, session)
|
||||||
|
unlock()
|
||||||
|
return handled, err
|
||||||
|
}
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) tryHandleSceneSession(ctx *MessageContext, key string, session SceneSession) (bool, error) {
|
||||||
for _, plugin := range bot.plugins {
|
for _, plugin := range bot.plugins {
|
||||||
scene, ok := plugin.scenes[session.Scene]
|
scene, ok := plugin.scenes[session.Scene]
|
||||||
if !ok {
|
if !ok {
|
||||||
@@ -67,14 +80,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
|||||||
res, _, err := scene.executeCommand(cmd, ctx, bot.appData)
|
res, _, err := scene.executeCommand(cmd, ctx, bot.appData)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
return false, bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||||
return false, err
|
|
||||||
}
|
}
|
||||||
from := ctx.sess.Step
|
from := ctx.sess.Step
|
||||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
err = bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||||
}
|
}
|
||||||
if ok {
|
if ok {
|
||||||
bot.emitSceneTransition(ctx, scene, from, res)
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
@@ -101,14 +113,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
|||||||
res, _, err := scene.executePayload(cmd, ctx, bot.appData)
|
res, _, err := scene.executePayload(cmd, ctx, bot.appData)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||||
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
return false, bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||||
return false, err
|
|
||||||
}
|
}
|
||||||
from := ctx.sess.Step
|
from := ctx.sess.Step
|
||||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
err = bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||||
}
|
}
|
||||||
if ok {
|
if ok {
|
||||||
bot.emitSceneTransition(ctx, scene, from, res)
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
@@ -132,14 +143,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
|||||||
res, _, err := scene.executeStep(step, ctx, bot.appData)
|
res, _, err := scene.executeStep(step, ctx, bot.appData)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, err)
|
return false, bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, err)
|
||||||
return false, err
|
|
||||||
}
|
}
|
||||||
from := step
|
from := step
|
||||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
err = bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
||||||
}
|
}
|
||||||
if ok {
|
if ok {
|
||||||
bot.emitSceneTransition(ctx, scene, from, res)
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
@@ -154,14 +164,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
|||||||
res, _, err := scene.executeMessage(ctx, bot.appData)
|
res, _, err := scene.executeMessage(ctx, bot.appData)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
return false, bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||||
return false, err
|
|
||||||
}
|
}
|
||||||
from := ctx.sess.Step
|
from := ctx.sess.Step
|
||||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
err = bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||||
}
|
}
|
||||||
if ok {
|
if ok {
|
||||||
bot.emitSceneTransition(ctx, scene, from, res)
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
@@ -199,7 +208,14 @@ func (bot *Bot[T]) emitSceneFinished(ctx *SceneContext, scene *Scene[T], kind Ha
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, err error) {
|
type reportedSceneError struct {
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *reportedSceneError) Error() string { return e.err.Error() }
|
||||||
|
func (e *reportedSceneError) Unwrap() error { return e.err }
|
||||||
|
|
||||||
|
func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, err error) error {
|
||||||
bot.safeEmitEvent(ctx.Context(), ErrorEvent{
|
bot.safeEmitEvent(ctx.Context(), ErrorEvent{
|
||||||
UpdateID: ctx.Update.UpdateID,
|
UpdateID: ctx.Update.UpdateID,
|
||||||
UpdateType: ctx.Update.Type,
|
UpdateType: ctx.Update.Type,
|
||||||
@@ -211,6 +227,7 @@ func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind Handl
|
|||||||
Err: err,
|
Err: err,
|
||||||
UserFacing: IsUserError(err),
|
UserFacing: IsUserError(err),
|
||||||
})
|
})
|
||||||
|
return &reportedSceneError{err: err}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (bot *Bot[T]) emitSceneTransition(ctx *SceneContext, scene *Scene[T], from string, result SceneResult) {
|
func (bot *Bot[T]) emitSceneTransition(ctx *SceneContext, scene *Scene[T], from string, result SceneResult) {
|
||||||
@@ -266,7 +283,7 @@ func (bot *Bot[T]) applySceneResult(scene *Scene[T], ctx *SceneContext, result S
|
|||||||
case SceneActionPass:
|
case SceneActionPass:
|
||||||
return false, nil
|
return false, nil
|
||||||
default:
|
default:
|
||||||
return false, nil
|
return false, fmt.Errorf("%w: %v", ErrInvalidSceneAction, result.Action)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
func buildSceneKey(scope SceneScope, ctx *MessageContext) (string, bool) {
|
func buildSceneKey(scope SceneScope, ctx *MessageContext) (string, bool) {
|
||||||
|
|||||||
@@ -68,13 +68,3 @@ func uniqueSortedStrings(values []string) []string {
|
|||||||
}
|
}
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
func sceneKeysForContext(ctx *MessageContext) []string {
|
|
||||||
keys := make([]string, 0, 3)
|
|
||||||
for _, scope := range []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser} {
|
|
||||||
if key, ok := buildSceneKey(scope, ctx); ok {
|
|
||||||
keys = append(keys, key)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return keys
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1037,3 +1037,23 @@ func TestSceneStoreErrorsPropagate(t *testing.T) {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestSceneSkipsNilHandlers(t *testing.T) {
|
||||||
|
scene := NewScene[NoData]("nil").
|
||||||
|
OnStep("step", nil).
|
||||||
|
OnCommand("command", nil).
|
||||||
|
OnPayload("payload", nil).
|
||||||
|
OnMessage(nil)
|
||||||
|
|
||||||
|
if len(scene.steps) != 0 || len(scene.commands) != 0 || len(scene.payloads) != 0 || scene.message != nil {
|
||||||
|
t.Fatal("scene registered a nil handler")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplySceneResultRejectsUnknownAction(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{sessionStore: NewMemorySessionStore()}
|
||||||
|
_, err := bot.applySceneResult(NewScene[NoData]("scene"), &SceneContext{}, SceneResult{Action: SceneAction(255)})
|
||||||
|
if !errors.Is(err, ErrInvalidSceneAction) {
|
||||||
|
t.Fatalf("expected ErrInvalidSceneAction, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+55
-4
@@ -13,6 +13,12 @@ import (
|
|||||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
defaultMaxRetries = 3
|
||||||
|
maximumResponseSize = 10 << 20
|
||||||
|
minimumRetryDelay = 100 * time.Millisecond
|
||||||
|
)
|
||||||
|
|
||||||
// APIOpts holds configuration options for initializing the Telegram API client.
|
// APIOpts holds configuration options for initializing the Telegram API client.
|
||||||
// Use the provided setter methods to build options — do not construct directly.
|
// Use the provided setter methods to build options — do not construct directly.
|
||||||
type APIOpts struct {
|
type APIOpts struct {
|
||||||
@@ -26,6 +32,7 @@ type APIOpts struct {
|
|||||||
|
|
||||||
limiter *utils.RateLimiter
|
limiter *utils.RateLimiter
|
||||||
dropOverflowLimit bool
|
dropOverflowLimit bool
|
||||||
|
maxRetries int
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewAPIOpts creates a new APIOpts with default values.
|
// NewAPIOpts creates a new APIOpts with default values.
|
||||||
@@ -36,6 +43,7 @@ func NewAPIOpts(token string) *APIOpts {
|
|||||||
client: nil,
|
client: nil,
|
||||||
useTestServer: false,
|
useTestServer: false,
|
||||||
apiURL: "https://api.telegram.org",
|
apiURL: "https://api.telegram.org",
|
||||||
|
maxRetries: defaultMaxRetries,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,6 +99,16 @@ func (opts *APIOpts) SetDropRateLimitOverflow(b bool) *APIOpts {
|
|||||||
return opts
|
return opts
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetMaxRetries sets the maximum number of retries after Telegram returns 429.
|
||||||
|
// A non-positive value disables automatic retries. The default is 3.
|
||||||
|
func (opts *APIOpts) SetMaxRetries(maxRetries int) *APIOpts {
|
||||||
|
if maxRetries < 0 {
|
||||||
|
maxRetries = 0
|
||||||
|
}
|
||||||
|
opts.maxRetries = maxRetries
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
// API is the main Telegram Bot API client for JSON requests.
|
// API is the main Telegram Bot API client for JSON requests.
|
||||||
//
|
//
|
||||||
// Use API methods when sending JSON payloads (for example with file_id, URL, or other
|
// Use API methods when sending JSON payloads (for example with file_id, URL, or other
|
||||||
@@ -108,8 +126,10 @@ type API struct {
|
|||||||
logFormatter *sneklog.Formatter
|
logFormatter *sneklog.Formatter
|
||||||
|
|
||||||
pool *workerPool
|
pool *workerPool
|
||||||
|
// Limiter is the optional rate limiter applied before requests are sent.
|
||||||
Limiter *utils.RateLimiter
|
Limiter *utils.RateLimiter
|
||||||
dropOverflowLimit bool
|
dropOverflowLimit bool
|
||||||
|
maxRetries int
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewAPI creates a new API client from options.
|
// NewAPI creates a new API client from options.
|
||||||
@@ -145,6 +165,7 @@ func NewAPI(opts *APIOpts) *API {
|
|||||||
pool: pool,
|
pool: pool,
|
||||||
Limiter: opts.limiter,
|
Limiter: opts.limiter,
|
||||||
dropOverflowLimit: opts.dropOverflowLimit,
|
dropOverflowLimit: opts.dropOverflowLimit,
|
||||||
|
maxRetries: opts.maxRetries,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -167,17 +188,28 @@ func (api *API) GetLogger() *sneklog.Logger {
|
|||||||
|
|
||||||
// ResponseParameters contains Telegram API response metadata (e.g., retry_after, migrate_to_chat_id).
|
// ResponseParameters contains Telegram API response metadata (e.g., retry_after, migrate_to_chat_id).
|
||||||
type ResponseParameters struct {
|
type ResponseParameters struct {
|
||||||
|
// MigrateToChatID Optional. The group has been migrated to a supergroup with the specified identifier. This
|
||||||
|
// number may have more than 32 significant bits and some programming languages may have difficulty/silent
|
||||||
|
// defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or
|
||||||
|
// double-precision float type are safe for storing this identifier.
|
||||||
MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
|
MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
|
||||||
|
// RetryAfter Optional. In case of exceeding flood control, the number of seconds left to wait before the
|
||||||
|
// request can be repeated
|
||||||
RetryAfter *int `json:"retry_after,omitempty"`
|
RetryAfter *int `json:"retry_after,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// TelegramResponse is the standard Telegram Bot API response structure.
|
// TelegramResponse is the standard Telegram Bot API response structure.
|
||||||
// Generic over Result type R.
|
// Generic over Result type R.
|
||||||
type TelegramResponse[R any] struct {
|
type TelegramResponse[R any] struct {
|
||||||
|
// Ok reports whether the request succeeded.
|
||||||
Ok bool `json:"ok"`
|
Ok bool `json:"ok"`
|
||||||
|
// Description contains a human-readable result description when supplied by Telegram.
|
||||||
Description string `json:"description,omitempty"`
|
Description string `json:"description,omitempty"`
|
||||||
|
// Result contains the method-specific result for a successful response.
|
||||||
Result R `json:"result,omitempty"`
|
Result R `json:"result,omitempty"`
|
||||||
|
// ErrorCode is the Telegram API error code for an unsuccessful response.
|
||||||
ErrorCode int `json:"error_code,omitempty"`
|
ErrorCode int `json:"error_code,omitempty"`
|
||||||
|
// Parameters contains additional recovery metadata for an unsuccessful response.
|
||||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -225,6 +257,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
|||||||
req.Header.Set("Accept", "application/json")
|
req.Header.Set("Accept", "application/json")
|
||||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||||
|
|
||||||
|
retries := 0
|
||||||
for {
|
for {
|
||||||
// Apply rate limiting before making the request
|
// Apply rate limiting before making the request
|
||||||
if api.Limiter != nil {
|
if api.Limiter != nil {
|
||||||
@@ -239,7 +272,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
|||||||
api.logger.Debugln("REQ", url, redactRequestLog(reqData))
|
api.logger.Debugln("REQ", url, redactRequestLog(reqData))
|
||||||
resp, err := api.client.Do(req)
|
resp, err := api.client.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
return zero, fmt.Errorf("HTTP request failed: %w", redactHTTPError(err, api.token))
|
||||||
}
|
}
|
||||||
|
|
||||||
respData, err := readBody(resp.Body)
|
respData, err := readBody(resp.Body)
|
||||||
@@ -279,12 +312,16 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
|||||||
if r.method == "getUpdates" {
|
if r.method == "getUpdates" {
|
||||||
return zero, responseErr
|
return zero, responseErr
|
||||||
}
|
}
|
||||||
|
if retries >= api.maxRetries {
|
||||||
|
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||||
|
}
|
||||||
|
retries++
|
||||||
|
|
||||||
// Wait and retry
|
// Wait and retry
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return zero, ctx.Err()
|
return zero, ctx.Err()
|
||||||
case <-time.After(time.Duration(after) * time.Second):
|
case <-time.After(retryDelay(after)):
|
||||||
continue // retry request
|
continue // retry request
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -330,8 +367,22 @@ func (r TelegramRequest[R, P]) Do(api *API) (R, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func readBody(body io.ReadCloser) ([]byte, error) {
|
func readBody(body io.ReadCloser) ([]byte, error) {
|
||||||
reader := io.LimitReader(body, 10<<20) // 10 MB
|
data, err := io.ReadAll(io.LimitReader(body, maximumResponseSize+1))
|
||||||
return io.ReadAll(reader)
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if len(data) > maximumResponseSize {
|
||||||
|
return nil, ErrResponseTooLarge
|
||||||
|
}
|
||||||
|
return data, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func retryDelay(retryAfter int) time.Duration {
|
||||||
|
delay := time.Duration(retryAfter) * time.Second
|
||||||
|
if delay < minimumRetryDelay {
|
||||||
|
return minimumRetryDelay
|
||||||
|
}
|
||||||
|
return delay
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseBody[R any](data []byte) (TelegramResponse[R], error) {
|
func parseBody[R any](data []byte) (TelegramResponse[R], error) {
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package tgapi
|
package tgapi
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -88,3 +89,42 @@ func TestAPICloseClosesIdleConnections(t *testing.T) {
|
|||||||
t.Fatal("expected Close to close idle HTTP connections")
|
t.Fatal("expected Close to close idle HTTP connections")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestAPIStopsAfterConfiguredRetryLimit(t *testing.T) {
|
||||||
|
calls := 0
|
||||||
|
client := &http.Client{Transport: roundTripFunc(func(_ *http.Request) (*http.Response, error) {
|
||||||
|
calls++
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader(
|
||||||
|
`{"ok":false,"error_code":429,"description":"retry","parameters":{"retry_after":0}}`,
|
||||||
|
)),
|
||||||
|
}, nil
|
||||||
|
})}
|
||||||
|
|
||||||
|
api := NewAPI(NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client).
|
||||||
|
SetMaxRetries(2))
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
|
||||||
|
_, err := api.GetMe()
|
||||||
|
if !errors.Is(err, ErrRetryLimit) {
|
||||||
|
t.Fatalf("expected ErrRetryLimit, got %v", err)
|
||||||
|
}
|
||||||
|
var responseErr *ResponseError
|
||||||
|
if !errors.As(err, &responseErr) || responseErr.Code != http.StatusTooManyRequests {
|
||||||
|
t.Fatalf("expected wrapped 429 ResponseError, got %v", err)
|
||||||
|
}
|
||||||
|
if calls != 3 {
|
||||||
|
t.Fatalf("request count = %d, want 3", calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadBodyRejectsOversizedResponse(t *testing.T) {
|
||||||
|
body := io.NopCloser(io.LimitReader(strings.NewReader(strings.Repeat("x", maximumResponseSize+1)), maximumResponseSize+1))
|
||||||
|
_, err := readBody(body)
|
||||||
|
if !errors.Is(err, ErrResponseTooLarge) {
|
||||||
|
t.Fatalf("expected ErrResponseTooLarge, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,29 +6,64 @@ import "context"
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendphoto
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
type SendPhoto struct {
|
type SendPhoto struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Photo Required. Photo to send. Pass a file_id as String to send a photo that exists on the Telegram
|
||||||
|
// servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or
|
||||||
|
// upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width
|
||||||
|
// and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on
|
||||||
|
// Sending Files »
|
||||||
Photo string `json:"photo"`
|
Photo string `json:"photo"`
|
||||||
|
// Caption Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the photo caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the photo needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotifications Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotifications bool `json:"disable_notification,omitempty"`
|
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -53,31 +88,70 @@ func (api *API) SendPhotoWithContext(ctx context.Context, params SendPhoto) (Mes
|
|||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
// See https://core.telegram.org/bots/api#sendaudio
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
type SendAudio struct {
|
type SendAudio struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Audio Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the
|
||||||
|
// Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the
|
||||||
|
// Internet, or upload a new one using multipart/form-data. More information on Sending Files »
|
||||||
Audio string `json:"audio"`
|
Audio string `json:"audio"`
|
||||||
|
// Caption Optional. Audio caption, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the audio caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// Duration Optional. Duration of the audio in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Performer Optional. Performer
|
||||||
Performer string `json:"performer,omitempty"`
|
Performer string `json:"performer,omitempty"`
|
||||||
|
// Title Optional. Track name
|
||||||
Title string `json:"title,omitempty"`
|
Title string `json:"title,omitempty"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||||
|
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||||
|
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||||
|
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||||
|
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
Thumbnail string `json:"thumbnail,omitempty"`
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -102,29 +176,68 @@ func (api *API) SendAudioWithContext(ctx context.Context, params SendAudio) (Mes
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#senddocument
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
type SendDocument struct {
|
type SendDocument struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Document Required. File to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||||
|
// servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or
|
||||||
|
// upload a new one using multipart/form-data. More information on Sending Files »
|
||||||
Document string `json:"document"`
|
Document string `json:"document"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||||
|
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||||
|
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||||
|
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||||
|
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
Thumbnail string `json:"thumbnail,omitempty"`
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
// Caption Optional. Document caption (may also be used when resending documents by file_id), 0-1024
|
||||||
|
// characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the document caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// DisableContentTypeDetection Optional. Disables automatic server-side content type detection for files
|
||||||
|
// uploaded using multipart/form-data
|
||||||
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -149,37 +262,85 @@ func (api *API) SendDocumentWithContext(ctx context.Context, params SendDocument
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendvideo
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
type SendVideo struct {
|
type SendVideo struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Video Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram
|
||||||
|
// servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or
|
||||||
|
// upload a new video using multipart/form-data. More information on Sending Files »
|
||||||
Video string `json:"video"`
|
Video string `json:"video"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||||
|
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||||
|
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||||
|
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||||
|
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
Thumbnail string `json:"thumbnail,omitempty"`
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
// Duration Optional. Duration of sent video in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Width Optional. Video width
|
||||||
Width int `json:"width,omitempty"`
|
Width int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Video height
|
||||||
Height int `json:"height,omitempty"`
|
Height int `json:"height,omitempty"`
|
||||||
|
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||||
|
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||||
|
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||||
|
// name. More information on Sending Files »
|
||||||
Cover string `json:"cover,omitempty"`
|
Cover string `json:"cover,omitempty"`
|
||||||
|
|
||||||
|
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||||
StartTimestamp int `json:"start_timestamp,omitempty"`
|
StartTimestamp int `json:"start_timestamp,omitempty"`
|
||||||
|
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||||
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -204,33 +365,75 @@ func (api *API) SendVideoWithContext(ctx context.Context, params SendVideo) (Mes
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#sendanimation
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
type SendAnimation struct {
|
type SendAnimation struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Animation Required. Animation to send. Pass a file_id as String to send an animation that exists on the
|
||||||
|
// Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the
|
||||||
|
// Internet, or upload a new animation using multipart/form-data. More information on Sending Files »
|
||||||
Animation string `json:"animation"`
|
Animation string `json:"animation"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||||
|
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||||
|
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||||
|
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||||
|
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
Thumbnail string `json:"thumbnail,omitempty"`
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
// Duration Optional. Duration of sent animation in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Width Optional. Animation width
|
||||||
Width int `json:"width,omitempty"`
|
Width int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Animation height
|
||||||
Height int `json:"height,omitempty"`
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
// Caption Optional. Animation caption (may also be used when resending animation by file_id), 0-1024
|
||||||
|
// characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the animation caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the animation needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -255,27 +458,58 @@ func (api *API) SendAnimationWithContext(ctx context.Context, params SendAnimati
|
|||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
// See https://core.telegram.org/bots/api#sendvoice
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
type SendVoice struct {
|
type SendVoice struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Voice Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||||
|
// servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or
|
||||||
|
// upload a new one using multipart/form-data. More information on Sending Files »
|
||||||
Voice string `json:"voice"`
|
Voice string `json:"voice"`
|
||||||
|
// Caption Optional. Voice message caption, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the voice message caption. See formatting options for
|
||||||
|
// more details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// Duration Optional. Duration of the voice message in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -300,26 +534,59 @@ func (api *API) SendVoiceWithContext(ctx context.Context, params SendVoice) (Mes
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#sendvideonote
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
type SendVideoNote struct {
|
type SendVideoNote struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// VideoNote Required. Video note to send. Pass a file_id as String to send a video note that exists on the
|
||||||
|
// Telegram servers (recommended) or upload a new video using multipart/form-data. More information on
|
||||||
|
// Sending Files ». Sending video notes by a URL is currently unsupported.
|
||||||
VideoNote string `json:"video_note"`
|
VideoNote string `json:"video_note"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||||
|
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||||
|
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||||
|
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||||
|
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
Thumbnail string `json:"thumbnail,omitempty"`
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
// Duration Optional. Duration of sent video in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Length Optional. Video width and height, i.e. diameter of the video message
|
||||||
Length int `json:"length,omitempty"`
|
Length int `json:"length,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -344,24 +611,55 @@ func (api *API) SendVideoNoteWithContext(ctx context.Context, params SendVideoNo
|
|||||||
// Since: Bot API 7.6
|
// Since: Bot API 7.6
|
||||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||||
type SendPaidMedia struct {
|
type SendPaidMedia struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media
|
||||||
|
// will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
// StarCount Required. The number of Telegram Stars that must be paid to buy access to the media; 1-25000
|
||||||
StarCount int `json:"star_count,omitempty"`
|
StarCount int `json:"star_count,omitempty"`
|
||||||
|
|
||||||
|
// Media Required. A JSON-serialized Array describing the media to be sent; up to 10 items
|
||||||
Media []InputPaidMedia `json:"media"`
|
Media []InputPaidMedia `json:"media"`
|
||||||
|
// Payload Optional. Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user,
|
||||||
|
// use it for your internal processes.
|
||||||
Payload string `json:"payload,omitempty"`
|
Payload string `json:"payload,omitempty"`
|
||||||
|
// Caption Optional. Media caption, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the media caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -386,16 +684,33 @@ func (api *API) SendPaidMediaWithContext(ctx context.Context, params SendPaidMed
|
|||||||
// Since: Bot API 3.5
|
// Since: Bot API 3.5
|
||||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||||
type SendMediaGroup struct {
|
type SendMediaGroup struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the messages will be
|
||||||
|
// sent; required if the messages are sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// Media Required. A JSON-serialized Array describing messages to be sent, must include 2-10 items
|
||||||
Media []InputMedia `json:"media"`
|
Media []InputMedia `json:"media"`
|
||||||
|
// DisableNotification Optional. Sends messages silently. Users will receive a notification with no sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent messages from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -420,31 +735,65 @@ func (api *API) SendMediaGroupWithContext(ctx context.Context, params SendMediaG
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||||
type SendLivePhoto struct {
|
type SendLivePhoto struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel (in the format
|
||||||
|
// @channelusername)
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
// LivePhoto Required. Live photo video to send. The video must be no longer than 10 seconds and must not
|
||||||
|
// exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers
|
||||||
|
// (recommended) or upload a new video using multipart/form-data. More information on Sending Files ».
|
||||||
|
// Sending live photos by a URL is currently unsupported.
|
||||||
LivePhoto string `json:"live_photo"`
|
LivePhoto string `json:"live_photo"`
|
||||||
// Photo contains or identifies the associated photo.
|
// Photo contains or identifies the associated photo.
|
||||||
Photo string `json:"photo"`
|
Photo string `json:"photo"`
|
||||||
|
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+295
-4
@@ -3,15 +3,27 @@ package tgapi
|
|||||||
// Animation represents an animation file (GIF or H.264/MPEG-4 AVC without sound).
|
// Animation represents an animation file (GIF or H.264/MPEG-4 AVC without sound).
|
||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
type Animation struct {
|
type Animation struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Video width as defined by the sender
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Video height as defined by the sender
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
// Duration Duration of the video in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
// Thumbnail Optional. Animation thumbnail as defined by the sender
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
// FileName Optional. Original animation filename as defined by the sender
|
||||||
FileName string `json:"file_name"`
|
FileName string `json:"file_name"`
|
||||||
|
// MimeType Optional. MIME type of the file as defined by the sender
|
||||||
MimeType string `json:"mime_type"`
|
MimeType string `json:"mime_type"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int `json:"file_size"`
|
FileSize int `json:"file_size"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -19,51 +31,89 @@ type Animation struct {
|
|||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
// See https://core.telegram.org/bots/api#audio
|
// See https://core.telegram.org/bots/api#audio
|
||||||
type Audio struct {
|
type Audio struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Duration Duration of the audio in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
// Performer Optional. Performer of the audio as defined by the sender or by audio tags
|
||||||
Performer string `json:"performer,omitempty"`
|
Performer string `json:"performer,omitempty"`
|
||||||
|
// Title Optional. Title of the audio as defined by the sender or by audio tags
|
||||||
Title string `json:"title,omitempty"`
|
Title string `json:"title,omitempty"`
|
||||||
|
// FileName Optional. Original filename as defined by the sender
|
||||||
FileName string `json:"file_name,omitempty"` // Since: Bot API 5.0
|
FileName string `json:"file_name,omitempty"` // Since: Bot API 5.0
|
||||||
|
// MimeType Optional. MIME type of the file as defined by the sender
|
||||||
MimeType string `json:"mime_type,omitempty"`
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
// Thumbnail Optional. Thumbnail of the album cover to which the music file belongs
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Document represents a general file (as opposed to photos, voice messages and audio files).
|
// Document represents a general file (as opposed to photos, voice messages and audio files).
|
||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
type Document struct {
|
type Document struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Thumbnail Optional. Document thumbnail as defined by the sender
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
// FileName Optional. Original filename as defined by the sender
|
||||||
FileName string `json:"file_name"`
|
FileName string `json:"file_name"`
|
||||||
|
// MimeType Optional. MIME type of the file as defined by the sender
|
||||||
MimeType string `json:"mime_type"`
|
MimeType string `json:"mime_type"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int `json:"file_size,omitempty"`
|
FileSize int `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Story represents a story.
|
// Story represents a story.
|
||||||
// Since: Bot API 6.8
|
// Since: Bot API 6.8
|
||||||
type Story struct {
|
type Story struct {
|
||||||
|
// Chat Chat that posted the story
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// ID Unique identifier for the story in the chat
|
||||||
ID int `json:"id"`
|
ID int `json:"id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Video represents a video file.
|
// Video represents a video file.
|
||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
type Video struct {
|
type Video struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Video width as defined by the sender
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Video height as defined by the sender
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
// Duration Duration of the video in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
// Thumbnail Optional. Video thumbnail
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
// Cover Optional. Available sizes of the cover of the video in the message
|
||||||
Cover []PhotoSize `json:"cover,omitempty"` // Since: Bot API 8.3
|
Cover []PhotoSize `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||||
|
// StartTimestamp Optional. Timestamp in seconds from which the video will play in the message
|
||||||
StartTimestamp int64 `json:"start_timestamp"` // Since: Bot API 8.3
|
StartTimestamp int64 `json:"start_timestamp"` // Since: Bot API 8.3
|
||||||
|
// Qualities Optional. List of available qualities of the video
|
||||||
Qualities []VideoQuality `json:"qualities,omitempty"` // Since: Bot API 9.4
|
Qualities []VideoQuality `json:"qualities,omitempty"` // Since: Bot API 9.4
|
||||||
|
// FileName Optional. Original filename as defined by the sender
|
||||||
FileName string `json:"file_name,omitempty"`
|
FileName string `json:"file_name,omitempty"`
|
||||||
|
// MimeType Optional. MIME type of the file as defined by the sender
|
||||||
MimeType string `json:"mime_type,omitempty"`
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -71,39 +121,65 @@ type Video struct {
|
|||||||
// Since: Bot API 9.4
|
// Since: Bot API 9.4
|
||||||
// See https://core.telegram.org/bots/api#videoquality
|
// See https://core.telegram.org/bots/api#videoquality
|
||||||
type VideoQuality struct {
|
type VideoQuality struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Video width
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Video height
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
// Codec Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”
|
||||||
Codec string `json:"codec"`
|
Codec string `json:"codec"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// VideoNote represents a video message.
|
// VideoNote represents a video message.
|
||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
type VideoNote struct {
|
type VideoNote struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Length Video width and height (diameter of the video message) as defined by the sender
|
||||||
Length int `json:"length"`
|
Length int `json:"length"`
|
||||||
|
// Duration Duration of the video in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
// Thumbnail Optional. Video thumbnail
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
// FileSize Optional. File size in bytes
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Voice represents a voice note.
|
// Voice represents a voice note.
|
||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
type Voice struct {
|
type Voice struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Duration Duration of the audio in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
// MimeType Optional. MIME type of the file as defined by the sender
|
||||||
MimeType string `json:"mime_type,omitempty"`
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int `json:"file_size,omitempty"`
|
FileSize int `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// PaidMediaInfo describes paid media.
|
// PaidMediaInfo describes paid media.
|
||||||
// Since: Bot API 7.6
|
// Since: Bot API 7.6
|
||||||
type PaidMediaInfo struct {
|
type PaidMediaInfo struct {
|
||||||
|
// StarCount The number of Telegram Stars that must be paid to buy access to the media
|
||||||
StarCount int `json:"star_count"`
|
StarCount int `json:"star_count"`
|
||||||
|
// PaidMedia Information about the paid media
|
||||||
PaidMedia []PaidMedia `json:"paid_media"`
|
PaidMedia []PaidMedia `json:"paid_media"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -125,32 +201,50 @@ const (
|
|||||||
// PaidMedia describes paid media content.
|
// PaidMedia describes paid media content.
|
||||||
// Since: Bot API 7.6
|
// Since: Bot API 7.6
|
||||||
type PaidMedia struct {
|
type PaidMedia struct {
|
||||||
|
// Type identifies the preview, photo, video, or live-photo variant.
|
||||||
Type PaidMediaType `json:"type,omitempty"`
|
Type PaidMediaType `json:"type,omitempty"`
|
||||||
|
|
||||||
|
// Width Optional. Media width as defined by the sender
|
||||||
Width int `json:"width,omitempty"`
|
Width int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Media height as defined by the sender
|
||||||
Height int `json:"height,omitempty"`
|
Height int `json:"height,omitempty"`
|
||||||
|
// Duration Optional. Duration of the media in seconds as defined by the sender
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
|
||||||
|
// Photo The photo
|
||||||
Photo []PhotoSize `json:"photo,omitempty"`
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
|
||||||
|
// Video The video
|
||||||
Video *Video `json:"video,omitempty"`
|
Video *Video `json:"video,omitempty"`
|
||||||
|
// LivePhoto The photo
|
||||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"` // Since: Bot API 10.0
|
LivePhoto *LivePhoto `json:"live_photo,omitempty"` // Since: Bot API 10.0
|
||||||
}
|
}
|
||||||
|
|
||||||
// Contact represents a phone contact.
|
// Contact represents a phone contact.
|
||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
type Contact struct {
|
type Contact struct {
|
||||||
|
// PhoneNumber Contact's phone number
|
||||||
PhoneNumber string `json:"phone_number"`
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
// FirstName Contact's first name
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
|
// LastName Optional. Contact's last name
|
||||||
LastName string `json:"last_name,omitempty"`
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
// UserID Optional. Contact's user identifier in Telegram. This number may have more than 32 significant
|
||||||
|
// bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at
|
||||||
|
// most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this
|
||||||
|
// identifier.
|
||||||
UserID int64 `json:"user_id,omitempty"`
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
// Vcard Optional. Additional data about the contact in the form of a vCard
|
||||||
Vcard string `json:"vcard,omitempty"`
|
Vcard string `json:"vcard,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Dice represents an animated emoji with a random value.
|
// Dice represents an animated emoji with a random value.
|
||||||
// Since: Bot API 4.7
|
// Since: Bot API 4.7
|
||||||
type Dice struct {
|
type Dice struct {
|
||||||
|
// Emoji Emoji on which the dice throw animation is based
|
||||||
Emoji string `json:"emoji"`
|
Emoji string `json:"emoji"`
|
||||||
|
// Value Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base
|
||||||
|
// emoji, 1-64 for “” base emoji
|
||||||
Value int `json:"value"`
|
Value int `json:"value"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,14 +252,26 @@ type Dice struct {
|
|||||||
// Since: Bot API 4.2
|
// Since: Bot API 4.2
|
||||||
// See https://core.telegram.org/bots/api#polloption
|
// See https://core.telegram.org/bots/api#polloption
|
||||||
type PollOption struct {
|
type PollOption struct {
|
||||||
|
// PersistentID Unique identifier of the option, persistent on option addition and deletion
|
||||||
PersistentID string `json:"persistent_id"` // Since: Bot API 9.6
|
PersistentID string `json:"persistent_id"` // Since: Bot API 9.6
|
||||||
|
// Text Option text, 1-100 characters
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// TextEntities Optional. Special entities that appear in the option text. Currently, only custom emoji
|
||||||
|
// entities are allowed in poll option texts
|
||||||
TextEntities []MessageEntity `json:"text_entities"`
|
TextEntities []MessageEntity `json:"text_entities"`
|
||||||
|
// Media Optional. Media added to the poll option
|
||||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||||
|
// VoterCount Number of users who voted for this option; may be 0 if unknown
|
||||||
VoterCount int `json:"voter_count"`
|
VoterCount int `json:"voter_count"`
|
||||||
|
|
||||||
|
// AddedByUser Optional. User who added the option; omitted if the option wasn't added by a user after poll
|
||||||
|
// creation
|
||||||
AddedByUser *User `json:"added_by_user,omitempty"` // Since: Bot API 9.6
|
AddedByUser *User `json:"added_by_user,omitempty"` // Since: Bot API 9.6
|
||||||
|
// AddedByChat Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll
|
||||||
|
// creation
|
||||||
AddedByChat *Chat `json:"added_by_chat,omitempty"` // Since: Bot API 9.6
|
AddedByChat *Chat `json:"added_by_chat,omitempty"` // Since: Bot API 9.6
|
||||||
|
// AdditionDate Optional. Point in time (Unix timestamp) when the option was added; omitted if the option
|
||||||
|
// existed in the original poll
|
||||||
AdditionDate int `json:"addition_date,omitempty"` // Since: Bot API 9.6
|
AdditionDate int `json:"addition_date,omitempty"` // Since: Bot API 9.6
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -174,7 +280,9 @@ type PollOption struct {
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#inputpolloptionmedia
|
// See https://core.telegram.org/bots/api#inputpolloptionmedia
|
||||||
type InputPollOptionMedia struct {
|
type InputPollOptionMedia struct {
|
||||||
|
// Type identifies the poll-option media variant.
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
// Media is the file_id or URL of the option media for non-link variants.
|
||||||
Media string `json:"media,omitempty"`
|
Media string `json:"media,omitempty"`
|
||||||
// URL contains the HTTP URL.
|
// URL contains the HTTP URL.
|
||||||
URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link"
|
URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link"
|
||||||
@@ -184,9 +292,15 @@ type InputPollOptionMedia struct {
|
|||||||
// Since: Bot API 7.3
|
// Since: Bot API 7.3
|
||||||
// See https://core.telegram.org/bots/api#inputpolloption
|
// See https://core.telegram.org/bots/api#inputpolloption
|
||||||
type InputPollOption struct {
|
type InputPollOption struct {
|
||||||
|
// Text Option text, 1-100 characters
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||||
|
// Currently, only custom emoji entities are allowed.
|
||||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
// TextEntities Optional. A JSON-serialized list of special entities that appear in the poll option text. It
|
||||||
|
// can be specified instead of text_parse_mode.
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
// Media Optional. Media added to the poll option
|
||||||
Media *InputPollOptionMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
Media *InputPollOptionMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -194,25 +308,38 @@ type InputPollOption struct {
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#inputpollmedia
|
// See https://core.telegram.org/bots/api#inputpollmedia
|
||||||
type InputPollMedia struct {
|
type InputPollMedia struct {
|
||||||
|
// Type identifies the poll-media variant.
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
// Media is the file_id or URL of the poll media.
|
||||||
Media string `json:"media"`
|
Media string `json:"media"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// PollOptionAdded describes a service message about a poll option being added.
|
// PollOptionAdded describes a service message about a poll option being added.
|
||||||
// Since: Bot API 9.6
|
// Since: Bot API 9.6
|
||||||
type PollOptionAdded struct {
|
type PollOptionAdded struct {
|
||||||
|
// PollMessage Optional. Message containing the poll to which the option was added, if known. Note that the
|
||||||
|
// Message object in this field will not contain the reply_to_message field even if it itself is a reply.
|
||||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||||
|
// OptionPersistentID Unique identifier of the added option
|
||||||
OptionPersistentID string `json:"option_persistent_id"`
|
OptionPersistentID string `json:"option_persistent_id"`
|
||||||
|
// OptionText Option text
|
||||||
OptionText string `json:"option_text"`
|
OptionText string `json:"option_text"`
|
||||||
|
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// PollOptionDeleted describes a service message about a poll option being deleted.
|
// PollOptionDeleted describes a service message about a poll option being deleted.
|
||||||
// Since: Bot API 9.6
|
// Since: Bot API 9.6
|
||||||
type PollOptionDeleted struct {
|
type PollOptionDeleted struct {
|
||||||
|
// PollMessage Optional. Message containing the poll from which the option was deleted, if known. Note that
|
||||||
|
// the Message object in this field will not contain the reply_to_message field even if it itself is a
|
||||||
|
// reply.
|
||||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||||
|
// OptionPersistentID Unique identifier of the deleted option
|
||||||
OptionPersistentID string `json:"option_persistent_id"`
|
OptionPersistentID string `json:"option_persistent_id"`
|
||||||
|
// OptionText Option text
|
||||||
OptionText string `json:"option_text"`
|
OptionText string `json:"option_text"`
|
||||||
|
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -226,42 +353,101 @@ const (
|
|||||||
PollTypeQuiz PollType = "quiz"
|
PollTypeQuiz PollType = "quiz"
|
||||||
)
|
)
|
||||||
|
|
||||||
// PollAnswer represents an answer of a user in a poll.
|
// PollAnswer represents an answer submitted by a poll voter.
|
||||||
|
//
|
||||||
|
// User and VoterChat remain value fields for v1 compatibility. Their pointer
|
||||||
|
// representation is subject to change in v2; use VoterUser and VoterChatInfo
|
||||||
|
// when presence matters.
|
||||||
// Since: Bot API 4.6
|
// Since: Bot API 4.6
|
||||||
// See https://core.telegram.org/bots/api#pollanswer
|
// See https://core.telegram.org/bots/api#pollanswer
|
||||||
type PollAnswer struct {
|
type PollAnswer struct {
|
||||||
|
// PollID identifies the poll.
|
||||||
PollID string `json:"poll_id"`
|
PollID string `json:"poll_id"`
|
||||||
|
// VoterChat is the chat that changed the answer, when the voter is anonymous.
|
||||||
VoterChat Chat `json:"voter_chat,omitempty"` // Since: Bot API 6.8
|
VoterChat Chat `json:"voter_chat,omitempty"` // Since: Bot API 6.8
|
||||||
User User `json:"user,omitempty"` // FIXME: Pointer in v2
|
// User is the user that changed the answer, when the voter is not anonymous.
|
||||||
|
User User `json:"user,omitempty"`
|
||||||
|
// OptionIDs contains the chosen option indices and is empty for a retracted vote.
|
||||||
OptionIDs []int `json:"option_ids"`
|
OptionIDs []int `json:"option_ids"`
|
||||||
|
// OptionPersistentIDs contains the persistent identifiers of the chosen options.
|
||||||
OptionPersistentIDs []string `json:"option_persistent_ids"` // Since: Bot API 9.6
|
OptionPersistentIDs []string `json:"option_persistent_ids"` // Since: Bot API 9.6
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// VoterUser returns the non-anonymous voter when it is present.
|
||||||
|
//
|
||||||
|
// Since: Bot API 4.6
|
||||||
|
func (a PollAnswer) VoterUser() (*User, bool) {
|
||||||
|
if a.User.ID == 0 {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return &a.User, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// VoterChatInfo returns the anonymous voter chat when it is present.
|
||||||
|
//
|
||||||
|
// Since: Bot API 6.8
|
||||||
|
func (a PollAnswer) VoterChatInfo() (*Chat, bool) {
|
||||||
|
if a.VoterChat.ID == 0 {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
return &a.VoterChat, true
|
||||||
|
}
|
||||||
|
|
||||||
// Poll contains information about a poll.
|
// Poll contains information about a poll.
|
||||||
// Since: Bot API 4.2
|
// Since: Bot API 4.2
|
||||||
// See https://core.telegram.org/bots/api#poll
|
// See https://core.telegram.org/bots/api#poll
|
||||||
type Poll struct {
|
type Poll struct {
|
||||||
|
// ID Unique poll identifier
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// Question Poll question, 1-300 characters
|
||||||
Question string `json:"question"`
|
Question string `json:"question"`
|
||||||
|
// QuestionEntities Optional. Special entities that appear in the question. Currently, only custom emoji
|
||||||
|
// entities are allowed in poll questions
|
||||||
QuestionEntities []MessageEntity `json:"question_entities"` // Since: Bot API 7.3
|
QuestionEntities []MessageEntity `json:"question_entities"` // Since: Bot API 7.3
|
||||||
|
// Options List of poll options
|
||||||
Options []PollOption `json:"options"`
|
Options []PollOption `json:"options"`
|
||||||
|
// TotalVoterCount Total number of users that voted in the poll
|
||||||
TotalVoterCount int `json:"total_voter_count"`
|
TotalVoterCount int `json:"total_voter_count"`
|
||||||
|
// IsClosed True, if the poll is closed
|
||||||
IsClosed bool `json:"is_closed,omitempty"`
|
IsClosed bool `json:"is_closed,omitempty"`
|
||||||
|
// IsAnonymous True, if the poll is anonymous
|
||||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||||
|
// Type Poll type, currently can be “regular” or “quiz”
|
||||||
Type PollType `json:"type"`
|
Type PollType `json:"type"`
|
||||||
|
|
||||||
|
// AllowsMultipleAnswers True, if the poll allows multiple answers
|
||||||
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // Since: Bot API 4.6
|
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // Since: Bot API 4.6
|
||||||
|
// AllowsRevoting True, if the poll allows to change the chosen answer options
|
||||||
AllowsRevoting bool `json:"allows_revoting,omitempty"` // Since: Bot API 9.6
|
AllowsRevoting bool `json:"allows_revoting,omitempty"` // Since: Bot API 9.6
|
||||||
|
// MembersOnly True if voting is limited to users who have been members of the chat where the poll was
|
||||||
|
// originally sent for more than 24 hours
|
||||||
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
||||||
|
// CountryCodes Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries
|
||||||
|
// from which users can vote in the poll. The country code “FT” is used for users with anonymous
|
||||||
|
// numbers. If omitted, then users from any country can participate in the poll.
|
||||||
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
||||||
|
// CorrectOptionIDs Optional. Array of 0-based identifiers of the correct answer options. Available only for
|
||||||
|
// polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with
|
||||||
|
// the bot.
|
||||||
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"` // Since: Bot API 9.6
|
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"` // Since: Bot API 9.6
|
||||||
|
// Explanation Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon
|
||||||
|
// in a quiz-style poll, 0-200 characters
|
||||||
Explanation string `json:"explanation,omitempty"` // Since: Bot API 4.8
|
Explanation string `json:"explanation,omitempty"` // Since: Bot API 4.8
|
||||||
|
// ExplanationEntities Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
|
||||||
|
// the explanation
|
||||||
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // Since: Bot API 4.8
|
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // Since: Bot API 4.8
|
||||||
|
// ExplanationMedia Optional. Media added to the quiz explanation
|
||||||
ExplanationMedia *PollMedia `json:"explanation_media,omitempty"` // Since: Bot API 10.0
|
ExplanationMedia *PollMedia `json:"explanation_media,omitempty"` // Since: Bot API 10.0
|
||||||
|
// OpenPeriod Optional. Amount of time in seconds the poll will be active after creation
|
||||||
OpenPeriod int `json:"open_period,omitempty"` // Since: Bot API 4.8
|
OpenPeriod int `json:"open_period,omitempty"` // Since: Bot API 4.8
|
||||||
|
// CloseDate Optional. Point in time (Unix timestamp) when the poll will be automatically closed
|
||||||
CloseDate int `json:"close_date,omitempty"` // Since: Bot API 4.8
|
CloseDate int `json:"close_date,omitempty"` // Since: Bot API 4.8
|
||||||
|
// Description Optional. Description of the poll; for polls inside the Message object only
|
||||||
Description string `json:"description,omitempty"` // Since: Bot API 9.6
|
Description string `json:"description,omitempty"` // Since: Bot API 9.6
|
||||||
|
// DescriptionEntities Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
|
||||||
|
// the description
|
||||||
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"` // Since: Bot API 9.6
|
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"` // Since: Bot API 9.6
|
||||||
|
// Media Optional. Media added to the poll description; for polls inside the Message object only
|
||||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -276,72 +462,120 @@ type Link struct {
|
|||||||
// PollMedia represents media attached to a poll.
|
// PollMedia represents media attached to a poll.
|
||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
type PollMedia struct {
|
type PollMedia struct {
|
||||||
|
// Animation Optional. Media is an animation, information about the animation
|
||||||
Animation *Animation `json:"animation,omitempty"`
|
Animation *Animation `json:"animation,omitempty"`
|
||||||
|
// Audio Optional. Media is an audio file, information about the file; currently, can't be received in a
|
||||||
|
// poll option
|
||||||
Audio *Audio `json:"audio,omitempty"`
|
Audio *Audio `json:"audio,omitempty"`
|
||||||
|
// Document Optional. Media is a general file, information about the file; currently, can't be received in a
|
||||||
|
// poll option
|
||||||
Document *Document `json:"document,omitempty"`
|
Document *Document `json:"document,omitempty"`
|
||||||
// Link contains link media attached to the poll.
|
// Link contains link media attached to the poll.
|
||||||
Link *Link `json:"link,omitempty"` // Since: Bot API 10.1
|
Link *Link `json:"link,omitempty"` // Since: Bot API 10.1
|
||||||
|
// LivePhoto Optional. Media is a live photo, information about the live photo
|
||||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
|
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
|
||||||
|
// Location Optional. Media is a shared location, information about the location
|
||||||
Location *Location `json:"location,omitempty"`
|
Location *Location `json:"location,omitempty"`
|
||||||
|
// Photo Optional. Media is a photo, available sizes of the photo
|
||||||
Photo []PhotoSize `json:"photo,omitempty"`
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
// Sticker Optional. Media is a sticker, information about the sticker; currently, for poll options only
|
||||||
Sticker *Sticker `json:"sticker,omitempty"`
|
Sticker *Sticker `json:"sticker,omitempty"`
|
||||||
|
// Venue Optional. Media is a venue, information about the venue
|
||||||
Venue *Venue `json:"venue,omitempty"`
|
Venue *Venue `json:"venue,omitempty"`
|
||||||
|
// Video Optional. Media is a video, information about the video
|
||||||
Video *Video `json:"video,omitempty"`
|
Video *Video `json:"video,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChecklistTask represents a single task in a checklist.
|
// ChecklistTask represents a single task in a checklist.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type ChecklistTask struct {
|
type ChecklistTask struct {
|
||||||
|
// ID Unique identifier of the task
|
||||||
ID int `json:"id"`
|
ID int `json:"id"`
|
||||||
|
// Text Text of the task
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// TextEntities Optional. Special entities that appear in the task text
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
// CompletedByUser Optional. User that completed the task; omitted if the task wasn't completed by a user
|
||||||
CompletedByUser *User `json:"completed_by_user,omitempty"`
|
CompletedByUser *User `json:"completed_by_user,omitempty"`
|
||||||
|
// CompletedByChat Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
|
||||||
CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
|
CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
|
||||||
|
// CompletionDate Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't
|
||||||
|
// completed
|
||||||
CompletionDate int `json:"completion_date,omitempty"`
|
CompletionDate int `json:"completion_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Checklist represents a checklist.
|
// Checklist represents a checklist.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type Checklist struct {
|
type Checklist struct {
|
||||||
|
// Title Title of the checklist
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// TitleEntities Optional. Special entities that appear in the checklist title
|
||||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||||
|
// Tasks List of tasks in the checklist
|
||||||
Tasks []ChecklistTask `json:"tasks"`
|
Tasks []ChecklistTask `json:"tasks"`
|
||||||
|
// OthersCanAddTasks Optional. True, if users other than the creator of the list can add tasks to the list
|
||||||
OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||||
|
// OthersCanMarkTasksAsDone Optional. True, if users other than the creator of the list can mark tasks as
|
||||||
|
// done or not done
|
||||||
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// InputChecklistTask describes a task in a checklist.
|
// InputChecklistTask describes a task in a checklist.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type InputChecklistTask struct {
|
type InputChecklistTask struct {
|
||||||
|
// ID Unique identifier of the task; must be positive and unique among all task identifiers currently
|
||||||
|
// present in the checklist
|
||||||
ID int `json:"id"`
|
ID int `json:"id"`
|
||||||
|
// Text Text of the task; 1-100 characters after entities parsing
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// TextEntities Optional. List of special entities that appear in the text, which can be specified instead
|
||||||
|
// of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and
|
||||||
|
// date_time entities are allowed.
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// InputChecklist represents a checklist to be sent.
|
// InputChecklist represents a checklist to be sent.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type InputChecklist struct {
|
type InputChecklist struct {
|
||||||
|
// Title Title of the checklist; 1-255 characters after entities parsing
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the title. See formatting options for more details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// TitleEntities Optional. List of special entities that appear in the title, which can be specified instead
|
||||||
|
// of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and
|
||||||
|
// date_time entities are allowed.
|
||||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||||
|
// Tasks List of 1-30 tasks in the checklist
|
||||||
Tasks []InputChecklistTask `json:"tasks"`
|
Tasks []InputChecklistTask `json:"tasks"`
|
||||||
OtherCanAddTasks bool `json:"other_can_add_tasks,omitempty"`
|
// OtherCanAddTasks Optional. Pass True if other users can add tasks to the checklist
|
||||||
OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"`
|
// Subject to change in v2: the Go field name may be corrected to OthersCanAddTasks.
|
||||||
|
OtherCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||||
|
// OtherCanMarkTasksAsDone Optional. Pass True if other users can mark tasks as done or not done in the
|
||||||
|
// checklist
|
||||||
|
// Subject to change in v2: the Go field name may be corrected to OthersCanMarkTasksAsDone.
|
||||||
|
OtherCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChecklistTaskDone describes a service message about checklist tasks being marked as done.
|
// ChecklistTaskDone describes a service message about checklist tasks being marked as done.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type ChecklistTaskDone struct {
|
type ChecklistTaskDone struct {
|
||||||
|
// ChecklistMessage is the checklist message when it is available.
|
||||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||||
|
// MarkedAsDoneTaskIDs Optional. Identifiers of the tasks that were marked as done
|
||||||
MarkedAsDoneTaskIDs []int `json:"marked_as_done_task_ids,omitempty"`
|
MarkedAsDoneTaskIDs []int `json:"marked_as_done_task_ids,omitempty"`
|
||||||
|
// MarkedAsNotDoneTaskIDs Optional. Identifiers of the tasks that were marked as not done
|
||||||
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChecklistTasksAdded describes a service message about new checklist tasks being added.
|
// ChecklistTasksAdded describes a service message about new checklist tasks being added.
|
||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
type ChecklistTasksAdded struct {
|
type ChecklistTasksAdded struct {
|
||||||
|
// ChecklistMessage Optional. Message containing the checklist to which the tasks were added. Note that the
|
||||||
|
// Message object in this field will not contain the reply_to_message field even if it itself is a reply.
|
||||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||||
|
// Tasks List of tasks added to the checklist
|
||||||
Tasks []ChecklistTask `json:"tasks"`
|
Tasks []ChecklistTask `json:"tasks"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -378,35 +612,64 @@ const (
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#inputmedia
|
// See https://core.telegram.org/bots/api#inputmedia
|
||||||
type InputMedia struct {
|
type InputMedia struct {
|
||||||
|
// Type identifies the concrete input-media variant.
|
||||||
Type InputMediaType `json:"type"`
|
Type InputMediaType `json:"type"`
|
||||||
|
// Media is a file_id, HTTP URL, or attach:// reference for the media.
|
||||||
Media string `json:"media"`
|
Media string `json:"media"`
|
||||||
|
|
||||||
|
// Caption is the optional media caption.
|
||||||
Caption *string `json:"caption,omitempty"`
|
Caption *string `json:"caption,omitempty"`
|
||||||
|
// ParseMode selects how entities in Caption are parsed.
|
||||||
ParseMode *ParseMode `json:"parse_mode,omitempty"`
|
ParseMode *ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. List of special entities that appear in the caption, which can be specified
|
||||||
|
// instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"` // Since: Bot API 7.4
|
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"` // Since: Bot API 7.4
|
||||||
|
// HasSpoiler requests that supported media be covered by a spoiler animation.
|
||||||
HasSpoiler *bool `json:"has_spoiler,omitempty"` // Since: Bot API 6.4
|
HasSpoiler *bool `json:"has_spoiler,omitempty"` // Since: Bot API 6.4
|
||||||
|
|
||||||
|
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||||
|
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||||
|
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||||
|
// name. More information on Sending Files »
|
||||||
Cover *string `json:"cover"` // Since: Bot API 8.3
|
Cover *string `json:"cover"` // Since: Bot API 8.3
|
||||||
|
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||||
StartTimestamp *int `json:"start_timestamp"` // Since: Bot API 8.3
|
StartTimestamp *int `json:"start_timestamp"` // Since: Bot API 8.3
|
||||||
|
// Width is the optional media width in pixels.
|
||||||
Width *int `json:"width,omitempty"`
|
Width *int `json:"width,omitempty"`
|
||||||
|
// Height is the optional media height in pixels.
|
||||||
Height *int `json:"height,omitempty"`
|
Height *int `json:"height,omitempty"`
|
||||||
|
// Duration is the optional duration of the media in seconds.
|
||||||
Duration *int `json:"duration,omitempty"`
|
Duration *int `json:"duration,omitempty"`
|
||||||
|
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||||
|
|
||||||
|
// Performer Optional. Performer of the audio
|
||||||
Performer *string `json:"performer,omitempty"`
|
Performer *string `json:"performer,omitempty"`
|
||||||
|
// Title is the optional title of audio or venue media.
|
||||||
Title *string `json:"title,omitempty"`
|
Title *string `json:"title,omitempty"`
|
||||||
|
|
||||||
|
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||||
Emoji *string `json:"emoji,omitempty"`
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
|
||||||
|
// Latitude Latitude of the location
|
||||||
Latitude *float64 `json:"latitude,omitempty"`
|
Latitude *float64 `json:"latitude,omitempty"`
|
||||||
|
// Longitude Longitude of the location
|
||||||
Longitude *float64 `json:"longitude,omitempty"`
|
Longitude *float64 `json:"longitude,omitempty"`
|
||||||
|
// Address Address of the venue
|
||||||
Address *string `json:"address,omitempty"`
|
Address *string `json:"address,omitempty"`
|
||||||
|
// FoursquareID Optional. Foursquare identifier of the venue
|
||||||
FoursquareID *string `json:"foursquare_id,omitempty"`
|
FoursquareID *string `json:"foursquare_id,omitempty"`
|
||||||
|
// FoursquareType Optional. Foursquare type of the venue, if known. (For example,
|
||||||
|
// “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
|
||||||
FoursquareType *string `json:"foursquare_type,omitempty"`
|
FoursquareType *string `json:"foursquare_type,omitempty"`
|
||||||
|
// GooglePlaceID Optional. Google Places identifier of the venue
|
||||||
GooglePlaceID *string `json:"google_place_id,omitempty"`
|
GooglePlaceID *string `json:"google_place_id,omitempty"`
|
||||||
|
// GooglePlaceType Optional. Google Places type of the venue. (See supported types.)
|
||||||
GooglePlaceType *string `json:"google_place_type,omitempty"`
|
GooglePlaceType *string `json:"google_place_type,omitempty"`
|
||||||
|
|
||||||
|
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||||
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
|
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -426,14 +689,25 @@ const (
|
|||||||
// Since: Bot API 7.6
|
// Since: Bot API 7.6
|
||||||
// See https://core.telegram.org/bots/api#inputpaidmedia
|
// See https://core.telegram.org/bots/api#inputpaidmedia
|
||||||
type InputPaidMedia struct {
|
type InputPaidMedia struct {
|
||||||
|
// Type identifies the concrete paid-media variant.
|
||||||
Type InputPaidMediaType `json:"type"`
|
Type InputPaidMediaType `json:"type"`
|
||||||
|
// Media is a file_id, HTTP URL, or attach:// reference for the paid media.
|
||||||
Media string `json:"media"`
|
Media string `json:"media"`
|
||||||
|
|
||||||
|
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||||
|
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||||
|
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||||
|
// name. More information on Sending Files »
|
||||||
Cover *string `json:"cover,omitempty"` // Since: Bot API 8.3
|
Cover *string `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||||
|
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||||
StartTimestamp *int64 `json:"start_timestamp,omitempty"` // Since: Bot API 8.3
|
StartTimestamp *int64 `json:"start_timestamp,omitempty"` // Since: Bot API 8.3
|
||||||
|
// Width Optional. Video width
|
||||||
Width *int `json:"width,omitempty"`
|
Width *int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Video height
|
||||||
Height *int `json:"height,omitempty"`
|
Height *int `json:"height,omitempty"`
|
||||||
|
// Duration Optional. Video duration in seconds
|
||||||
Duration *int `json:"duration,omitempty"`
|
Duration *int `json:"duration,omitempty"`
|
||||||
|
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -441,22 +715,39 @@ type InputPaidMedia struct {
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#photosize
|
// See https://core.telegram.org/bots/api#photosize
|
||||||
type PhotoSize struct {
|
type PhotoSize struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Photo width
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Photo height
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
// FileSize Optional. File size in bytes
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// LivePhoto represents a live photo (a photo with a short video attached).
|
// LivePhoto represents a live photo (a photo with a short video attached).
|
||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
type LivePhoto struct {
|
type LivePhoto struct {
|
||||||
|
// Photo Optional. Available sizes of the corresponding static photo
|
||||||
Photo []PhotoSize `json:"photo,omitempty"`
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
// FileID Identifier for the video file which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for the video file which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Video width as defined by the sender
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Video height as defined by the sender
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
// Duration Duration of the video in seconds as defined by the sender
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
|
// MIMEType Optional. MIME type of the file as defined by the sender
|
||||||
MIMEType string `json:"mime_type,omitempty"`
|
MIMEType string `json:"mime_type,omitempty"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestPollAnswerVoterHelpers(t *testing.T) {
|
||||||
|
userAnswer := PollAnswer{User: User{ID: 42}}
|
||||||
|
user, ok := userAnswer.VoterUser()
|
||||||
|
if !ok || user.ID != 42 {
|
||||||
|
t.Fatalf("unexpected voter user: %#v, %v", user, ok)
|
||||||
|
}
|
||||||
|
if chat, ok := userAnswer.VoterChatInfo(); ok || chat != nil {
|
||||||
|
t.Fatalf("unexpected voter chat: %#v, %v", chat, ok)
|
||||||
|
}
|
||||||
|
|
||||||
|
chatAnswer := PollAnswer{VoterChat: Chat{ID: -100}}
|
||||||
|
chat, ok := chatAnswer.VoterChatInfo()
|
||||||
|
if !ok || chat.ID != -100 {
|
||||||
|
t.Fatalf("unexpected voter chat: %#v, %v", chat, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -6,8 +6,14 @@ import "context"
|
|||||||
// Since: Bot API 4.7
|
// Since: Bot API 4.7
|
||||||
// See https://core.telegram.org/bots/api#setmycommands
|
// See https://core.telegram.org/bots/api#setmycommands
|
||||||
type SetMyCommands struct {
|
type SetMyCommands struct {
|
||||||
|
// Commands Required. 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.
|
||||||
Commands []BotCommand `json:"commands"`
|
Commands []BotCommand `json:"commands"`
|
||||||
|
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||||
|
// Defaults to BotCommandScopeDefault.
|
||||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
// Language Optional. 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.
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -33,7 +39,11 @@ func (api *API) SetMyCommandsWithContext(ctx context.Context, params SetMyComman
|
|||||||
// Since: Bot API 5.3
|
// Since: Bot API 5.3
|
||||||
// See https://core.telegram.org/bots/api#deletemycommands
|
// See https://core.telegram.org/bots/api#deletemycommands
|
||||||
type DeleteMyCommands struct {
|
type DeleteMyCommands struct {
|
||||||
|
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||||
|
// Defaults to BotCommandScopeDefault.
|
||||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
// Language Optional. 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.
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,7 +69,9 @@ func (api *API) DeleteMyCommandsWithContext(ctx context.Context, params DeleteMy
|
|||||||
// Since: Bot API 4.7
|
// Since: Bot API 4.7
|
||||||
// See https://core.telegram.org/bots/api#getmycommands
|
// See https://core.telegram.org/bots/api#getmycommands
|
||||||
type GetMyCommands struct {
|
type GetMyCommands struct {
|
||||||
|
// Scope Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
|
||||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -84,7 +96,11 @@ func (api *API) GetMyCommandsWithContext(ctx context.Context, params GetMyComman
|
|||||||
// Since: Bot API 6.7
|
// Since: Bot API 6.7
|
||||||
// See https://core.telegram.org/bots/api#setmyname
|
// See https://core.telegram.org/bots/api#setmyname
|
||||||
type SetMyName struct {
|
type SetMyName struct {
|
||||||
|
// Name Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the
|
||||||
|
// given language.
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users
|
||||||
|
// for whose language there is no dedicated name.
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -110,6 +126,7 @@ func (api *API) SetMyNameWithContext(ctx context.Context, params SetMyName) (boo
|
|||||||
// Since: Bot API 6.7
|
// Since: Bot API 6.7
|
||||||
// See https://core.telegram.org/bots/api#getmyname
|
// See https://core.telegram.org/bots/api#getmyname
|
||||||
type GetMyName struct {
|
type GetMyName struct {
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,7 +151,11 @@ func (api *API) GetMyNameWithContext(ctx context.Context, params GetMyName) (Bot
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setmydescription
|
// See https://core.telegram.org/bots/api#setmydescription
|
||||||
type SetMyDescription struct {
|
type SetMyDescription struct {
|
||||||
|
// Description Optional. New bot description; 0-512 characters. Pass an empty string to remove the dedicated
|
||||||
|
// description for the given language.
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code. If empty, the description will be applied to all
|
||||||
|
// users for whose language there is no dedicated description.
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -160,6 +181,7 @@ func (api *API) SetMyDescriptionWithContext(ctx context.Context, params SetMyDes
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#getmydescription
|
// See https://core.telegram.org/bots/api#getmydescription
|
||||||
type GetMyDescription struct {
|
type GetMyDescription struct {
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -184,7 +206,11 @@ func (api *API) GetMyDescriptionWithContext(ctx context.Context, params GetMyDes
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||||
type SetMyShortDescription struct {
|
type SetMyShortDescription struct {
|
||||||
|
// ShortDescription Optional. New short description for the bot; 0-120 characters. Pass an empty string to
|
||||||
|
// remove the dedicated short description for the given language.
|
||||||
ShortDescription string `json:"short_description,omitempty"`
|
ShortDescription string `json:"short_description,omitempty"`
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code. If empty, the short description will be applied
|
||||||
|
// to all users for whose language there is no dedicated short description.
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -210,6 +236,7 @@ func (api *API) SetMyShortDescriptionWithContext(ctx context.Context, params Set
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||||
type GetMyShortDescription struct {
|
type GetMyShortDescription struct {
|
||||||
|
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||||
Language string `json:"language_code,omitempty"`
|
Language string `json:"language_code,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -234,6 +261,7 @@ func (api *API) GetMyShortDescriptionWithContext(ctx context.Context, params Get
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||||
type SetMyProfilePhoto struct {
|
type SetMyProfilePhoto struct {
|
||||||
|
// Photo Required. The new profile photo to set
|
||||||
Photo InputProfilePhoto `json:"photo"`
|
Photo InputProfilePhoto `json:"photo"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -277,7 +305,11 @@ func (api *API) RemoveMyProfilePhotoWithContext(ctx context.Context) (bool, erro
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||||
type SetChatMenuButton struct {
|
type SetChatMenuButton struct {
|
||||||
|
// ChatID Optional. Unique identifier for the target private chat. If not specified, the bot's default menu
|
||||||
|
// button will be changed.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MenuButton Optional. A JSON-serialized object for the bot's new menu button. Defaults to
|
||||||
|
// MenuButtonDefault.
|
||||||
MenuButton *MenuButton `json:"menu_button,omitempty"`
|
MenuButton *MenuButton `json:"menu_button,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -303,6 +335,8 @@ func (api *API) SetChatMenuButtonWithContext(ctx context.Context, params SetChat
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||||
type GetChatMenuButton struct {
|
type GetChatMenuButton struct {
|
||||||
|
// ChatID Optional. Unique identifier for the target private chat. If not specified, the bot's default menu
|
||||||
|
// button will be returned.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -327,7 +361,11 @@ func (api *API) GetChatMenuButtonWithContext(ctx context.Context, params GetChat
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||||
type SetMyDefaultAdministratorRights struct {
|
type SetMyDefaultAdministratorRights struct {
|
||||||
|
// Rights Optional. A JSON-serialized object describing new default administrator rights. If not specified,
|
||||||
|
// the default administrator rights will be cleared.
|
||||||
Rights *ChatAdministratorRights `json:"rights"`
|
Rights *ChatAdministratorRights `json:"rights"`
|
||||||
|
// ForChannels Optional. Pass True to change the default administrator rights of the bot in channels.
|
||||||
|
// Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
|
||||||
ForChannels bool `json:"for_channels"`
|
ForChannels bool `json:"for_channels"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -353,6 +391,8 @@ func (api *API) SetMyDefaultAdministratorRightsWithContext(ctx context.Context,
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||||
type GetMyDefaultAdministratorRights struct {
|
type GetMyDefaultAdministratorRights struct {
|
||||||
|
// ForChannels Optional. Pass True to get default administrator rights of the bot in channels. Otherwise,
|
||||||
|
// default administrator rights of the bot for groups and supergroups will be returned.
|
||||||
ForChannels bool `json:"for_channels"`
|
ForChannels bool `json:"for_channels"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -394,12 +434,26 @@ func (api *API) GetAvailableGiftsWithContext(ctx context.Context) (Gifts, error)
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#sendgift
|
// See https://core.telegram.org/bots/api#sendgift
|
||||||
type SendGift struct {
|
type SendGift struct {
|
||||||
|
// UserID Optional. Required if chat_id is not specified. Unique identifier of the target user who will
|
||||||
|
// receive the gift.
|
||||||
UserID int64 `json:"user_id,omitempty"`
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if user_id is not specified. Unique identifier for the chat or username of the
|
||||||
|
// channel (in the format @username) that will receive the gift.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// GiftID Required. Identifier of the gift; limited gifts can't be sent to channel chats
|
||||||
GiftID string `json:"gift_id"`
|
GiftID string `json:"gift_id"`
|
||||||
|
// PayForUpgrade Optional. Pass True to pay for the gift upgrade from the bot's balance, thereby making the
|
||||||
|
// upgrade free for the receiver
|
||||||
PayForUpgrade bool `json:"pay_for_upgrade"`
|
PayForUpgrade bool `json:"pay_for_upgrade"`
|
||||||
|
// Text Optional. Text that will be shown along with the gift; 0-128 characters
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||||
|
// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”,
|
||||||
|
// “custom_emoji”, and “date_time” are ignored.
|
||||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
// TextEntities Optional. A JSON-serialized list of special entities that appear in the gift text. It can be
|
||||||
|
// specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”,
|
||||||
|
// “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -425,11 +479,24 @@ func (api *API) SendGiftWithContext(ctx context.Context, params SendGift) (bool,
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||||
type GiftPremiumSubscription struct {
|
type GiftPremiumSubscription struct {
|
||||||
|
// UserID Required. Unique identifier of the target user who will receive a Telegram Premium subscription
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// MonthCount Required. Number of months the Telegram Premium subscription will be active for the user; must
|
||||||
|
// be one of 3, 6, or 12
|
||||||
MonthCount int `json:"month_count"`
|
MonthCount int `json:"month_count"`
|
||||||
|
// StarCount Required. Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000
|
||||||
|
// for 3 months, 1500 for 6 months, and 2500 for 12 months
|
||||||
StarCount int `json:"star_count"`
|
StarCount int `json:"star_count"`
|
||||||
|
// Text Optional. Text that will be shown along with the service message about the subscription; 0-128
|
||||||
|
// characters
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
|
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||||
|
// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”,
|
||||||
|
// “custom_emoji”, and “date_time” are ignored.
|
||||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
// TextEntities Optional. A JSON-serialized list of special entities that appear in the gift text. It can be
|
||||||
|
// specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”,
|
||||||
|
// “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -455,6 +522,7 @@ func (api *API) GiftPremiumSubscriptionWithContext(ctx context.Context, params G
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||||
type GetManagedBotAccessSettings struct {
|
type GetManagedBotAccessSettings struct {
|
||||||
|
// BotUserID identifies the managed bot.
|
||||||
BotUserID int64 `json:"bot_user_id"`
|
BotUserID int64 `json:"bot_user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -479,7 +547,9 @@ func (api *API) GetManagedBotAccessSettingsWithContext(ctx context.Context, para
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||||
type SetManagedBotAccessSettings struct {
|
type SetManagedBotAccessSettings struct {
|
||||||
|
// BotUserID identifies the managed bot.
|
||||||
BotUserID int64 `json:"bot_user_id"`
|
BotUserID int64 `json:"bot_user_id"`
|
||||||
|
// AccessSettings contains the access settings to apply to the managed bot.
|
||||||
AccessSettings BotAccessSettings `json:"access_settings"`
|
AccessSettings BotAccessSettings `json:"access_settings"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,10 @@ package tgapi
|
|||||||
// Since: Bot API 4.7
|
// Since: Bot API 4.7
|
||||||
// See https://core.telegram.org/bots/api#botcommand
|
// See https://core.telegram.org/bots/api#botcommand
|
||||||
type BotCommand struct {
|
type BotCommand struct {
|
||||||
|
// Command Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and
|
||||||
|
// underscores.
|
||||||
Command string `json:"command"`
|
Command string `json:"command"`
|
||||||
|
// Description Description of the command; 1-256 characters
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
// IsEphemeral marks the command as visible only in ephemeral command contexts.
|
// IsEphemeral marks the command as visible only in ephemeral command contexts.
|
||||||
IsEphemeral bool `json:"is_ephemeral,omitempty"` // Since: Bot API 10.2
|
IsEphemeral bool `json:"is_ephemeral,omitempty"` // Since: Bot API 10.2
|
||||||
@@ -34,26 +37,33 @@ const (
|
|||||||
// Since: Bot API 5.3
|
// Since: Bot API 5.3
|
||||||
// See https://core.telegram.org/bots/api#botcommandscope
|
// See https://core.telegram.org/bots/api#botcommandscope
|
||||||
type BotCommandScope struct {
|
type BotCommandScope struct {
|
||||||
|
// Type identifies the concrete command-scope variant.
|
||||||
Type BotCommandScopeType `json:"type"`
|
Type BotCommandScopeType `json:"type"`
|
||||||
|
// ChatID Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username. Channel direct messages chats and channel chats aren't supported.
|
||||||
ChatID *int64 `json:"chat_id,omitempty"`
|
ChatID *int64 `json:"chat_id,omitempty"`
|
||||||
|
// UserID Unique identifier of the target user
|
||||||
UserID *int64 `json:"user_id,omitempty"`
|
UserID *int64 `json:"user_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BotName represents the bot's name.
|
// BotName represents the bot's name.
|
||||||
// Since: Bot API 6.7
|
// Since: Bot API 6.7
|
||||||
type BotName struct {
|
type BotName struct {
|
||||||
|
// Name The bot's name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BotDescription represents the bot's description.
|
// BotDescription represents the bot's description.
|
||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
type BotDescription struct {
|
type BotDescription struct {
|
||||||
|
// Description The bot's description
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BotShortDescription represents the bot's short description.
|
// BotShortDescription represents the bot's short description.
|
||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
type BotShortDescription struct {
|
type BotShortDescription struct {
|
||||||
|
// ShortDescription The bot's short description
|
||||||
ShortDescription string `json:"short_description"`
|
ShortDescription string `json:"short_description"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -71,13 +81,22 @@ const (
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#inputprofilephoto
|
// See https://core.telegram.org/bots/api#inputprofilephoto
|
||||||
type InputProfilePhoto struct {
|
type InputProfilePhoto struct {
|
||||||
|
// Type identifies the static-photo or animated-photo variant.
|
||||||
Type InputProfilePhotoType `json:"type"`
|
Type InputProfilePhotoType `json:"type"`
|
||||||
|
|
||||||
|
// Photo The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so
|
||||||
|
// you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under
|
||||||
|
// <file_attach_name>. More information on Sending Files »
|
||||||
// Static fields (for static photos)
|
// Static fields (for static photos)
|
||||||
Photo *string `json:"photo,omitempty"`
|
Photo *string `json:"photo,omitempty"`
|
||||||
|
|
||||||
|
// Animation The animated profile photo. Profile photos can't be reused and can only be uploaded as a new
|
||||||
|
// file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using
|
||||||
|
// multipart/form-data under <file_attach_name>. More information on Sending Files »
|
||||||
// Animated fields (for animated profile videos)
|
// Animated fields (for animated profile videos)
|
||||||
Animation *string `json:"animation,omitempty"`
|
Animation *string `json:"animation,omitempty"`
|
||||||
|
// MainFrameTimestamp Optional. Timestamp in seconds of the frame that will be used as the static profile
|
||||||
|
// photo. Defaults to 0.0.
|
||||||
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
|
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -97,10 +116,16 @@ const (
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#menubutton
|
// See https://core.telegram.org/bots/api#menubutton
|
||||||
type MenuButton struct {
|
type MenuButton struct {
|
||||||
|
// Type identifies the commands, web_app, or default menu-button variant.
|
||||||
Type MenuButtonType `json:"type"`
|
Type MenuButtonType `json:"type"`
|
||||||
|
|
||||||
|
// Text Text on the button
|
||||||
// WebApp fields (for web_app button)
|
// WebApp fields (for web_app button)
|
||||||
Text *string `json:"text"`
|
Text *string `json:"text"`
|
||||||
|
// WebApp Description of the Web App that will be launched when the user presses the button. The Web App
|
||||||
|
// will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery.
|
||||||
|
// Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web
|
||||||
|
// App's URL, in which case the Web App will be opened as if the user pressed the link.
|
||||||
WebApp *WebAppInfo `json:"web_app"`
|
WebApp *WebAppInfo `json:"web_app"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -108,5 +133,6 @@ type MenuButton struct {
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#botaccesssettings
|
// See https://core.telegram.org/bots/api#botaccesssettings
|
||||||
type BotAccessSettings struct {
|
type BotAccessSettings struct {
|
||||||
|
// AllowAllPrivateChats reports whether the managed bot may access all private chats of its owner.
|
||||||
AllowAllPrivateChats bool `json:"allow_all_private_chats"`
|
AllowAllPrivateChats bool `json:"allow_all_private_chats"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,10 @@ import "context"
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#verifyuser
|
// See https://core.telegram.org/bots/api#verifyuser
|
||||||
type VerifyUser struct {
|
type VerifyUser struct {
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// CustomDescription Optional. Custom description for the verification; 0-70 characters. Must be empty if
|
||||||
|
// the organization isn't allowed to provide a custom verification description.
|
||||||
CustomDescription string `json:"custom_description,omitempty"`
|
CustomDescription string `json:"custom_description,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,7 +35,11 @@ func (api *API) VerifyUserWithContext(ctx context.Context, params VerifyUser) (b
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#verifychat
|
// See https://core.telegram.org/bots/api#verifychat
|
||||||
type VerifyChat struct {
|
type VerifyChat struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username. Channel direct messages chats can't be verified.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// CustomDescription Optional. Custom description for the verification; 0-70 characters. Must be empty if
|
||||||
|
// the organization isn't allowed to provide a custom verification description.
|
||||||
CustomDescription string `json:"custom_description,omitempty"`
|
CustomDescription string `json:"custom_description,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,6 +65,7 @@ func (api *API) VerifyChatWithContext(ctx context.Context, params VerifyChat) (b
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#removeuserverification
|
// See https://core.telegram.org/bots/api#removeuserverification
|
||||||
type RemoveUserVerification struct {
|
type RemoveUserVerification struct {
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -83,6 +91,8 @@ func (api *API) RemoveUserVerificationWithContext(ctx context.Context, params Re
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#removechatverification
|
// See https://core.telegram.org/bots/api#removechatverification
|
||||||
type RemoveChatVerification struct {
|
type RemoveChatVerification struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot or channel in the
|
||||||
|
// format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -108,8 +118,13 @@ func (api *API) RemoveChatVerificationWithContext(ctx context.Context, params Re
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||||
type ReadBusinessMessage struct {
|
type ReadBusinessMessage struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which to read
|
||||||
|
// the message
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// ChatID Required. Unique identifier of the chat in which the message was received. The chat must have been
|
||||||
|
// active in the last 24 hours.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Unique identifier of the message to mark as read
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -135,6 +150,7 @@ func (api *API) ReadBusinessMessageWithContext(ctx context.Context, params ReadB
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||||
type GetBusinessConnection struct {
|
type GetBusinessConnection struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -159,7 +175,11 @@ func (api *API) GetBusinessConnectionWithContext(ctx context.Context, params Get
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||||
type DeleteBusinessMessages struct {
|
type DeleteBusinessMessages struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which to delete
|
||||||
|
// the messages
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// MessageIDs Required. A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must
|
||||||
|
// be from the same chat. See deleteMessage for limitations on which messages can be deleted.
|
||||||
MessageIDs []int `json:"message_ids"`
|
MessageIDs []int `json:"message_ids"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -185,8 +205,11 @@ func (api *API) DeleteBusinessMessagesWithContext(ctx context.Context, params De
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||||
type SetBusinessAccountName struct {
|
type SetBusinessAccountName struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// FirstName Required. The new value of the first name for the business account; 1-64 characters
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
|
// LastName Optional. The new value of the last name for the business account; 0-64 characters
|
||||||
LastName string `json:"last_name,omitempty"`
|
LastName string `json:"last_name,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -212,7 +235,9 @@ func (api *API) SetBusinessAccountNameWithContext(ctx context.Context, params Se
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||||
type SetBusinessAccountUsername struct {
|
type SetBusinessAccountUsername struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// Username Optional. The new value of the username for the business account; 0-32 characters
|
||||||
Username string `json:"username,omitempty"`
|
Username string `json:"username,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -238,7 +263,9 @@ func (api *API) SetBusinessAccountUsernameWithContext(ctx context.Context, param
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||||
type SetBusinessAccountBio struct {
|
type SetBusinessAccountBio struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// Bio Optional. The new value of the bio for the business account; 0-140 characters
|
||||||
Bio string `json:"bio,omitempty"`
|
Bio string `json:"bio,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -264,8 +291,12 @@ func (api *API) SetBusinessAccountBioWithContext(ctx context.Context, params Set
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||||
type SetBusinessAccountProfilePhoto struct {
|
type SetBusinessAccountProfilePhoto struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// Photo Required. The new profile photo to set
|
||||||
Photo InputProfilePhoto `json:"photo,omitempty"`
|
Photo InputProfilePhoto `json:"photo,omitempty"`
|
||||||
|
// IsPublic Optional. Pass True to set the public photo, which will be visible even if the main photo is
|
||||||
|
// hidden by the business account's privacy settings. An account can have only one public photo.
|
||||||
IsPublic bool `json:"is_public,omitempty"`
|
IsPublic bool `json:"is_public,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,7 +322,11 @@ func (api *API) SetBusinessAccountProfilePhotoWithContext(ctx context.Context, p
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||||
type RemoveBusinessAccountProfilePhoto struct {
|
type RemoveBusinessAccountProfilePhoto struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// IsPublic Optional. Pass True to remove the public photo, which is visible even if the main photo is
|
||||||
|
// hidden by the business account's privacy settings. After the main photo is removed, the previous profile
|
||||||
|
// photo (if present) becomes the main photo.
|
||||||
IsPublic bool `json:"is_public,omitempty"`
|
IsPublic bool `json:"is_public,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -317,8 +352,12 @@ func (api *API) RemoveBusinessAccountProfilePhotoWithContext(ctx context.Context
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||||
type SetBusinessAccountGiftSettings struct {
|
type SetBusinessAccountGiftSettings struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// ShowGiftButton Required. Pass True if a button for sending a gift to the user or by the business account
|
||||||
|
// must always be shown in the input field
|
||||||
ShowGiftButton bool `json:"show_gift_button"`
|
ShowGiftButton bool `json:"show_gift_button"`
|
||||||
|
// AcceptedGiftTypes Required. Types of gifts accepted by the business account
|
||||||
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -344,6 +383,7 @@ func (api *API) SetBusinessAccountGiftSettingsWithContext(ctx context.Context, p
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||||
type GetBusinessAccountStarBalance struct {
|
type GetBusinessAccountStarBalance struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -368,7 +408,9 @@ func (api *API) GetBusinessAccountStarBalanceWithContext(ctx context.Context, pa
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||||
type TransferBusinessAccountStars struct {
|
type TransferBusinessAccountStars struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// StarCount Required. Number of Telegram Stars to transfer; 1-10000
|
||||||
StarCount int `json:"star_count"`
|
StarCount int `json:"star_count"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -394,16 +436,32 @@ func (api *API) TransferBusinessAccountStarsWithContext(ctx context.Context, par
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||||
type GetBusinessAccountGifts struct {
|
type GetBusinessAccountGifts struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// ExcludeUnsaved Optional. Pass True to exclude gifts that aren't saved to the account's profile page
|
||||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||||
|
// ExcludeSaved Optional. Pass True to exclude gifts that are saved to the account's profile page
|
||||||
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||||
|
// ExcludeUnlimited Optional. Pass True to exclude gifts that can be purchased an unlimited number of times
|
||||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
// ExcludeLimitedUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number of
|
||||||
|
// times and can be upgraded to unique
|
||||||
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
// ExcludeLimitedNonUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number
|
||||||
|
// of times and can't be upgraded to unique
|
||||||
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
// ExcludeUnique Optional. Pass True to exclude unique gifts
|
||||||
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
// ExcludeFromBlockchain Optional. Pass True to exclude gifts that were assigned from the TON blockchain and
|
||||||
|
// can't be resold or transferred in Telegram
|
||||||
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
// SortByPrice Optional. Pass True to sort results by gift price instead of send date. Sorting is applied
|
||||||
|
// before pagination.
|
||||||
SortByPrice bool `json:"sort_by_price,omitempty"`
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
// Offset Optional. Offset of the first entry to return as received from the previous request; use empty
|
||||||
|
// string to get the first chunk of results
|
||||||
Offset string `json:"offset,omitempty"`
|
Offset string `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. The maximum number of gifts to be returned; 1-100. Defaults to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -428,7 +486,9 @@ func (api *API) GetBusinessAccountGiftsWithContext(ctx context.Context, params G
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||||
type ConvertGiftToStars struct {
|
type ConvertGiftToStars struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// OwnedGiftID Required. Unique identifier of the regular gift that should be converted to Telegram Stars
|
||||||
OwnedGiftID string `json:"owned_gift_id"`
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -454,9 +514,16 @@ func (api *API) ConvertGiftToStarsWithContext(ctx context.Context, params Conver
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#upgradegift
|
// See https://core.telegram.org/bots/api#upgradegift
|
||||||
type UpgradeGift struct {
|
type UpgradeGift struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// OwnedGiftID Required. Unique identifier of the regular gift that should be upgraded to a unique one
|
||||||
OwnedGiftID string `json:"owned_gift_id"`
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
|
// KeepOriginalDetails Optional. Pass True to keep the original gift text, sender and receiver in the
|
||||||
|
// upgraded gift
|
||||||
KeepOriginalDetails bool `json:"keep_original_details,omitempty"`
|
KeepOriginalDetails bool `json:"keep_original_details,omitempty"`
|
||||||
|
// StarCount Optional. The amount of Telegram Stars that will be paid for the upgrade from the business
|
||||||
|
// account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars
|
||||||
|
// business bot right is required and gift.upgrade_star_count must be passed.
|
||||||
StarCount int `json:"star_count,omitempty"`
|
StarCount int `json:"star_count,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -482,9 +549,15 @@ func (api *API) UpgradeGiftWithContext(ctx context.Context, params UpgradeGift)
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#transfergift
|
// See https://core.telegram.org/bots/api#transfergift
|
||||||
type TransferGift struct {
|
type TransferGift struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// OwnedGiftID Required. Unique identifier of the regular gift that should be transferred
|
||||||
OwnedGiftID string `json:"owned_gift_id"`
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
|
// NewOwnerChatID Required. Unique identifier of the chat which will own the gift. The chat must be active
|
||||||
|
// in the last 24 hours.
|
||||||
NewOwnerChatID int64 `json:"new_owner_chat_id"`
|
NewOwnerChatID int64 `json:"new_owner_chat_id"`
|
||||||
|
// StarCount Optional. The amount of Telegram Stars that will be paid for the transfer from the business
|
||||||
|
// account balance. If positive, then the can_transfer_stars business bot right is required.
|
||||||
StarCount int `json:"star_count,omitempty"`
|
StarCount int `json:"star_count,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -510,16 +583,29 @@ func (api *API) TransferGiftWithContext(ctx context.Context, params TransferGift
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#poststory
|
// See https://core.telegram.org/bots/api#poststory
|
||||||
type PostStory struct {
|
type PostStory struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// Content Required. Content of the story
|
||||||
Content InputStoryContent `json:"content"`
|
Content InputStoryContent `json:"content"`
|
||||||
|
// ActivePeriod Required. Period after which the story is moved to the archive, in seconds; must be one of 6
|
||||||
|
// * 3600, 12 * 3600, 86400, or 2 * 86400
|
||||||
ActivePeriod int `json:"active_period"`
|
ActivePeriod int `json:"active_period"`
|
||||||
|
|
||||||
|
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the story caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||||
Areas []StoryArea `json:"areas"`
|
Areas []StoryArea `json:"areas"`
|
||||||
|
|
||||||
|
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||||
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||||
|
// ProtectContent Optional. Pass True if the content of the story must be protected from forwarding and
|
||||||
|
// screenshotting
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -544,11 +630,19 @@ func (api *API) PostStoryWithContext(ctx context.Context, params PostStory) (Sto
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#repoststory
|
// See https://core.telegram.org/bots/api#repoststory
|
||||||
type RepostStory struct {
|
type RepostStory struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// FromChatID Required. Unique identifier of the chat which posted the story that should be reposted
|
||||||
FromChatID int64 `json:"from_chat_id"`
|
FromChatID int64 `json:"from_chat_id"`
|
||||||
|
// FromStoryID Required. Unique identifier of the story that should be reposted
|
||||||
FromStoryID int `json:"from_story_id"`
|
FromStoryID int `json:"from_story_id"`
|
||||||
|
// ActivePeriod Required. Period after which the story is moved to the archive, in seconds; must be one of 6
|
||||||
|
// * 3600, 12 * 3600, 86400, or 2 * 86400
|
||||||
ActivePeriod int `json:"active_period"`
|
ActivePeriod int `json:"active_period"`
|
||||||
|
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||||
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||||
|
// ProtectContent Optional. Pass True if the content of the story must be protected from forwarding and
|
||||||
|
// screenshotting
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -574,13 +668,22 @@ func (api *API) RepostStoryWithContext(ctx context.Context, params RepostStory)
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#editstory
|
// See https://core.telegram.org/bots/api#editstory
|
||||||
type EditStory struct {
|
type EditStory struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// StoryID Required. Unique identifier of the story to edit
|
||||||
StoryID int `json:"story_id"`
|
StoryID int `json:"story_id"`
|
||||||
|
// Content Required. Content of the story
|
||||||
Content InputStoryContent `json:"content"`
|
Content InputStoryContent `json:"content"`
|
||||||
|
|
||||||
|
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the story caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||||
Areas []StoryArea `json:"areas,omitempty"`
|
Areas []StoryArea `json:"areas,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -606,7 +709,9 @@ func (api *API) EditStoryWithContext(ctx context.Context, params EditStory) (Sto
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#deletestory
|
// See https://core.telegram.org/bots/api#deletestory
|
||||||
type DeleteStory struct {
|
type DeleteStory struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// StoryID Required. Unique identifier of the story to delete
|
||||||
StoryID int `json:"story_id"`
|
StoryID int `json:"story_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,11 @@ package tgapi
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businessintro
|
// See https://core.telegram.org/bots/api#businessintro
|
||||||
type BusinessIntro struct {
|
type BusinessIntro struct {
|
||||||
|
// Title Optional. Title text of the business intro
|
||||||
Title string `json:"title,omitempty"`
|
Title string `json:"title,omitempty"`
|
||||||
|
// Message Optional. Message text of the business intro
|
||||||
Message string `json:"message,omitempty"`
|
Message string `json:"message,omitempty"`
|
||||||
|
// Sticker Optional. Sticker of the business intro
|
||||||
Sticker *Sticker `json:"sticker,omitempty"`
|
Sticker *Sticker `json:"sticker,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -13,7 +16,9 @@ type BusinessIntro struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businesslocation
|
// See https://core.telegram.org/bots/api#businesslocation
|
||||||
type BusinessLocation struct {
|
type BusinessLocation struct {
|
||||||
|
// Address Address of the business
|
||||||
Address string `json:"address"`
|
Address string `json:"address"`
|
||||||
|
// Location Optional. Location of the business
|
||||||
Location *Location `json:"location,omitempty"`
|
Location *Location `json:"location,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -21,7 +26,11 @@ type BusinessLocation struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
||||||
type BusinessOpeningHoursInterval struct {
|
type BusinessOpeningHoursInterval struct {
|
||||||
|
// OpeningMinute The minute's sequence number in a week, starting on Monday, marking the start of the time
|
||||||
|
// interval during which the business is open; 0 - 7 * 24 * 60
|
||||||
OpeningMinute int `json:"opening_minute"`
|
OpeningMinute int `json:"opening_minute"`
|
||||||
|
// ClosingMinute The minute's sequence number in a week, starting on Monday, marking the end of the time
|
||||||
|
// interval during which the business is open; 0 - 8 * 24 * 60
|
||||||
ClosingMinute int `json:"closing_minute"`
|
ClosingMinute int `json:"closing_minute"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -29,7 +38,9 @@ type BusinessOpeningHoursInterval struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businessopeninghours
|
// See https://core.telegram.org/bots/api#businessopeninghours
|
||||||
type BusinessOpeningHours struct {
|
type BusinessOpeningHours struct {
|
||||||
|
// TimeZoneName Unique name of the time zone for which the opening hours are defined
|
||||||
TimeZoneName string `json:"time_zone_name"`
|
TimeZoneName string `json:"time_zone_name"`
|
||||||
|
// OpeningHours List of time intervals describing business opening hours
|
||||||
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -38,19 +49,40 @@ type BusinessOpeningHours struct {
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#businessbotrights
|
// See https://core.telegram.org/bots/api#businessbotrights
|
||||||
type BusinessBotRights struct {
|
type BusinessBotRights struct {
|
||||||
|
// CanReply Optional. True, if the bot can send and edit messages in the private chats that had incoming
|
||||||
|
// messages in the last 24 hours
|
||||||
CanReply *bool `json:"can_reply,omitempty"`
|
CanReply *bool `json:"can_reply,omitempty"`
|
||||||
|
// CanReadMessages Optional. True, if the bot can mark incoming private messages as read
|
||||||
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
||||||
|
// CanDeleteSentMessages Optional. True, if the bot can delete messages sent by the bot
|
||||||
CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
|
CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
|
||||||
|
// CanDeleteAllMessages Optional. True, if the bot can delete all private messages in managed chats
|
||||||
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
|
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
|
||||||
|
// CanEditName Optional. True, if the bot can edit the first and last name of the business account
|
||||||
CanEditName *bool `json:"can_edit_name,omitempty"`
|
CanEditName *bool `json:"can_edit_name,omitempty"`
|
||||||
|
// CanEditBio Optional. True, if the bot can edit the bio of the business account
|
||||||
CanEditBio *bool `json:"can_edit_bio,omitempty"`
|
CanEditBio *bool `json:"can_edit_bio,omitempty"`
|
||||||
|
// CanEditProfilePhoto Optional. True, if the bot can edit the profile photo of the business account
|
||||||
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
|
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
|
||||||
|
// CanEditUsername Optional. True, if the bot can edit the username of the business account
|
||||||
CanEditUsername *bool `json:"can_edit_username,omitempty"`
|
CanEditUsername *bool `json:"can_edit_username,omitempty"`
|
||||||
|
// CanChangeGiftSettings Optional. True, if the bot can change the privacy settings pertaining to gifts for
|
||||||
|
// the business account
|
||||||
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
|
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
|
||||||
|
// CanViewGiftsAndStars Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by
|
||||||
|
// the business account
|
||||||
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
|
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
|
||||||
|
// CanConvertGiftsToStars Optional. True, if the bot can convert regular gifts owned by the business account
|
||||||
|
// to Telegram Stars
|
||||||
CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
|
CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
|
||||||
|
// CanTransferAndUpgradeGifts Optional. True, if the bot can transfer and upgrade gifts owned by the
|
||||||
|
// business account
|
||||||
CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
|
CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
|
||||||
|
// CanTransferStars Optional. True, if the bot can transfer Telegram Stars received by the business account
|
||||||
|
// to its own account, or use them to upgrade and transfer gifts
|
||||||
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||||
|
// CanManageStories Optional. True, if the bot can post, edit and delete stories on behalf of the business
|
||||||
|
// account
|
||||||
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,11 +90,20 @@ type BusinessBotRights struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businessconnection
|
// See https://core.telegram.org/bots/api#businessconnection
|
||||||
type BusinessConnection struct {
|
type BusinessConnection struct {
|
||||||
|
// ID Unique identifier of the business connection
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// User Business account user that created the business connection
|
||||||
User User `json:"user"`
|
User User `json:"user"`
|
||||||
|
// UserChatID Identifier of a private chat with the user who created the business connection. This number
|
||||||
|
// may have more than 32 significant bits and some programming languages may have difficulty/silent defects
|
||||||
|
// in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float
|
||||||
|
// type are safe for storing this identifier.
|
||||||
UserChatID int64 `json:"user_chat_id"`
|
UserChatID int64 `json:"user_chat_id"`
|
||||||
|
// Date Date the connection was established in Unix time
|
||||||
Date int `json:"date"`
|
Date int `json:"date"`
|
||||||
|
// Rights Optional. Rights of the business bot
|
||||||
Rights *BusinessBotRights `json:"rights,omitempty"`
|
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||||
|
// IsEnabled True, if the connection is active
|
||||||
IsEnabled bool `json:"is_enabled"`
|
IsEnabled bool `json:"is_enabled"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,8 +111,12 @@ type BusinessConnection struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#businessmessagesdeleted
|
// See https://core.telegram.org/bots/api#businessmessagesdeleted
|
||||||
type BusinessMessagesDeleted struct {
|
type BusinessMessagesDeleted struct {
|
||||||
|
// BusinessConnectionID Unique identifier of the business connection
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// Chat Information about a chat in the business account. The bot may not have access to the chat or the
|
||||||
|
// corresponding user.
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// MessageIDs The list of identifiers of deleted messages in the chat of the business account
|
||||||
MessageIDs []int `json:"message_ids"`
|
MessageIDs []int `json:"message_ids"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -89,6 +134,7 @@ const (
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#inputstorycontent
|
// See https://core.telegram.org/bots/api#inputstorycontent
|
||||||
type InputStoryContent struct {
|
type InputStoryContent struct {
|
||||||
|
// Type identifies the photo or video story-content variant.
|
||||||
Type InputStoryContentType `json:"type"`
|
Type InputStoryContentType `json:"type"`
|
||||||
|
|
||||||
// Photo fields
|
// Photo fields
|
||||||
@@ -96,8 +142,12 @@ type InputStoryContent struct {
|
|||||||
|
|
||||||
// Video fields
|
// Video fields
|
||||||
Video *string `json:"video,omitempty"`
|
Video *string `json:"video,omitempty"`
|
||||||
|
// Duration Optional. Precise duration of the video in seconds; 0-60
|
||||||
Duration *float64 `json:"duration,omitempty"`
|
Duration *float64 `json:"duration,omitempty"`
|
||||||
|
// CoverFrameTimestamp Optional. Timestamp in seconds of the frame that will be used as the static cover for
|
||||||
|
// the story. Defaults to 0.0.
|
||||||
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
|
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
|
||||||
|
// IsAnimation Optional. Pass True if the video has no sound
|
||||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,11 +155,17 @@ type InputStoryContent struct {
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#storyareaposition
|
// See https://core.telegram.org/bots/api#storyareaposition
|
||||||
type StoryAreaPosition struct {
|
type StoryAreaPosition struct {
|
||||||
|
// XPercentage The abscissa of the area's center, as a percentage of the media width
|
||||||
XPercentage float64 `json:"x_percentage"`
|
XPercentage float64 `json:"x_percentage"`
|
||||||
|
// YPercentage The ordinate of the area's center, as a percentage of the media height
|
||||||
YPercentage float64 `json:"y_percentage"`
|
YPercentage float64 `json:"y_percentage"`
|
||||||
|
// WidthPercentage The width of the area's rectangle, as a percentage of the media width
|
||||||
WidthPercentage float64 `json:"width_percentage"`
|
WidthPercentage float64 `json:"width_percentage"`
|
||||||
|
// HeightPercentage The height of the area's rectangle, as a percentage of the media height
|
||||||
HeightPercentage float64 `json:"height_percentage"`
|
HeightPercentage float64 `json:"height_percentage"`
|
||||||
|
// RotationAngle The clockwise rotation angle of the rectangle, in degrees; 0-360
|
||||||
RotationAngle float64 `json:"rotation_angle"`
|
RotationAngle float64 `json:"rotation_angle"`
|
||||||
|
// CornerRadiusPercentage The radius of the rectangle corner rounding, as a percentage of the media width
|
||||||
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
|
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -133,26 +189,38 @@ const (
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#storyareatype
|
// See https://core.telegram.org/bots/api#storyareatype
|
||||||
type StoryAreaType struct {
|
type StoryAreaType struct {
|
||||||
|
// Type identifies the concrete story-area variant.
|
||||||
Type StoryAreaTypeType `json:"type"`
|
Type StoryAreaTypeType `json:"type"`
|
||||||
|
|
||||||
|
// Latitude Location latitude in degrees
|
||||||
// Location
|
// Location
|
||||||
Latitude *float64 `json:"latitude,omitempty"`
|
Latitude *float64 `json:"latitude,omitempty"`
|
||||||
|
// Longitude Location longitude in degrees
|
||||||
Longitude *float64 `json:"longitude,omitempty"`
|
Longitude *float64 `json:"longitude,omitempty"`
|
||||||
|
// Address Optional. Address of the location
|
||||||
Address *LocationAddress `json:"address,omitempty"`
|
Address *LocationAddress `json:"address,omitempty"`
|
||||||
|
|
||||||
|
// ReactionType Type of the reaction
|
||||||
// Suggested reaction
|
// Suggested reaction
|
||||||
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
||||||
|
// IsDark Optional. Pass True if the reaction area has a dark background
|
||||||
IsDark *bool `json:"is_dark,omitempty"`
|
IsDark *bool `json:"is_dark,omitempty"`
|
||||||
|
// IsFlipped Optional. Pass True if reaction area corner is flipped
|
||||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||||
|
|
||||||
|
// URL HTTP or tg:// URL to be opened when the area is clicked
|
||||||
// Link
|
// Link
|
||||||
URL *string `json:"url,omitempty"`
|
URL *string `json:"url,omitempty"`
|
||||||
|
|
||||||
|
// Temperature Temperature, in degree Celsius
|
||||||
// Weather
|
// Weather
|
||||||
Temperature *float64 `json:"temperature,omitempty"`
|
Temperature *float64 `json:"temperature,omitempty"`
|
||||||
|
// Emoji Emoji representing the weather
|
||||||
Emoji *string `json:"emoji,omitempty"`
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
// BackgroundColor A color of the area background in the ARGB format
|
||||||
BackgroundColor *int `json:"background_color,omitempty"`
|
BackgroundColor *int `json:"background_color,omitempty"`
|
||||||
|
|
||||||
|
// Name Unique name of the gift
|
||||||
// Unique gift
|
// Unique gift
|
||||||
Name *string `json:"name,omitempty"`
|
Name *string `json:"name,omitempty"`
|
||||||
}
|
}
|
||||||
@@ -161,6 +229,8 @@ type StoryAreaType struct {
|
|||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
// See https://core.telegram.org/bots/api#storyarea
|
// See https://core.telegram.org/bots/api#storyarea
|
||||||
type StoryArea struct {
|
type StoryArea struct {
|
||||||
|
// Position Position of the area
|
||||||
Position StoryAreaPosition `json:"position"`
|
Position StoryAreaPosition `json:"position"`
|
||||||
|
// Type Type of the area
|
||||||
Type StoryAreaType `json:"type"`
|
Type StoryAreaType `json:"type"`
|
||||||
}
|
}
|
||||||
|
|||||||
+193
-1
@@ -6,9 +6,18 @@ import "context"
|
|||||||
// Since: Bot API 5.3
|
// Since: Bot API 5.3
|
||||||
// See https://core.telegram.org/bots/api#banchatmember
|
// See https://core.telegram.org/bots/api#banchatmember
|
||||||
type BanChatMember struct {
|
type BanChatMember struct {
|
||||||
|
// ChatID Required. Unique identifier for the target group or username of the target supergroup or channel
|
||||||
|
// in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// UntilDate Optional. Date when the user will be unbanned; Unix time. If user is banned for more than 366
|
||||||
|
// days or less than 30 seconds from the current time they are considered to be banned forever. Applied for
|
||||||
|
// supergroups and channels only.
|
||||||
UntilDate int `json:"until_date,omitempty"`
|
UntilDate int `json:"until_date,omitempty"`
|
||||||
|
// RevokeMessages Optional. Pass True to delete all messages from the chat for the user that is being
|
||||||
|
// removed. If False, the user will be able to see messages in the group that were sent before the user was
|
||||||
|
// removed. Always True for supergroups and channels.
|
||||||
RevokeMessages bool `json:"revoke_messages,omitempty"`
|
RevokeMessages bool `json:"revoke_messages,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -34,8 +43,12 @@ func (api *API) BanChatMemberWithContext(ctx context.Context, params BanChatMemb
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#unbanchatmember
|
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||||
type UnbanChatMember struct {
|
type UnbanChatMember struct {
|
||||||
|
// ChatID Required. Unique identifier for the target group or username of the target supergroup or channel
|
||||||
|
// in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// OnlyIfBanned Optional. Do nothing if the user is not banned
|
||||||
OnlyIfBanned bool `json:"only_if_banned"`
|
OnlyIfBanned bool `json:"only_if_banned"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,10 +74,22 @@ func (api *API) UnbanChatMemberWithContext(ctx context.Context, params UnbanChat
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#restrictchatmember
|
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||||
type RestrictChatMember struct {
|
type RestrictChatMember struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Permissions Required. A JSON-serialized object for new user permissions
|
||||||
Permissions ChatPermissions `json:"permissions"`
|
Permissions ChatPermissions `json:"permissions"`
|
||||||
|
// UseIndependentChatPermissions Optional. Pass True if chat permissions are set independently. Otherwise,
|
||||||
|
// the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
|
||||||
|
// can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
|
||||||
|
// can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages
|
||||||
|
// permission.
|
||||||
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||||
|
// UntilDate Optional. Date when restrictions will be lifted for the user; Unix time. If user is restricted
|
||||||
|
// for more than 366 days or less than 30 seconds from the current time, they are considered to be
|
||||||
|
// restricted forever.
|
||||||
UntilDate int `json:"until_date,omitempty"`
|
UntilDate int `json:"until_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,25 +115,57 @@ func (api *API) RestrictChatMemberWithContext(ctx context.Context, params Restri
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#promotechatmember
|
// See https://core.telegram.org/bots/api#promotechatmember
|
||||||
type PromoteChatMember struct {
|
type PromoteChatMember struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// IsAnonymous Optional. Pass True if the administrator's presence in the chat is hidden
|
||||||
IsAnonymous bool `json:"is_anonymous,omitempty"` // Since: Bot API 5.1
|
IsAnonymous bool `json:"is_anonymous,omitempty"` // Since: Bot API 5.1
|
||||||
|
|
||||||
|
// CanManageChat Optional. Pass True if the administrator can access the chat event log, get boost list, see
|
||||||
|
// hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the
|
||||||
|
// chat without paying Telegram Stars. Implied by any other administrator privilege.
|
||||||
CanManageChat bool `json:"can_manage_chat,omitempty"` // Since: Bot API 5.3
|
CanManageChat bool `json:"can_manage_chat,omitempty"` // Since: Bot API 5.3
|
||||||
|
// CanDeleteMessages Optional. Pass True if the administrator can delete messages of other users
|
||||||
CanDeleteMessages bool `json:"can_delete_messages,omitempty"`
|
CanDeleteMessages bool `json:"can_delete_messages,omitempty"`
|
||||||
|
// CanManageVideoChats Optional. Pass True if the administrator can manage video chats
|
||||||
CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"` // Since: Bot API 6.0
|
CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"` // Since: Bot API 6.0
|
||||||
|
// CanRestrictMembers Optional. Pass True if the administrator can restrict, ban or unban chat members, or
|
||||||
|
// access supergroup statistics. For backward compatibility, defaults to True for promotions of channel
|
||||||
|
// administrators.
|
||||||
CanRestrictMembers bool `json:"can_restrict_members,omitempty"`
|
CanRestrictMembers bool `json:"can_restrict_members,omitempty"`
|
||||||
|
// CanPromoteMembers Optional. Pass True if the administrator can add new administrators with a subset of
|
||||||
|
// their own privileges or demote administrators that they have promoted, directly or indirectly (promoted
|
||||||
|
// by administrators that were appointed by him)
|
||||||
CanPromoteMembers bool `json:"can_promote_members,omitempty"`
|
CanPromoteMembers bool `json:"can_promote_members,omitempty"`
|
||||||
|
// CanChangeInfo Optional. Pass True if the administrator can change chat title, photo and other settings
|
||||||
CanChangeInfo bool `json:"can_change_info,omitempty"`
|
CanChangeInfo bool `json:"can_change_info,omitempty"`
|
||||||
|
// CanInviteUsers Optional. Pass True if the administrator can invite new users to the chat
|
||||||
CanInviteUsers bool `json:"can_invite_users,omitempty"`
|
CanInviteUsers bool `json:"can_invite_users,omitempty"`
|
||||||
|
// CanPostStories Optional. Pass True if the administrator can post stories to the chat
|
||||||
CanPostStories bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
CanPostStories bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
// CanEditStories Optional. Pass True if the administrator can edit stories posted by other users, post
|
||||||
|
// stories to the chat page, pin chat stories, and access the chat's story archive
|
||||||
CanEditStories bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
CanEditStories bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
// CanDeleteStories Optional. Pass True if the administrator can delete stories posted by other users
|
||||||
CanDeleteStories bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
CanDeleteStories bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
// CanPostMessages Optional. Pass True if the administrator can post messages in the channel, approve
|
||||||
|
// suggested posts, or access channel statistics; for channels only
|
||||||
CanPostMessages bool `json:"can_post_messages,omitempty"`
|
CanPostMessages bool `json:"can_post_messages,omitempty"`
|
||||||
|
// CanEditMessages Optional. Pass True if the administrator can edit messages of other users and can pin
|
||||||
|
// messages; for channels only
|
||||||
CanEditMessages bool `json:"can_edit_messages,omitempty"`
|
CanEditMessages bool `json:"can_edit_messages,omitempty"`
|
||||||
|
// CanPinMessages Optional. Pass True if the administrator can pin messages; for supergroups only
|
||||||
CanPinMessages bool `json:"can_pin_messages,omitempty"`
|
CanPinMessages bool `json:"can_pin_messages,omitempty"`
|
||||||
|
// CanManageTopics Optional. Pass True if the user is allowed to create, rename, close, and reopen forum
|
||||||
|
// topics; for supergroups only
|
||||||
CanManageTopics bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
CanManageTopics bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
||||||
|
// CanManageDirectMessages Optional. Pass True if the administrator can manage direct messages within the
|
||||||
|
// channel and decline suggested posts; for channels only
|
||||||
CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"` // Since: Bot API 9.1
|
CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"` // Since: Bot API 9.1
|
||||||
|
// CanManageTags Optional. Pass True if the administrator can edit the tags of regular members; for groups
|
||||||
|
// and supergroups only
|
||||||
CanManageTags bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
CanManageTags bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,8 +191,12 @@ func (api *API) PromoteChatMemberWithContext(ctx context.Context, params Promote
|
|||||||
// Since: Bot API 5.0
|
// Since: Bot API 5.0
|
||||||
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||||
type SetChatAdministratorCustomTitle struct {
|
type SetChatAdministratorCustomTitle struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// CustomTitle Required. New custom title for the administrator; 0-16 characters, emoji are not allowed
|
||||||
CustomTitle string `json:"custom_title"`
|
CustomTitle string `json:"custom_title"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,8 +222,12 @@ func (api *API) SetChatAdministratorCustomTitleWithContext(ctx context.Context,
|
|||||||
// Since: Bot API 9.5
|
// Since: Bot API 9.5
|
||||||
// See https://core.telegram.org/bots/api#setchatmembertag
|
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||||
type SetChatMemberTag struct {
|
type SetChatMemberTag struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Tag Optional. New tag for the member; 0-16 characters, emoji are not allowed
|
||||||
Tag string `json:"tag,omitempty"`
|
Tag string `json:"tag,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -188,7 +253,10 @@ func (api *API) SetChatMemberTagWithContext(ctx context.Context, params SetChatM
|
|||||||
// Since: Bot API 5.6
|
// Since: Bot API 5.6
|
||||||
// See https://core.telegram.org/bots/api#banchatsenderchat
|
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||||
type BanChatSenderChat struct {
|
type BanChatSenderChat struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// SenderChatID Required. Unique identifier of the target sender chat
|
||||||
SenderChatID int64 `json:"sender_chat_id"`
|
SenderChatID int64 `json:"sender_chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -214,7 +282,10 @@ func (api *API) BanChatSenderChatWithContext(ctx context.Context, params BanChat
|
|||||||
// Since: Bot API 5.6
|
// Since: Bot API 5.6
|
||||||
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||||
type UnbanChatSenderChat struct {
|
type UnbanChatSenderChat struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// SenderChatID Required. Unique identifier of the target sender chat
|
||||||
SenderChatID int64 `json:"sender_chat_id"`
|
SenderChatID int64 `json:"sender_chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -240,8 +311,16 @@ func (api *API) UnbanChatSenderChatWithContext(ctx context.Context, params Unban
|
|||||||
// Since: Bot API 4.4
|
// Since: Bot API 4.4
|
||||||
// See https://core.telegram.org/bots/api#setchatpermissions
|
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||||
type SetChatPermissions struct {
|
type SetChatPermissions struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Permissions Required. A JSON-serialized object for new default chat permissions
|
||||||
Permissions ChatPermissions `json:"permissions"`
|
Permissions ChatPermissions `json:"permissions"`
|
||||||
|
// UseIndependentChatPermissions Optional. Pass True if chat permissions are set independently. Otherwise,
|
||||||
|
// the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
|
||||||
|
// can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
|
||||||
|
// can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages
|
||||||
|
// permission.
|
||||||
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -267,6 +346,8 @@ func (api *API) SetChatPermissionsWithContext(ctx context.Context, params SetCha
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||||
type ExportChatInviteLink struct {
|
type ExportChatInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -292,10 +373,18 @@ func (api *API) ExportChatInviteLinkWithContext(ctx context.Context, params Expo
|
|||||||
// Since: Bot API 5.1
|
// Since: Bot API 5.1
|
||||||
// See https://core.telegram.org/bots/api#createchatinvitelink
|
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||||
type CreateChatInviteLink struct {
|
type CreateChatInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Name Optional. Invite link name; 0-32 characters
|
||||||
Name *string `json:"name,omitempty"`
|
Name *string `json:"name,omitempty"`
|
||||||
|
// ExpireDate Optional. Point in time (Unix timestamp) when the link will expire
|
||||||
ExpireDate int `json:"expire_date,omitempty"`
|
ExpireDate int `json:"expire_date,omitempty"`
|
||||||
|
// MemberLimit Optional. The maximum number of users that can be members of the chat simultaneously after
|
||||||
|
// joining the chat via this invite link; 1-99999
|
||||||
MemberLimit int `json:"member_limit,omitempty"`
|
MemberLimit int `json:"member_limit,omitempty"`
|
||||||
|
// CreatesJoinRequest Optional. True, if users joining the chat via the link need to be approved by chat
|
||||||
|
// administrators. If True, member_limit can't be specified.
|
||||||
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -321,12 +410,21 @@ func (api *API) CreateChatInviteLinkWithContext(ctx context.Context, params Crea
|
|||||||
// Since: Bot API 5.1
|
// Since: Bot API 5.1
|
||||||
// See https://core.telegram.org/bots/api#editchatinvitelink
|
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||||
type EditChatInviteLink struct {
|
type EditChatInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// InviteLink Required. The invite link to edit
|
||||||
InviteLink string `json:"invite_link"`
|
InviteLink string `json:"invite_link"`
|
||||||
|
|
||||||
|
// Name Optional. Invite link name; 0-32 characters
|
||||||
Name string `json:"name,omitempty"`
|
Name string `json:"name,omitempty"`
|
||||||
|
// ExpireDate Optional. Point in time (Unix timestamp) when the link will expire
|
||||||
ExpireDate int `json:"expire_date,omitempty"`
|
ExpireDate int `json:"expire_date,omitempty"`
|
||||||
|
// MemberLimit Optional. The maximum number of users that can be members of the chat simultaneously after
|
||||||
|
// joining the chat via this invite link; 1-99999
|
||||||
MemberLimit int `json:"member_limit,omitempty"`
|
MemberLimit int `json:"member_limit,omitempty"`
|
||||||
|
// CreatesJoinRequest Optional. True, if users joining the chat via the link need to be approved by chat
|
||||||
|
// administrators. If True, member_limit can't be specified.
|
||||||
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -352,9 +450,16 @@ func (api *API) EditChatInviteLinkWithContext(ctx context.Context, params EditCh
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||||
type CreateChatSubscriptionInviteLink struct {
|
type CreateChatSubscriptionInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier for the target channel chat or username of the target channel in the
|
||||||
|
// format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Name Optional. Invite link name; 0-32 characters
|
||||||
Name string `json:"name,omitempty"`
|
Name string `json:"name,omitempty"`
|
||||||
|
// SubscriptionPeriod Required. The number of seconds the subscription will be active for before the next
|
||||||
|
// payment. Currently, it must always be 2592000 (30 days).
|
||||||
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||||
|
// SubscriptionPrice Required. The amount of Telegram Stars a user must pay initially and after each
|
||||||
|
// subsequent subscription period to be a member of the chat; 1-10000
|
||||||
SubscriptionPrice int `json:"subscription_price,omitempty"`
|
SubscriptionPrice int `json:"subscription_price,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -380,8 +485,12 @@ func (api *API) CreateChatSubscriptionInviteLinkWithContext(ctx context.Context,
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||||
type EditChatSubscriptionInviteLink struct {
|
type EditChatSubscriptionInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// InviteLink Required. The invite link to edit
|
||||||
InviteLink string `json:"invite_link"`
|
InviteLink string `json:"invite_link"`
|
||||||
|
// Name Optional. Invite link name; 0-32 characters
|
||||||
Name string `json:"name,omitempty"`
|
Name string `json:"name,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -407,7 +516,10 @@ func (api *API) EditChatSubscriptionInviteLinkWithContext(ctx context.Context, p
|
|||||||
// Since: Bot API 5.1
|
// Since: Bot API 5.1
|
||||||
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||||
type RevokeChatInviteLink struct {
|
type RevokeChatInviteLink struct {
|
||||||
|
// ChatID Required. Unique identifier of the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// InviteLink Required. The invite link to revoke
|
||||||
InviteLink string `json:"invite_link"`
|
InviteLink string `json:"invite_link"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -433,7 +545,10 @@ func (api *API) RevokeChatInviteLinkWithContext(ctx context.Context, params Revo
|
|||||||
// Since: Bot API 5.4
|
// Since: Bot API 5.4
|
||||||
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||||
type ApproveChatJoinRequest struct {
|
type ApproveChatJoinRequest struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -459,7 +574,10 @@ func (api *API) ApproveChatJoinRequestWithContext(ctx context.Context, params Ap
|
|||||||
// Since: Bot API 5.4
|
// Since: Bot API 5.4
|
||||||
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||||
type DeclineChatJoinRequest struct {
|
type DeclineChatJoinRequest struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -556,6 +674,8 @@ func (api *API) SendChatJoinRequestWebAppWithContext(ctx context.Context, params
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#setchatphoto
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
type SetChatPhoto struct {
|
type SetChatPhoto struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -565,18 +685,29 @@ type SetChatPhoto struct {
|
|||||||
// Returns True on success.
|
// Returns True on success.
|
||||||
// See https://core.telegram.org/bots/api#setchatphoto
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
func (api *API) SetChatPhoto(params SetChatPhoto, photo UploaderFile) (bool, error) {
|
func (api *API) SetChatPhoto(params SetChatPhoto, photo UploaderFile) (bool, error) {
|
||||||
|
return api.SetChatPhotoWithContext(context.Background(), params, photo)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPhotoWithContext changes the chat photo using ctx for cancellation and deadlines.
|
||||||
|
// Since: Bot API 3.1
|
||||||
|
// photo is the file to upload as the new photo.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
func (api *API) SetChatPhotoWithContext(ctx context.Context, params SetChatPhoto, photo UploaderFile) (bool, error) {
|
||||||
uploader := NewUploader(api)
|
uploader := NewUploader(api)
|
||||||
defer func() {
|
defer func() {
|
||||||
_ = uploader.Close()
|
_ = uploader.Close()
|
||||||
}()
|
}()
|
||||||
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo.SetType(UploaderPhotoType))
|
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo.SetType(UploaderPhotoType))
|
||||||
return req.Do(uploader)
|
return req.DoWithContext(ctx, uploader)
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeleteChatPhoto holds parameters for the deleteChatPhoto method.
|
// DeleteChatPhoto holds parameters for the deleteChatPhoto method.
|
||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#deletechatphoto
|
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||||
type DeleteChatPhoto struct {
|
type DeleteChatPhoto struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -602,7 +733,10 @@ func (api *API) DeleteChatPhotoWithContext(ctx context.Context, params DeleteCha
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#setchattitle
|
// See https://core.telegram.org/bots/api#setchattitle
|
||||||
type SetChatTitle struct {
|
type SetChatTitle struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Title Required. New chat title, 1-128 characters
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -628,7 +762,10 @@ func (api *API) SetChatTitleWithContext(ctx context.Context, params SetChatTitle
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#setchatdescription
|
// See https://core.telegram.org/bots/api#setchatdescription
|
||||||
type SetChatDescription struct {
|
type SetChatDescription struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Description Optional. New chat description, 0-255 characters
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -654,9 +791,16 @@ func (api *API) SetChatDescriptionWithContext(ctx context.Context, params SetCha
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#pinchatmessage
|
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||||
type PinChatMessage struct {
|
type PinChatMessage struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be pinned
|
||||||
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of a message to pin
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// DisableNotification Optional. Pass True if it is not necessary to send a notification to all chat members
|
||||||
|
// about the new pinned message. Notifications are always disabled in channels and private chats.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -682,8 +826,14 @@ func (api *API) PinChatMessageWithContext(ctx context.Context, params PinChatMes
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#unpinchatmessage
|
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||||
type UnpinChatMessage struct {
|
type UnpinChatMessage struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be unpinned
|
||||||
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Optional. Identifier of the message to unpin. Required if business_connection_id is specified.
|
||||||
|
// If not specified, the most recent pinned message (by sending date) will be unpinned.
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -709,6 +859,8 @@ func (api *API) UnpinChatMessageWithContext(ctx context.Context, params UnpinCha
|
|||||||
// Since: Bot API 5.0
|
// Since: Bot API 5.0
|
||||||
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||||
type UnpinAllChatMessages struct {
|
type UnpinAllChatMessages struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -734,6 +886,9 @@ func (api *API) UnpinAllChatMessagesWithContext(ctx context.Context, params Unpi
|
|||||||
// Since: Bot API 2.1
|
// Since: Bot API 2.1
|
||||||
// See https://core.telegram.org/bots/api#leavechat
|
// See https://core.telegram.org/bots/api#leavechat
|
||||||
type LeaveChat struct {
|
type LeaveChat struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup or channel in
|
||||||
|
// the format @username. Channel direct messages chats aren't supported; leave the corresponding channel
|
||||||
|
// instead.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -759,6 +914,8 @@ func (api *API) LeaveChatWithContext(ctx context.Context, params LeaveChat) (boo
|
|||||||
// Since: Bot API 2.1
|
// Since: Bot API 2.1
|
||||||
// See https://core.telegram.org/bots/api#getchat
|
// See https://core.telegram.org/bots/api#getchat
|
||||||
type GetChat struct {
|
type GetChat struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup or channel in
|
||||||
|
// the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -783,7 +940,11 @@ func (api *API) GetChatWithContext(ctx context.Context, params GetChat) (ChatFul
|
|||||||
// Since: Bot API 2.1
|
// Since: Bot API 2.1
|
||||||
// See https://core.telegram.org/bots/api#getchatadministrators
|
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||||
type GetChatAdministrators struct {
|
type GetChatAdministrators struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup or channel in
|
||||||
|
// the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// ReturnBots Optional. Pass True to additionally receive all bots that are administrators of the chat. By
|
||||||
|
// default, bots other than the current bot are omitted.
|
||||||
ReturnBots bool `json:"return_bots,omitempty"` // Since: Bot API 10.0
|
ReturnBots bool `json:"return_bots,omitempty"` // Since: Bot API 10.0
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -808,6 +969,8 @@ func (api *API) GetChatAdministratorsWithContext(ctx context.Context, params Get
|
|||||||
// Since: Bot API 2.1
|
// Since: Bot API 2.1
|
||||||
// See https://core.telegram.org/bots/api#getchatmembercount
|
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||||
type GetChatMemberCount struct {
|
type GetChatMemberCount struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup or channel in
|
||||||
|
// the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -832,7 +995,10 @@ func (api *API) GetChatMemberCountWithContext(ctx context.Context, params GetCha
|
|||||||
// Since: Bot API 2.1
|
// Since: Bot API 2.1
|
||||||
// See https://core.telegram.org/bots/api#getchatmember
|
// See https://core.telegram.org/bots/api#getchatmember
|
||||||
type GetChatMember struct {
|
type GetChatMember struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup or channel in
|
||||||
|
// the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -857,7 +1023,10 @@ func (api *API) GetChatMemberWithContext(ctx context.Context, params GetChatMemb
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#setchatstickerset
|
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||||
type SetChatStickerSet struct {
|
type SetChatStickerSet struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// StickerSetName Required. Name of the sticker set to be set as the group sticker set
|
||||||
StickerSetName string `json:"sticker_set_name"`
|
StickerSetName string `json:"sticker_set_name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -883,6 +1052,8 @@ func (api *API) SetChatStickerSetWithContext(ctx context.Context, params SetChat
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#deletechatstickerset
|
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||||
type DeleteChatStickerSet struct {
|
type DeleteChatStickerSet struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -908,7 +1079,9 @@ func (api *API) DeleteChatStickerSetWithContext(ctx context.Context, params Dele
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#getuserchatboosts
|
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||||
type GetUserChatBoosts struct {
|
type GetUserChatBoosts struct {
|
||||||
|
// ChatID Required. Unique identifier for the chat or username of the channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -933,16 +1106,35 @@ func (api *API) GetUserChatBoostsWithContext(ctx context.Context, params GetUser
|
|||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
// See https://core.telegram.org/bots/api#getchatgifts
|
// See https://core.telegram.org/bots/api#getchatgifts
|
||||||
type GetChatGifts struct {
|
type GetChatGifts struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// ExcludeUnsaved Optional. Pass True to exclude gifts that aren't saved to the chat's profile page. Always
|
||||||
|
// True, unless the bot has the can_post_messages administrator right in the channel.
|
||||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||||
|
// ExcludeSaved Optional. Pass True to exclude gifts that are saved to the chat's profile page. Always
|
||||||
|
// False, unless the bot has the can_post_messages administrator right in the channel.
|
||||||
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||||
|
// ExcludeUnlimited Optional. Pass True to exclude gifts that can be purchased an unlimited number of times
|
||||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
// ExcludeLimitedUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number of
|
||||||
|
// times and can be upgraded to unique
|
||||||
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
// ExcludeLimitedNonUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number
|
||||||
|
// of times and can't be upgraded to unique
|
||||||
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
// ExcludeUnique Optional. Pass True to exclude unique gifts
|
||||||
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
// ExcludeFromBlockchain Optional. Pass True to exclude gifts that were assigned from the TON blockchain and
|
||||||
|
// can't be resold or transferred in Telegram
|
||||||
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
// SortByPrice Optional. Pass True to sort results by gift price instead of send date. Sorting is applied
|
||||||
|
// before pagination.
|
||||||
SortByPrice bool `json:"sort_by_price,omitempty"`
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
// Offset Optional. Offset of the first entry to return as received from the previous request; use an empty
|
||||||
|
// string to get the first chunk of results
|
||||||
Offset string `json:"offset,omitempty"`
|
Offset string `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. The maximum number of gifts to be returned; 1-100. Defaults to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+239
-1
@@ -4,13 +4,24 @@ package tgapi
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#chat
|
// See https://core.telegram.org/bots/api#chat
|
||||||
type Chat struct {
|
type Chat struct {
|
||||||
|
// ID Unique identifier for this chat. This number may have more than 32 significant bits and some
|
||||||
|
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
|
||||||
|
// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
|
||||||
|
// identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
|
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||||
Type ChatType `json:"type"`
|
Type ChatType `json:"type"`
|
||||||
|
// Title Optional. Title, for supergroups, channels and group chats
|
||||||
Title *string `json:"title,omitempty"`
|
Title *string `json:"title,omitempty"`
|
||||||
|
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||||
Username *string `json:"username,omitempty"`
|
Username *string `json:"username,omitempty"`
|
||||||
|
// FirstName Optional. First name of the other party in a private chat
|
||||||
FirstName *string `json:"first_name,omitempty"`
|
FirstName *string `json:"first_name,omitempty"`
|
||||||
|
// LastName Optional. Last name of the other party in a private chat
|
||||||
LastName *string `json:"last_name,omitempty"`
|
LastName *string `json:"last_name,omitempty"`
|
||||||
|
// IsForum Optional. True, if the supergroup chat is a forum (has topics enabled)
|
||||||
IsForum *bool `json:"is_forum,omitempty"` // Since: Bot API 6.3
|
IsForum *bool `json:"is_forum,omitempty"` // Since: Bot API 6.3
|
||||||
|
// IsDirectMessages Optional. True, if the chat is the direct messages chat of a channel
|
||||||
IsDirectMessages *bool `json:"is_direct_messages,omitempty"` // Since: Bot API 9.2
|
IsDirectMessages *bool `json:"is_direct_messages,omitempty"` // Since: Bot API 9.2
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,64 +43,145 @@ const (
|
|||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
// See https://core.telegram.org/bots/api#chatfullinfo
|
// See https://core.telegram.org/bots/api#chatfullinfo
|
||||||
type ChatFullInfo struct {
|
type ChatFullInfo struct {
|
||||||
|
// ID Unique identifier for this chat. This number may have more than 32 significant bits and some
|
||||||
|
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
|
||||||
|
// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
|
||||||
|
// identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
|
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||||
Type ChatType `json:"type"`
|
Type ChatType `json:"type"`
|
||||||
|
// Title Optional. Title, for supergroups, channels and group chats
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||||
Username string `json:"username"`
|
Username string `json:"username"`
|
||||||
|
// FirstName Optional. First name of the other party in a private chat
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
|
// LastName Optional. Last name of the other party in a private chat
|
||||||
LastName string `json:"last_name"`
|
LastName string `json:"last_name"`
|
||||||
|
// IsForum Optional. True, if the supergroup chat is a forum (has topics enabled)
|
||||||
IsForum bool `json:"is_forum"`
|
IsForum bool `json:"is_forum"`
|
||||||
|
// IsDirectMessages Optional. True, if the chat is the direct messages chat of a channel
|
||||||
IsDirectMessages bool `json:"is_direct_messages"`
|
IsDirectMessages bool `json:"is_direct_messages"`
|
||||||
|
// AccentColorID Identifier of the accent color for the chat name and backgrounds of the chat photo, reply
|
||||||
|
// header, and link preview. See accent colors for more details.
|
||||||
AccentColorID int `json:"accent_color_id"`
|
AccentColorID int `json:"accent_color_id"`
|
||||||
|
// MaxReactionCount The maximum number of reactions that can be set on a message in the chat
|
||||||
MaxReactionCount int `json:"max_reaction_count"`
|
MaxReactionCount int `json:"max_reaction_count"`
|
||||||
|
// Photo Optional. Chat photo
|
||||||
Photo *ChatPhoto `json:"photo,omitempty"`
|
Photo *ChatPhoto `json:"photo,omitempty"`
|
||||||
|
// ActiveUsernames Optional. If non-empty, the list of all active chat usernames; for private chats,
|
||||||
|
// supergroups and channels
|
||||||
ActiveUsernames []string `json:"active_usernames,omitempty"`
|
ActiveUsernames []string `json:"active_usernames,omitempty"`
|
||||||
|
// Birthdate Optional. For private chats, the date of birth of the user
|
||||||
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
||||||
|
|
||||||
|
// BusinessIntro Optional. For private chats with business accounts, the intro of the business
|
||||||
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
||||||
|
// BusinessLocation Optional. For private chats with business accounts, the location of the business
|
||||||
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
||||||
|
// BusinessOpeningHours Optional. For private chats with business accounts, the opening hours of the
|
||||||
|
// business
|
||||||
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
|
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
|
||||||
|
|
||||||
|
// PersonalChat Optional. For private chats, the personal channel of the user
|
||||||
PersonalChat *Chat `json:"personal_chat,omitempty"`
|
PersonalChat *Chat `json:"personal_chat,omitempty"`
|
||||||
|
// ParentChat Optional. Information about the corresponding channel chat; for direct messages chats only
|
||||||
ParentChat *Chat `json:"parent_chat,omitempty"` // Since: Bot API 9.2
|
ParentChat *Chat `json:"parent_chat,omitempty"` // Since: Bot API 9.2
|
||||||
|
|
||||||
AvailableReaction []ReactionType `json:"available_reaction,omitempty"`
|
// AvailableReaction Optional. List of available reactions allowed in the chat. If omitted, then all emoji
|
||||||
|
// reactions are allowed.
|
||||||
|
// Subject to change in v2: the Go field name may be pluralized to AvailableReactions.
|
||||||
|
AvailableReaction []ReactionType `json:"available_reactions,omitempty"`
|
||||||
|
|
||||||
|
// BackgroundCustomEmojiID Optional. Custom emoji identifier of the emoji chosen by the chat for the reply
|
||||||
|
// header and link preview background
|
||||||
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
||||||
|
// ProfileAccentColorID Optional. Identifier of the accent color for the chat's profile background. See
|
||||||
|
// profile accent colors for more details.
|
||||||
ProfileAccentColorID *int `json:"profile_accent_color_id,omitempty"`
|
ProfileAccentColorID *int `json:"profile_accent_color_id,omitempty"`
|
||||||
|
// ProfileBackgroundCustomEmojiID Optional. Custom emoji identifier of the emoji chosen by the chat for its
|
||||||
|
// profile background
|
||||||
ProfileBackgroundCustomEmojiID *string `json:"profile_background_custom_emoji_id,omitempty"`
|
ProfileBackgroundCustomEmojiID *string `json:"profile_background_custom_emoji_id,omitempty"`
|
||||||
|
// EmojiStatusCustomEmojiID Optional. Custom emoji identifier of the emoji status of the chat or the other
|
||||||
|
// party in a private chat
|
||||||
EmojiStatusCustomEmojiID *string `json:"emoji_status_custom_emoji_id,omitempty"`
|
EmojiStatusCustomEmojiID *string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||||
|
// EmojiStatusExpirationDate Optional. Expiration date of the emoji status of the chat or the other party in
|
||||||
|
// a private chat, in Unix time, if any
|
||||||
EmojiStatusExpirationDate *int `json:"emoji_status_expiration_date,omitempty"`
|
EmojiStatusExpirationDate *int `json:"emoji_status_expiration_date,omitempty"`
|
||||||
|
|
||||||
|
// Bio Optional. Bio of the other party in a private chat
|
||||||
Bio *string `json:"bio,omitempty"`
|
Bio *string `json:"bio,omitempty"`
|
||||||
|
// HasPrivateForwards Optional. True, if privacy settings of the other party in the private chat allows to
|
||||||
|
// use tg://user?id=<user_id> links only in chats with the user
|
||||||
HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
|
HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
|
||||||
|
// HasRestrictedVoiceAndVideoMessages Optional. True, if the privacy settings of the other party restrict
|
||||||
|
// sending voice and video note messages in the private chat
|
||||||
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
|
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
|
||||||
|
// JoinToSendMessages Optional. True, if users need to join the supergroup before they can send messages
|
||||||
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
|
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
|
||||||
|
// JoinByRequest Optional. True, if all users directly joining the supergroup without using an invite link
|
||||||
|
// need to be approved by supergroup administrators
|
||||||
JoinByRequest *bool `json:"join_by_request,omitempty"`
|
JoinByRequest *bool `json:"join_by_request,omitempty"`
|
||||||
|
|
||||||
|
// Description Optional. Description, for groups, supergroups and channel chats
|
||||||
Description *string `json:"description,omitempty"`
|
Description *string `json:"description,omitempty"`
|
||||||
|
// InviteLink Optional. Primary invite link, for groups, supergroups and channel chats
|
||||||
InviteLink *string `json:"invite_link,omitempty"`
|
InviteLink *string `json:"invite_link,omitempty"`
|
||||||
|
// PinnedMessage Optional. The most recent pinned message (by sending date)
|
||||||
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
||||||
|
// Permissions Optional. Default chat member permissions, for groups and supergroups
|
||||||
Permissions *ChatPermissions `json:"permissions,omitempty"`
|
Permissions *ChatPermissions `json:"permissions,omitempty"`
|
||||||
|
// AcceptedGiftTypes Information about types of gifts that are accepted by the chat or by the corresponding
|
||||||
|
// user for private chats
|
||||||
AcceptedGiftTypes *AcceptedGiftTypes `json:"accepted_gift_types,omitempty"`
|
AcceptedGiftTypes *AcceptedGiftTypes `json:"accepted_gift_types,omitempty"`
|
||||||
|
|
||||||
|
// CanSendPaidMedia Optional. True, if paid media messages can be sent or forwarded to the channel chat. The
|
||||||
|
// field is available only for channel chats.
|
||||||
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
|
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
|
||||||
|
// SlowModeDelay Optional. For supergroups, the minimum allowed delay between consecutive messages sent by
|
||||||
|
// each unprivileged user; in seconds
|
||||||
SlowModeDelay *int `json:"slow_mode_delay,omitempty"`
|
SlowModeDelay *int `json:"slow_mode_delay,omitempty"`
|
||||||
|
// UnrestrictedBoostCount is the number of unrestricted boosts available to the chat.
|
||||||
UnrestrictedBoostCount *int `json:"unrestricted_boost_count,omitempty"`
|
UnrestrictedBoostCount *int `json:"unrestricted_boost_count,omitempty"`
|
||||||
|
// MessageAutoDeleteTime Optional. The time after which all messages sent to the chat will be automatically
|
||||||
|
// deleted; in seconds
|
||||||
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty"`
|
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty"`
|
||||||
|
// HasAggressiveAntiSpamEnabled Optional. True, if aggressive anti-spam checks are enabled in the
|
||||||
|
// supergroup. The field is only available to chat administrators.
|
||||||
HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
|
HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
|
||||||
|
// HasHiddenMembers Optional. True, if non-administrators can only get the list of bots and administrators
|
||||||
|
// in the chat
|
||||||
HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
|
HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
|
||||||
|
// HasProtectedContent Optional. True, if messages from the chat can't be forwarded to other chats
|
||||||
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
|
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
|
||||||
|
// HasVisibleHistory Optional. True, if new chat members will have access to old messages; available only to
|
||||||
|
// chat administrators
|
||||||
HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
|
HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
|
||||||
|
// StickerSetName Optional. For supergroups, name of the group sticker set
|
||||||
StickerSetName *string `json:"sticker_set_name,omitempty"`
|
StickerSetName *string `json:"sticker_set_name,omitempty"`
|
||||||
|
// CanSetStickerSet Optional. True, if the bot can change the group sticker set
|
||||||
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
|
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
|
||||||
|
// CustomEmojiStickerSetName Optional. For supergroups, the name of the group's custom emoji sticker set.
|
||||||
|
// Custom emoji from this set can be used by all users and bots in the group.
|
||||||
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty"`
|
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty"`
|
||||||
|
// LinkedChatID Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a
|
||||||
|
// channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits
|
||||||
|
// and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller
|
||||||
|
// than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this
|
||||||
|
// identifier.
|
||||||
LinkedChatID *int64 `json:"linked_chat_id,omitempty"`
|
LinkedChatID *int64 `json:"linked_chat_id,omitempty"`
|
||||||
|
|
||||||
|
// Location Optional. For supergroups, the location to which the supergroup is connected
|
||||||
Location *ChatLocation `json:"location,omitempty"`
|
Location *ChatLocation `json:"location,omitempty"`
|
||||||
|
// Rating Optional. For private chats, the rating of the user if any
|
||||||
Rating *UserRating `json:"rating,omitempty"`
|
Rating *UserRating `json:"rating,omitempty"`
|
||||||
|
// FirstProfileAudio Optional. For private chats, the first audio added to the profile of the user
|
||||||
FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"` // Since: Bot API 9.4
|
FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"` // Since: Bot API 9.4
|
||||||
|
// UniqueGiftColors Optional. The color scheme based on a unique gift that must be used for the chat's name,
|
||||||
|
// message replies and link previews
|
||||||
UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"` // Since: Bot API 9.3
|
UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"` // Since: Bot API 9.3
|
||||||
|
// PaidMessageStarCount Optional. The number of Telegram Stars a general user has to pay to send a message
|
||||||
|
// to the chat
|
||||||
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` // Since: Bot API 9.3
|
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` // Since: Bot API 9.3
|
||||||
// GuardBot contains the guard bot visible to chat administrators.
|
// GuardBot contains the guard bot visible to chat administrators.
|
||||||
GuardBot *User `json:"guard_bot,omitempty"` // Since: Bot API 10.1; visible to chat administrators only
|
GuardBot *User `json:"guard_bot,omitempty"` // Since: Bot API 10.1; visible to chat administrators only
|
||||||
@@ -101,9 +193,17 @@ type ChatFullInfo struct {
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#chatphoto
|
// See https://core.telegram.org/bots/api#chatphoto
|
||||||
type ChatPhoto struct {
|
type ChatPhoto struct {
|
||||||
|
// SmallFileID File identifier of small (160x160) chat photo. This file_id can be used only for photo
|
||||||
|
// download and only for as long as the photo is not changed.
|
||||||
SmallFileID string `json:"small_file_id"`
|
SmallFileID string `json:"small_file_id"`
|
||||||
|
// SmallFileUniqueID Unique file identifier of small (160x160) chat photo, which is supposed to be the same
|
||||||
|
// over time and for different bots. Can't be used to download or reuse the file.
|
||||||
SmallFileUniqueID string `json:"small_file_unique_id"`
|
SmallFileUniqueID string `json:"small_file_unique_id"`
|
||||||
|
// BigFileID File identifier of big (640x640) chat photo. This file_id can be used only for photo download
|
||||||
|
// and only for as long as the photo is not changed.
|
||||||
BigFileID string `json:"big_file_id"`
|
BigFileID string `json:"big_file_id"`
|
||||||
|
// BigFileUniqueID Unique file identifier of big (640x640) chat photo, which is supposed to be the same over
|
||||||
|
// time and for different bots. Can't be used to download or reuse the file.
|
||||||
BigFileUniqueID string `json:"big_file_unique_id"`
|
BigFileUniqueID string `json:"big_file_unique_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -111,21 +211,43 @@ type ChatPhoto struct {
|
|||||||
// Since: Bot API 4.4
|
// Since: Bot API 4.4
|
||||||
// See https://core.telegram.org/bots/api#chatpermissions
|
// See https://core.telegram.org/bots/api#chatpermissions
|
||||||
type ChatPermissions struct {
|
type ChatPermissions struct {
|
||||||
|
// CanSendMessages Optional. True, if the user is allowed to send text messages, rich messages, contacts,
|
||||||
|
// giveaways, giveaway winners, invoices, locations and venues
|
||||||
CanSendMessages bool `json:"can_send_messages"`
|
CanSendMessages bool `json:"can_send_messages"`
|
||||||
|
// CanSendAudios Optional. True, if the user is allowed to send audios
|
||||||
CanSendAudios bool `json:"can_send_audios"` // Since: Bot API 6.5
|
CanSendAudios bool `json:"can_send_audios"` // Since: Bot API 6.5
|
||||||
|
// CanSendDocuments Optional. True, if the user is allowed to send documents
|
||||||
CanSendDocuments bool `json:"can_send_documents"` // Since: Bot API 6.5
|
CanSendDocuments bool `json:"can_send_documents"` // Since: Bot API 6.5
|
||||||
|
// CanSendPhotos Optional. True, if the user is allowed to send photos
|
||||||
CanSendPhotos bool `json:"can_send_photos"` // Since: Bot API 6.5
|
CanSendPhotos bool `json:"can_send_photos"` // Since: Bot API 6.5
|
||||||
|
// CanSendVideos Optional. True, if the user is allowed to send videos
|
||||||
CanSendVideos bool `json:"can_send_videos"` // Since: Bot API 6.5
|
CanSendVideos bool `json:"can_send_videos"` // Since: Bot API 6.5
|
||||||
|
// CanSendVideoNotes Optional. True, if the user is allowed to send video notes
|
||||||
CanSendVideoNotes bool `json:"can_send_video_notes"` // Since: Bot API 6.5
|
CanSendVideoNotes bool `json:"can_send_video_notes"` // Since: Bot API 6.5
|
||||||
|
// CanSendVoiceNotes Optional. True, if the user is allowed to send voice notes
|
||||||
CanSendVoiceNotes bool `json:"can_send_voice_notes"` // Since: Bot API 6.5
|
CanSendVoiceNotes bool `json:"can_send_voice_notes"` // Since: Bot API 6.5
|
||||||
|
// CanSendPolls Optional. True, if the user is allowed to send polls and checklists
|
||||||
CanSendPolls bool `json:"can_send_polls"`
|
CanSendPolls bool `json:"can_send_polls"`
|
||||||
|
// CanSendOtherMessages Optional. True, if the user is allowed to send animations, games, stickers and use
|
||||||
|
// inline bots
|
||||||
CanSendOtherMessages bool `json:"can_send_other_messages"`
|
CanSendOtherMessages bool `json:"can_send_other_messages"`
|
||||||
|
// CanAddWebPagePreview Optional. True, if the user is allowed to add web page previews to their messages
|
||||||
CanAddWebPagePreview bool `json:"can_add_web_page_previews"`
|
CanAddWebPagePreview bool `json:"can_add_web_page_previews"`
|
||||||
|
// CanReactToMessages Optional. True, if the user is allowed to react to messages. If omitted, defaults to
|
||||||
|
// the value of can_send_messages.
|
||||||
CanReactToMessages bool `json:"can_react_to_messages"` // Since: Bot API 10.0
|
CanReactToMessages bool `json:"can_react_to_messages"` // Since: Bot API 10.0
|
||||||
|
// CanEditTag Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the
|
||||||
|
// value of can_pin_messages.
|
||||||
CanEditTag bool `json:"can_edit_tag"` // Since: Bot API 9.5
|
CanEditTag bool `json:"can_edit_tag"` // Since: Bot API 9.5
|
||||||
|
// CanChangeInfo Optional. True, if the user is allowed to change the chat title, photo and other settings.
|
||||||
|
// Ignored in public supergroups.
|
||||||
CanChangeInfo bool `json:"can_change_info"`
|
CanChangeInfo bool `json:"can_change_info"`
|
||||||
|
// CanInviteUsers Optional. True, if the user is allowed to invite new users to the chat
|
||||||
CanInviteUsers bool `json:"can_invite_users"`
|
CanInviteUsers bool `json:"can_invite_users"`
|
||||||
|
// CanPinMessages Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.
|
||||||
CanPinMessages bool `json:"can_pin_messages"`
|
CanPinMessages bool `json:"can_pin_messages"`
|
||||||
|
// CanManageTopics Optional. True, if the user is allowed to create forum topics. If omitted, defaults to
|
||||||
|
// the value of can_pin_messages.
|
||||||
CanManageTopics bool `json:"can_manage_topics"` // Since: Bot API 6.3
|
CanManageTopics bool `json:"can_manage_topics"` // Since: Bot API 6.3
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -133,7 +255,9 @@ type ChatPermissions struct {
|
|||||||
// Since: Bot API 5.0
|
// Since: Bot API 5.0
|
||||||
// See https://core.telegram.org/bots/api#chatlocation
|
// See https://core.telegram.org/bots/api#chatlocation
|
||||||
type ChatLocation struct {
|
type ChatLocation struct {
|
||||||
|
// Location The location to which the supergroup is connected. Can't be a live location.
|
||||||
Location Location `json:"location"`
|
Location Location `json:"location"`
|
||||||
|
// Address Location address; 1-64 characters, as defined by the chat owner
|
||||||
Address string `json:"address"`
|
Address string `json:"address"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -141,17 +265,32 @@ type ChatLocation struct {
|
|||||||
// Since: Bot API 5.1
|
// Since: Bot API 5.1
|
||||||
// See https://core.telegram.org/bots/api#chatinvitelink
|
// See https://core.telegram.org/bots/api#chatinvitelink
|
||||||
type ChatInviteLink struct {
|
type ChatInviteLink struct {
|
||||||
|
// InviteLink The invite link. If the link was created by another chat administrator, then the second part
|
||||||
|
// of the link will be replaced with “…”.
|
||||||
InviteLink string `json:"invite_link"`
|
InviteLink string `json:"invite_link"`
|
||||||
|
// Creator Creator of the link
|
||||||
Creator User `json:"creator"`
|
Creator User `json:"creator"`
|
||||||
|
// CreateJoinRequest True, if users joining the chat via the link need to be approved by chat administrators
|
||||||
CreateJoinRequest bool `json:"creates_join_request"`
|
CreateJoinRequest bool `json:"creates_join_request"`
|
||||||
|
// IsPrimary True, if the link is primary
|
||||||
IsPrimary bool `json:"is_primary"`
|
IsPrimary bool `json:"is_primary"`
|
||||||
|
// IsRevoked True, if the link is revoked
|
||||||
IsRevoked bool `json:"is_revoked"`
|
IsRevoked bool `json:"is_revoked"`
|
||||||
|
|
||||||
|
// Name Optional. Invite link name
|
||||||
Name *string `json:"name,omitempty"`
|
Name *string `json:"name,omitempty"`
|
||||||
|
// ExpireDate Optional. Point in time (Unix timestamp) when the link will expire or has been expired
|
||||||
ExpireDate *int `json:"expire_date,omitempty"`
|
ExpireDate *int `json:"expire_date,omitempty"`
|
||||||
|
// MemberLimit Optional. The maximum number of users that can be members of the chat simultaneously after
|
||||||
|
// joining the chat via this invite link; 1-99999
|
||||||
MemberLimit *int `json:"member_limit,omitempty"`
|
MemberLimit *int `json:"member_limit,omitempty"`
|
||||||
|
// PendingJoinRequestCount Optional. Number of pending join requests created using this link
|
||||||
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
|
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
|
||||||
|
// SubscriptionPeriod Optional. The number of seconds the subscription will be active for before the next
|
||||||
|
// payment
|
||||||
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
|
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
|
||||||
|
// SubscriptionPrice Optional. The amount of Telegram Stars a user must pay initially and after each
|
||||||
|
// subsequent subscription period to be a member of the chat using the link
|
||||||
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,50 +316,97 @@ const (
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#chatmember
|
// See https://core.telegram.org/bots/api#chatmember
|
||||||
type ChatMember struct {
|
type ChatMember struct {
|
||||||
|
// Status is the member's current status in the chat.
|
||||||
Status ChatMemberStatusType `json:"status"`
|
Status ChatMemberStatusType `json:"status"`
|
||||||
|
// User Information about the user
|
||||||
User User `json:"user"`
|
User User `json:"user"`
|
||||||
|
// Tag Optional. Tag of the member
|
||||||
Tag string `json:"tag,omitempty"` // Since: Bot API 9.5
|
Tag string `json:"tag,omitempty"` // Since: Bot API 9.5
|
||||||
|
|
||||||
|
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||||
// Owner
|
// Owner
|
||||||
IsAnonymous *bool `json:"is_anonymous"`
|
IsAnonymous *bool `json:"is_anonymous"`
|
||||||
|
// CustomTitle Optional. Custom title for this user
|
||||||
CustomTitle *string `json:"custom_title,omitempty"`
|
CustomTitle *string `json:"custom_title,omitempty"`
|
||||||
|
|
||||||
|
// CanBeEdited True, if the bot is allowed to edit administrator privileges of that user
|
||||||
// Administrator
|
// Administrator
|
||||||
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
||||||
|
// CanManageChat True, if the administrator can access the chat event log, get boost list, see hidden
|
||||||
|
// supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat
|
||||||
|
// without paying Telegram Stars. Implied by any other administrator privilege.
|
||||||
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
||||||
|
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||||
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
||||||
|
// CanManageVideoChats True, if the administrator can manage video chats
|
||||||
CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`
|
CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`
|
||||||
|
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||||
|
// supergroup statistics
|
||||||
CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
|
CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
|
||||||
|
// CanPromoteMembers True, if the administrator can add new administrators with a subset of their own
|
||||||
|
// privileges or demote administrators that they have promoted, directly or indirectly (promoted by
|
||||||
|
// administrators that were appointed by the user)
|
||||||
CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
|
CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
|
||||||
|
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||||
CanChangeInfo *bool `json:"can_change_info,omitempty"`
|
CanChangeInfo *bool `json:"can_change_info,omitempty"`
|
||||||
|
// CanInviteUsers True, if the user is allowed to invite new users to the chat
|
||||||
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
|
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
|
||||||
|
// CanPostStories True, if the administrator can post stories to the chat
|
||||||
CanPostStories *bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
CanPostStories *bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
// CanEditStories True, if the administrator can edit stories posted by other users, post stories to the
|
||||||
|
// chat page, pin chat stories, and access the chat's story archive
|
||||||
CanEditStories *bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
CanEditStories *bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||||
CanDeleteStories *bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
CanDeleteStories *bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
||||||
|
|
||||||
|
// CanPostMessages Optional. True, if the administrator can post messages in the channel, approve suggested
|
||||||
|
// posts, or access channel statistics; for channels only
|
||||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||||
|
// CanEditMessages Optional. True, if the administrator can edit messages of other users and can pin
|
||||||
|
// messages; for channels only
|
||||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||||
|
// CanPinMessages reports whether the member may pin messages.
|
||||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||||
|
// CanManageTopics reports whether the member may manage forum topics.
|
||||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
CanManageTopics *bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
||||||
|
// CanManageDirectMessages Optional. True, if the administrator can manage direct messages of the channel
|
||||||
|
// and decline suggested posts; for channels only
|
||||||
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"` // Since: Bot API 9.1
|
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"` // Since: Bot API 9.1
|
||||||
|
// CanManageTags Optional. True, if the administrator can edit the tags of regular members; for groups and
|
||||||
|
// supergroups only. If omitted, defaults to the value of can_pin_messages.
|
||||||
CanManageTags *bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
CanManageTags *bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
||||||
|
|
||||||
|
// UntilDate is the Unix time when restrictions expire; zero means forever.
|
||||||
// Member
|
// Member
|
||||||
UntilDate *int `json:"until_date,omitempty"`
|
UntilDate *int `json:"until_date,omitempty"`
|
||||||
|
|
||||||
|
// IsMember True, if the user is a member of the chat at the moment of the request
|
||||||
// Restricted
|
// Restricted
|
||||||
IsMember *bool `json:"is_member,omitempty"`
|
IsMember *bool `json:"is_member,omitempty"`
|
||||||
|
// CanSendMessages True, if the user is allowed to send text messages, rich messages, contacts, giveaways,
|
||||||
|
// giveaway winners, invoices, locations and venues
|
||||||
CanSendMessages *bool `json:"can_send_messages,omitempty"`
|
CanSendMessages *bool `json:"can_send_messages,omitempty"`
|
||||||
|
// CanSendAudios True, if the user is allowed to send audios
|
||||||
CanSendAudios *bool `json:"can_send_audios,omitempty"` // Since: Bot API 6.5
|
CanSendAudios *bool `json:"can_send_audios,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendDocuments True, if the user is allowed to send documents
|
||||||
CanSendDocuments *bool `json:"can_send_documents,omitempty"` // Since: Bot API 6.5
|
CanSendDocuments *bool `json:"can_send_documents,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendPhotos True, if the user is allowed to send photos
|
||||||
CanSendPhotos *bool `json:"can_send_photos,omitempty"` // Since: Bot API 6.5
|
CanSendPhotos *bool `json:"can_send_photos,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendVideos True, if the user is allowed to send videos
|
||||||
CanSendVideos *bool `json:"can_send_videos,omitempty"` // Since: Bot API 6.5
|
CanSendVideos *bool `json:"can_send_videos,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendVideoNotes True, if the user is allowed to send video notes
|
||||||
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"` // Since: Bot API 6.5
|
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendVoiceNotes True, if the user is allowed to send voice notes
|
||||||
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"` // Since: Bot API 6.5
|
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"` // Since: Bot API 6.5
|
||||||
|
// CanSendPolls True, if the user is allowed to send polls and checklists
|
||||||
CanSendPolls *bool `json:"can_send_polls,omitempty"`
|
CanSendPolls *bool `json:"can_send_polls,omitempty"`
|
||||||
|
// CanSendOtherMessages True, if the user is allowed to send animations, games, stickers and use inline bots
|
||||||
CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
|
CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
|
||||||
|
// CanAddWebPagePreview True, if the user is allowed to add web page previews to their messages
|
||||||
CanAddWebPagePreview *bool `json:"can_add_web_page_previews,omitempty"`
|
CanAddWebPagePreview *bool `json:"can_add_web_page_previews,omitempty"`
|
||||||
|
// CanReactToMessages True, if the user is allowed to react to messages
|
||||||
CanReactToMessages *bool `json:"can_react_to_messages,omitempty"` // Since: Bot API 10.0
|
CanReactToMessages *bool `json:"can_react_to_messages,omitempty"` // Since: Bot API 10.0
|
||||||
|
// CanEditTag True, if the user is allowed to edit their own tag
|
||||||
CanEditTag *bool `json:"can_edit_tag,omitempty"` // Since: Bot API 9.5
|
CanEditTag *bool `json:"can_edit_tag,omitempty"` // Since: Bot API 9.5
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -228,12 +414,19 @@ type ChatMember struct {
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#chatboostsource
|
// See https://core.telegram.org/bots/api#chatboostsource
|
||||||
type ChatBoostSource struct {
|
type ChatBoostSource struct {
|
||||||
|
// Source identifies the source variant: premium, gift_code, or giveaway.
|
||||||
Source string `json:"source"`
|
Source string `json:"source"`
|
||||||
|
// User is the user responsible for the boost when supplied by the source variant.
|
||||||
User User `json:"user"`
|
User User `json:"user"`
|
||||||
|
|
||||||
|
// GiveawayMessageID Identifier of a message in the chat with the giveaway; the message could have been
|
||||||
|
// deleted already. May be 0 if the message isn't sent yet.
|
||||||
// Giveaway
|
// Giveaway
|
||||||
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
||||||
|
// PrizeStarCount Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram
|
||||||
|
// Star giveaways only
|
||||||
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
||||||
|
// IsUnclaimed Optional. True, if the giveaway was completed, but there was no user to win the prize
|
||||||
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -241,9 +434,14 @@ type ChatBoostSource struct {
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#chatboost
|
// See https://core.telegram.org/bots/api#chatboost
|
||||||
type ChatBoost struct {
|
type ChatBoost struct {
|
||||||
|
// BoostID Unique identifier of the boost
|
||||||
BoostID string `json:"boost_id"`
|
BoostID string `json:"boost_id"`
|
||||||
|
// AddDate Point in time (Unix timestamp) when the chat was boosted
|
||||||
AddDate int `json:"add_date"`
|
AddDate int `json:"add_date"`
|
||||||
|
// ExpirationDate Point in time (Unix timestamp) when the boost will automatically expire, unless the
|
||||||
|
// booster's Telegram Premium subscription is prolonged
|
||||||
ExpirationDate int `json:"expiration_date"`
|
ExpirationDate int `json:"expiration_date"`
|
||||||
|
// Source Source of the added boost
|
||||||
Source ChatBoostSource `json:"source"`
|
Source ChatBoostSource `json:"source"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -251,18 +449,21 @@ type ChatBoost struct {
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#userchatboosts
|
// See https://core.telegram.org/bots/api#userchatboosts
|
||||||
type UserChatBoosts struct {
|
type UserChatBoosts struct {
|
||||||
|
// Boosts The list of boosts added to the chat by the user
|
||||||
Boosts []ChatBoost `json:"boosts"`
|
Boosts []ChatBoost `json:"boosts"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChatBoostAdded describes a service message about a user boosting a chat.
|
// ChatBoostAdded describes a service message about a user boosting a chat.
|
||||||
// Since: Bot API 7.1
|
// Since: Bot API 7.1
|
||||||
type ChatBoostAdded struct {
|
type ChatBoostAdded struct {
|
||||||
|
// BoostCount Number of boosts added by the user
|
||||||
BoostCount int `json:"boost_count"`
|
BoostCount int `json:"boost_count"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChatBackground represents a chat background.
|
// ChatBackground represents a chat background.
|
||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
type ChatBackground struct {
|
type ChatBackground struct {
|
||||||
|
// Type Type of the background
|
||||||
Type BackgroundType `json:"type"`
|
Type BackgroundType `json:"type"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -270,6 +471,8 @@ type ChatBackground struct {
|
|||||||
// Since: Bot API 9.4
|
// Since: Bot API 9.4
|
||||||
// See https://core.telegram.org/bots/api#chatownerleft
|
// See https://core.telegram.org/bots/api#chatownerleft
|
||||||
type ChatOwnerLeft struct {
|
type ChatOwnerLeft struct {
|
||||||
|
// NewOwner Optional. The user who will become the new owner of the chat if the previous owner does not
|
||||||
|
// return to the chat
|
||||||
NewOwner *User `json:"new_owner,omitempty"`
|
NewOwner *User `json:"new_owner,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -277,6 +480,7 @@ type ChatOwnerLeft struct {
|
|||||||
// Since: Bot API 9.4
|
// Since: Bot API 9.4
|
||||||
// See https://core.telegram.org/bots/api#chatownerchanged
|
// See https://core.telegram.org/bots/api#chatownerchanged
|
||||||
type ChatOwnerChanged struct {
|
type ChatOwnerChanged struct {
|
||||||
|
// NewOwner The new owner of the chat
|
||||||
NewOwner User `json:"new_owner"`
|
NewOwner User `json:"new_owner"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -284,23 +488,51 @@ type ChatOwnerChanged struct {
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#chatadministratorrights
|
// See https://core.telegram.org/bots/api#chatadministratorrights
|
||||||
type ChatAdministratorRights struct {
|
type ChatAdministratorRights struct {
|
||||||
|
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||||
IsAnonymous bool `json:"is_anonymous"`
|
IsAnonymous bool `json:"is_anonymous"`
|
||||||
|
// CanManageChat True, if the administrator can access the chat event log, get boost list, see hidden
|
||||||
|
// supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat
|
||||||
|
// without paying Telegram Stars. Implied by any other administrator privilege.
|
||||||
CanManageChat bool `json:"can_manage_chat"`
|
CanManageChat bool `json:"can_manage_chat"`
|
||||||
|
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||||
CanDeleteMessages bool `json:"can_delete_messages"`
|
CanDeleteMessages bool `json:"can_delete_messages"`
|
||||||
|
// CanManageVideoChats True, if the administrator can manage video chats
|
||||||
CanManageVideoChats bool `json:"can_manage_video_chats"`
|
CanManageVideoChats bool `json:"can_manage_video_chats"`
|
||||||
|
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||||
|
// supergroup statistics
|
||||||
CanRestrictMembers bool `json:"can_restrict_members"`
|
CanRestrictMembers bool `json:"can_restrict_members"`
|
||||||
|
// CanPromoteMembers True, if the administrator can add new administrators with a subset of their own
|
||||||
|
// privileges or demote administrators that they have promoted, directly or indirectly (promoted by
|
||||||
|
// administrators that were appointed by the user)
|
||||||
CanPromoteMembers bool `json:"can_promote_members"`
|
CanPromoteMembers bool `json:"can_promote_members"`
|
||||||
|
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||||
CanChangeInfo bool `json:"can_change_info"`
|
CanChangeInfo bool `json:"can_change_info"`
|
||||||
|
// CanInviteUsers True, if the user is allowed to invite new users to the chat
|
||||||
CanInviteUsers bool `json:"can_invite_users"`
|
CanInviteUsers bool `json:"can_invite_users"`
|
||||||
|
// CanPostStories True, if the administrator can post stories to the chat
|
||||||
CanPostStories bool `json:"can_post_stories"`
|
CanPostStories bool `json:"can_post_stories"`
|
||||||
|
// CanEditStories True, if the administrator can edit stories posted by other users, post stories to the
|
||||||
|
// chat page, pin chat stories, and access the chat's story archive
|
||||||
CanEditStories bool `json:"can_edit_stories"`
|
CanEditStories bool `json:"can_edit_stories"`
|
||||||
|
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||||
CanDeleteStories bool `json:"can_delete_stories"`
|
CanDeleteStories bool `json:"can_delete_stories"`
|
||||||
|
|
||||||
|
// CanPostMessages Optional. True, if the administrator can post messages in the channel, approve suggested
|
||||||
|
// posts, or access channel statistics; for channels only
|
||||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||||
|
// CanEditMessages Optional. True, if the administrator can edit messages of other users and can pin
|
||||||
|
// messages; for channels only
|
||||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||||
|
// CanPinMessages Optional. True, if the user is allowed to pin messages; for groups and supergroups only
|
||||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||||
|
// CanManageTopics Optional. True, if the user is allowed to create, rename, close, and reopen forum topics;
|
||||||
|
// for supergroups only
|
||||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
||||||
|
// CanManageDirectMessages Optional. True, if the administrator can manage direct messages of the channel
|
||||||
|
// and decline suggested posts; for channels only
|
||||||
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
|
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
|
||||||
|
// CanManageTags Optional. True, if the administrator can edit the tags of regular members; for groups and
|
||||||
|
// supergroups only. If omitted, defaults to the value of can_pin_messages.
|
||||||
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -308,7 +540,9 @@ type ChatAdministratorRights struct {
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#chatboostupdated
|
// See https://core.telegram.org/bots/api#chatboostupdated
|
||||||
type ChatBoostUpdated struct {
|
type ChatBoostUpdated struct {
|
||||||
|
// Chat Chat which was boosted
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// Boost Information about the chat boost
|
||||||
Boost ChatBoost `json:"boost"`
|
Boost ChatBoost `json:"boost"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -316,9 +550,13 @@ type ChatBoostUpdated struct {
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#chatboostremoved
|
// See https://core.telegram.org/bots/api#chatboostremoved
|
||||||
type ChatBoostRemoved struct {
|
type ChatBoostRemoved struct {
|
||||||
|
// Chat Chat which was boosted
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// BoostID Unique identifier of the boost
|
||||||
BoostID string `json:"boost_id"`
|
BoostID string `json:"boost_id"`
|
||||||
|
// RemoveDate Point in time (Unix timestamp) when the boost was removed
|
||||||
RemoveDate int `json:"remove_date"`
|
RemoveDate int `json:"remove_date"`
|
||||||
|
// Source Source of the removed boost
|
||||||
Source ChatBoostSource `json:"source"`
|
Source ChatBoostSource `json:"source"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,24 @@ var ErrPoolQueueFull = errors.New("worker pool queue full")
|
|||||||
// ErrPoolStopped reports that a request was submitted after the worker pool stopped.
|
// ErrPoolStopped reports that a request was submitted after the worker pool stopped.
|
||||||
var ErrPoolStopped = errors.New("worker pool stopped")
|
var ErrPoolStopped = errors.New("worker pool stopped")
|
||||||
|
|
||||||
|
// ErrPoolWorkerPanic reports a panic recovered while executing a worker-pool request.
|
||||||
|
var ErrPoolWorkerPanic = errors.New("worker pool request panicked")
|
||||||
|
|
||||||
|
// ErrResponseTooLarge reports a Telegram API response larger than the safety limit.
|
||||||
|
var ErrResponseTooLarge = errors.New("telegram API response is too large")
|
||||||
|
|
||||||
|
// ErrFileTooLarge reports a file download that exceeds the caller's limit.
|
||||||
|
var ErrFileTooLarge = errors.New("telegram file exceeds size limit")
|
||||||
|
|
||||||
|
// ErrRichJSONDepth reports a rich-message JSON tree deeper than the decoder limit.
|
||||||
|
var ErrRichJSONDepth = errors.New("rich-message JSON exceeds depth limit")
|
||||||
|
|
||||||
|
// ErrRichJSONNodes reports a rich-message JSON tree larger than the decoder limit.
|
||||||
|
var ErrRichJSONNodes = errors.New("rich-message JSON exceeds node limit")
|
||||||
|
|
||||||
|
// ErrRetryLimit reports that a request exhausted its configured 429 retries.
|
||||||
|
var ErrRetryLimit = errors.New("telegram retry limit reached")
|
||||||
|
|
||||||
// ErrRichMessageDraftUploadUnsupported reports a direct file upload attempted for a rich draft.
|
// ErrRichMessageDraftUploadUnsupported reports a direct file upload attempted for a rich draft.
|
||||||
//
|
//
|
||||||
// Since: Bot API 10.2
|
// Since: Bot API 10.2
|
||||||
@@ -21,8 +39,11 @@ var ErrRichMessageDraftUploadUnsupported = errors.New("sendRichMessageDraft does
|
|||||||
|
|
||||||
// ResponseError reports an unsuccessful Telegram API response.
|
// ResponseError reports an unsuccessful Telegram API response.
|
||||||
type ResponseError struct {
|
type ResponseError struct {
|
||||||
|
// Code is the Telegram API error code.
|
||||||
Code int
|
Code int
|
||||||
|
// Description is the human-readable Telegram API error description.
|
||||||
Description string
|
Description string
|
||||||
|
// Parameters contains additional recovery metadata such as retry_after.
|
||||||
Parameters *ResponseParameters
|
Parameters *ResponseParameters
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,9 @@ import "context"
|
|||||||
// BaseForumTopic contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
// BaseForumTopic contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
||||||
// Since: Bot API 6.3
|
// Since: Bot API 6.3
|
||||||
type BaseForumTopic struct {
|
type BaseForumTopic struct {
|
||||||
|
// ChatID identifies the target supergroup.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID identifies the target forum topic.
|
||||||
MessageThreadID int `json:"message_thread_id"`
|
MessageThreadID int `json:"message_thread_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -30,9 +32,17 @@ func (api *API) GetForumTopicIconStickersWithContext(ctx context.Context) ([]Sti
|
|||||||
// Since: Bot API 6.3
|
// Since: Bot API 6.3
|
||||||
// See https://core.telegram.org/bots/api#createforumtopic
|
// See https://core.telegram.org/bots/api#createforumtopic
|
||||||
type CreateForumTopic struct {
|
type CreateForumTopic struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Name Required. Topic name, 1-128 characters
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// IconColor Optional. Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0),
|
||||||
|
// 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047
|
||||||
|
// (0xFB6F5F).
|
||||||
IconColor ForumTopicIconColor `json:"icon_color"`
|
IconColor ForumTopicIconColor `json:"icon_color"`
|
||||||
|
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon. Use
|
||||||
|
// getForumTopicIconStickers to get all allowed custom emoji identifiers.
|
||||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,7 +69,12 @@ func (api *API) CreateForumTopicWithContext(ctx context.Context, params CreateFo
|
|||||||
// See https://core.telegram.org/bots/api#editforumtopic
|
// See https://core.telegram.org/bots/api#editforumtopic
|
||||||
type EditForumTopic struct {
|
type EditForumTopic struct {
|
||||||
BaseForumTopic
|
BaseForumTopic
|
||||||
|
// Name Optional. New topic name, 0-128 characters. If not specified or empty, the current name of the topic
|
||||||
|
// will be kept.
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// IconCustomEmojiID Optional. New unique identifier of the custom emoji shown as the topic icon. Use
|
||||||
|
// getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the
|
||||||
|
// icon. If not specified, the current icon will be kept.
|
||||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -156,6 +171,7 @@ func (api *API) UnpinAllForumTopicMessagesWithContext(ctx context.Context, param
|
|||||||
// BaseGeneralForumTopic contains common fields for general forum topic operations that require a chat ID.
|
// BaseGeneralForumTopic contains common fields for general forum topic operations that require a chat ID.
|
||||||
// Since: Bot API 6.4
|
// Since: Bot API 6.4
|
||||||
type BaseGeneralForumTopic struct {
|
type BaseGeneralForumTopic struct {
|
||||||
|
// ChatID identifies the target supergroup.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -163,7 +179,10 @@ type BaseGeneralForumTopic struct {
|
|||||||
// Since: Bot API 6.4
|
// Since: Bot API 6.4
|
||||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||||
type EditGeneralForumTopic struct {
|
type EditGeneralForumTopic struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Name Required. New topic name, 1-128 characters
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,10 +4,16 @@ package tgapi
|
|||||||
// Since: Bot API 6.3
|
// Since: Bot API 6.3
|
||||||
// See https://core.telegram.org/bots/api#forumtopic
|
// See https://core.telegram.org/bots/api#forumtopic
|
||||||
type ForumTopic struct {
|
type ForumTopic struct {
|
||||||
|
// MessageThreadID Unique identifier of the forum topic
|
||||||
MessageThreadID int `json:"message_thread_id"`
|
MessageThreadID int `json:"message_thread_id"`
|
||||||
|
// Name Name of the topic
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// IconColor Color of the topic icon in RGB format
|
||||||
IconColor int `json:"icon_color"`
|
IconColor int `json:"icon_color"`
|
||||||
|
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon
|
||||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
// IsNameImplicit Optional. True, if the name of the topic wasn't specified explicitly by its creator and
|
||||||
|
// likely needs to be changed by the bot
|
||||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -25,16 +31,24 @@ const (
|
|||||||
// ForumTopicCreated represents a service message about a new forum topic created.
|
// ForumTopicCreated represents a service message about a new forum topic created.
|
||||||
// Since: Bot API 6.3
|
// Since: Bot API 6.3
|
||||||
type ForumTopicCreated struct {
|
type ForumTopicCreated struct {
|
||||||
|
// Name Name of the topic
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// IconColor Color of the topic icon in RGB format
|
||||||
IconColor int `json:"icon_color"`
|
IconColor int `json:"icon_color"`
|
||||||
|
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon
|
||||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
// IsNameImplicit Optional. True, if the name of the topic wasn't specified explicitly by its creator and
|
||||||
|
// likely needs to be changed by the bot
|
||||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ForumTopicEdited represents a service message about an edited forum topic.
|
// ForumTopicEdited represents a service message about an edited forum topic.
|
||||||
// Since: Bot API 6.4
|
// Since: Bot API 6.4
|
||||||
type ForumTopicEdited struct {
|
type ForumTopicEdited struct {
|
||||||
|
// Name Optional. New name of the topic, if it was edited
|
||||||
Name string `json:"name,omitempty"`
|
Name string `json:"name,omitempty"`
|
||||||
|
// IconCustomEmojiID Optional. New identifier of the custom emoji shown as the topic icon, if it was edited;
|
||||||
|
// an empty string if the icon was removed
|
||||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,17 +6,36 @@ import "context"
|
|||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
// See https://core.telegram.org/bots/api#sendgame
|
// See https://core.telegram.org/bots/api#sendgame
|
||||||
type SendGame struct {
|
type SendGame struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot in the format
|
||||||
|
// @username. Games can't be sent to channel direct messages chats and channel chats.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
|
||||||
|
// GameShortName Required. Short name of the game, serves as the unique identifier for the game. Set up your
|
||||||
|
// games via @BotFather.
|
||||||
GameShortName string `json:"game_short_name"`
|
GameShortName string `json:"game_short_name"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'
|
||||||
|
// button will be shown. If not empty, the first button must launch the game.
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -41,12 +60,22 @@ func (api *API) SendGameWithContext(ctx context.Context, params SendGame) (Messa
|
|||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
// See https://core.telegram.org/bots/api#setgamescore
|
// See https://core.telegram.org/bots/api#setgamescore
|
||||||
type SetGameScore struct {
|
type SetGameScore struct {
|
||||||
|
// UserID Required. User identifier
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Score Required. New score, must be non-negative
|
||||||
Score int `json:"score"`
|
Score int `json:"score"`
|
||||||
|
// Force Optional. Pass True if the high score is allowed to decrease. This can be useful when fixing
|
||||||
|
// mistakes or banning cheaters.
|
||||||
Force bool `json:"force,omitempty"`
|
Force bool `json:"force,omitempty"`
|
||||||
|
// DisableEditMessage Optional. Pass True if the game message should not be automatically edited to include
|
||||||
|
// the current scoreboard
|
||||||
DisableEditMessage bool `json:"disable_edit_message,omitempty"`
|
DisableEditMessage bool `json:"disable_edit_message,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the sent message.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,9 +116,14 @@ func (api *API) SetGameScoreWithContext(ctx context.Context, params SetGameScore
|
|||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
// See https://core.telegram.org/bots/api#getgamehighscores
|
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||||
type GetGameHighScores struct {
|
type GetGameHighScores struct {
|
||||||
|
// UserID Required. Target user id
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the sent message.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,11 +3,19 @@ package tgapi
|
|||||||
// Game represents a game.
|
// Game represents a game.
|
||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
type Game struct {
|
type Game struct {
|
||||||
|
// Title Title of the game
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Description Description of the game
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// Photo Photo that will be displayed in the game message in chats
|
||||||
Photo []PhotoSize `json:"photo"`
|
Photo []PhotoSize `json:"photo"`
|
||||||
|
// Text Optional. Brief description of the game or high scores included in the game message. Can be
|
||||||
|
// automatically edited to include current high scores for the game when the bot calls setGameScore, or
|
||||||
|
// manually edited using editMessageText. 0-4096 characters.
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
|
// TextEntities Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
|
||||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
// Animation Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
|
||||||
Animation *Animation `json:"animation,omitempty"`
|
Animation *Animation `json:"animation,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -19,7 +27,10 @@ type CallbackGame struct{}
|
|||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
// See https://core.telegram.org/bots/api#gamehighscore
|
// See https://core.telegram.org/bots/api#gamehighscore
|
||||||
type GameHighScore struct {
|
type GameHighScore struct {
|
||||||
|
// Position Position in high score table for the game
|
||||||
Position int `json:"position"`
|
Position int `json:"position"`
|
||||||
|
// User User
|
||||||
User User `json:"user"`
|
User User `json:"user"`
|
||||||
|
// Score Score
|
||||||
Score int `json:"score"`
|
Score int `json:"score"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,11 +6,21 @@ import "context"
|
|||||||
// Since: Bot API 1.7
|
// Since: Bot API 1.7
|
||||||
// See https://core.telegram.org/bots/api#answerinlinequery
|
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||||
type AnswerInlineQuery struct {
|
type AnswerInlineQuery struct {
|
||||||
|
// InlineQueryID Required. Unique identifier for the answered query
|
||||||
InlineQueryID string `json:"inline_query_id"`
|
InlineQueryID string `json:"inline_query_id"`
|
||||||
|
// Results Required. A JSON-serialized Array of results for the inline query
|
||||||
Results []InlineQueryResult `json:"results"`
|
Results []InlineQueryResult `json:"results"`
|
||||||
|
// CacheTime Optional. The maximum amount of time in seconds that the result of the inline query may be
|
||||||
|
// cached on the server. Defaults to 300.
|
||||||
CacheTime int `json:"cache_time,omitempty"`
|
CacheTime int `json:"cache_time,omitempty"`
|
||||||
|
// IsPersonal Optional. Pass True if results may be cached on the server side only for the user that sent
|
||||||
|
// the query. By default, results may be returned to any user who sends the same query.
|
||||||
IsPersonal bool `json:"is_personal,omitempty"`
|
IsPersonal bool `json:"is_personal,omitempty"`
|
||||||
|
// NextOffset Optional. Pass the offset that a client should send in the next query with the same text to
|
||||||
|
// receive more results. Pass an empty string if there are no more results or if you don't support
|
||||||
|
// pagination. Offset length can't exceed 64 bytes.
|
||||||
NextOffset string `json:"next_offset,omitempty"`
|
NextOffset string `json:"next_offset,omitempty"`
|
||||||
|
// Button Optional. A JSON-serialized object describing a button to be shown above inline query results
|
||||||
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -36,7 +46,9 @@ func (api *API) AnswerInlineQueryWithContext(ctx context.Context, params AnswerI
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||||
type AnswerWebAppQuery struct {
|
type AnswerWebAppQuery struct {
|
||||||
|
// WebAppQueryID Required. Unique identifier for the query to be answered
|
||||||
WebAppQueryID string `json:"web_app_query_id"`
|
WebAppQueryID string `json:"web_app_query_id"`
|
||||||
|
// Result Required. A JSON-serialized object describing the message to be sent
|
||||||
Result InlineQueryResult `json:"result"`
|
Result InlineQueryResult `json:"result"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,11 +73,17 @@ func (api *API) AnswerWebAppQueryWithContext(ctx context.Context, params AnswerW
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||||
type SavePreparedInlineMessage struct {
|
type SavePreparedInlineMessage struct {
|
||||||
|
// UserID Required. Unique identifier of the target user that can use the prepared message
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Result Required. A JSON-serialized object describing the message to be sent
|
||||||
Result InlineQueryResult `json:"result"`
|
Result InlineQueryResult `json:"result"`
|
||||||
|
// AllowUserChats Optional. Pass True if the message can be sent to private chats with users
|
||||||
AllowUserChats bool `json:"allow_user_chats,omitempty"`
|
AllowUserChats bool `json:"allow_user_chats,omitempty"`
|
||||||
|
// AllowBotChats Optional. Pass True if the message can be sent to private chats with bots
|
||||||
AllowBotChats bool `json:"allow_bot_chats,omitempty"`
|
AllowBotChats bool `json:"allow_bot_chats,omitempty"`
|
||||||
|
// AllowGroupChats Optional. Pass True if the message can be sent to group and supergroup chats
|
||||||
AllowGroupChats bool `json:"allow_group_chats,omitempty"`
|
AllowGroupChats bool `json:"allow_group_chats,omitempty"`
|
||||||
|
// AllowChannelChats Optional. Pass True if the message can be sent to channel chats
|
||||||
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,7 +108,10 @@ func (api *API) SavePreparedInlineMessageWithContext(ctx context.Context, params
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||||
type SavePreparedKeyboardButton struct {
|
type SavePreparedKeyboardButton struct {
|
||||||
|
// UserID Required. Unique identifier of the target user that can use the button
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Button Required. A JSON-serialized object describing the button to be saved. The button must be of the
|
||||||
|
// type request_users, request_chat, or request_managed_bot.
|
||||||
Button KeyboardButton `json:"button"`
|
Button KeyboardButton `json:"button"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -9,8 +9,20 @@ type InlineQueryResult map[string]any
|
|||||||
// Since: Bot API 6.3
|
// Since: Bot API 6.3
|
||||||
// See https://core.telegram.org/bots/api#inlinequeryresultsbutton
|
// See https://core.telegram.org/bots/api#inlinequeryresultsbutton
|
||||||
type InlineQueryResultsButton struct {
|
type InlineQueryResultsButton struct {
|
||||||
|
// Text Label text on the button
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// WebApp Optional. Description of the Web App that will be launched when the user presses the button. The
|
||||||
|
// Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web
|
||||||
|
// App.
|
||||||
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||||
|
// StartParameter Optional. Deep-linking parameter for the /start message sent to the bot when a user
|
||||||
|
// presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that
|
||||||
|
// sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results
|
||||||
|
// accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even
|
||||||
|
// before showing any. The user presses the button, switches to a private chat with the bot and, in doing
|
||||||
|
// so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer
|
||||||
|
// a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's
|
||||||
|
// inline capabilities.
|
||||||
StartParameter string `json:"start_parameter,omitempty"`
|
StartParameter string `json:"start_parameter,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -28,6 +40,8 @@ type InputRichMessageContent struct {
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#sentwebappmessage
|
// See https://core.telegram.org/bots/api#sentwebappmessage
|
||||||
type SentWebAppMessage struct {
|
type SentWebAppMessage struct {
|
||||||
|
// InlineMessageID Optional. Identifier of the sent inline message. Available only if there is an inline
|
||||||
|
// keyboard attached to the message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -35,7 +49,10 @@ type SentWebAppMessage struct {
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#preparedinlinemessage
|
// See https://core.telegram.org/bots/api#preparedinlinemessage
|
||||||
type PreparedInlineMessage struct {
|
type PreparedInlineMessage struct {
|
||||||
|
// ID Unique identifier of the prepared message
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// ExpirationDate Expiration date of the prepared message, in Unix time. Expired prepared messages can no
|
||||||
|
// longer be used.
|
||||||
ExpirationDate int `json:"expiration_date"`
|
ExpirationDate int `json:"expiration_date"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -43,5 +60,6 @@ type PreparedInlineMessage struct {
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#preparedkeyboardbutton
|
// See https://core.telegram.org/bots/api#preparedkeyboardbutton
|
||||||
type PreparedKeyboardButton struct {
|
type PreparedKeyboardButton struct {
|
||||||
|
// ID Unique identifier of the keyboard button
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,9 @@ package tgapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -55,3 +57,30 @@ func redactLogValue(value any) {
|
|||||||
func responseLogSummary(method string, size int) string {
|
func responseLogSummary(method string, size int) string {
|
||||||
return fmt.Sprintf("method=%s bytes=%d body=omitted", method, size)
|
return fmt.Sprintf("method=%s bytes=%d body=omitted", method, size)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type redactedError struct {
|
||||||
|
err error
|
||||||
|
secret string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *redactedError) Error() string {
|
||||||
|
return strings.ReplaceAll(e.err.Error(), e.secret, redactedLogValue)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *redactedError) Unwrap() error { return e.err }
|
||||||
|
|
||||||
|
func redactHTTPError(err error, token string) error {
|
||||||
|
if err == nil || token == "" || !strings.Contains(err.Error(), token) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var urlErr *url.Error
|
||||||
|
if !errors.As(err, &urlErr) {
|
||||||
|
return &redactedError{err: err, secret: token}
|
||||||
|
}
|
||||||
|
|
||||||
|
redactedURL := *urlErr
|
||||||
|
redactedURL.URL = strings.ReplaceAll(redactedURL.URL, token, redactedLogValue)
|
||||||
|
redactedURL.Err = &redactedError{err: urlErr.Err, secret: token}
|
||||||
|
return &redactedURL
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
package tgapi
|
package tgapi
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
@@ -37,3 +40,29 @@ func TestResponseLogSummaryNeverContainsBody(t *testing.T) {
|
|||||||
t.Fatalf("response summary does not explain omission: %s", got)
|
t.Fatalf("response summary does not explain omission: %s", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRedactHTTPErrorRemovesTokenAndPreservesCause(t *testing.T) {
|
||||||
|
const token = "123456:secret-token"
|
||||||
|
cause := errors.New("transport failed")
|
||||||
|
original := &url.Error{
|
||||||
|
Op: "Post",
|
||||||
|
URL: "https://api.telegram.org/bot" + token + "/sendMessage",
|
||||||
|
Err: fmt.Errorf("request for %s failed: %w", token, cause),
|
||||||
|
}
|
||||||
|
|
||||||
|
got := redactHTTPError(original, token)
|
||||||
|
if strings.Contains(got.Error(), token) {
|
||||||
|
t.Fatalf("redacted HTTP error contains bot token: %v", got)
|
||||||
|
}
|
||||||
|
if !errors.Is(got, cause) {
|
||||||
|
t.Fatalf("redacted HTTP error lost its cause: %v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
var gotURLError *url.Error
|
||||||
|
if !errors.As(got, &gotURLError) {
|
||||||
|
t.Fatalf("redacted HTTP error lost url.Error type: %T", got)
|
||||||
|
}
|
||||||
|
if strings.Contains(gotURLError.Error(), token) {
|
||||||
|
t.Fatalf("redacted url.Error contains bot token: %v", gotURLError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,26 +6,54 @@ import "context"
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendmessage
|
// See https://core.telegram.org/bots/api#sendmessage
|
||||||
type SendMessage struct {
|
type SendMessage struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Text Required. Text of the message to be sent, 1-4096 characters after entities parsing
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the message text. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// Entities Optional. A JSON-serialized list of special entities that appear in message text, which can be
|
||||||
|
// specified instead of parse_mode
|
||||||
Entities []MessageEntity `json:"entities,omitempty"`
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
// LinkPreviewOptions Optional. Link preview generation options for the message
|
||||||
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
|
// DisableNotifications Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotifications bool `json:"disable_notification,omitempty"`
|
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -50,17 +78,34 @@ func (api *API) SendMessageWithContext(ctx context.Context, params SendMessage)
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#forwardmessage
|
// See https://core.telegram.org/bots/api#forwardmessage
|
||||||
type ForwardMessage struct {
|
type ForwardMessage struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// forwarded; required if the message is forwarded to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// MessageID Required. Message identifier in the chat specified in from_chat_id
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// FromChatID Required. Unique identifier for the chat where the original message was sent (or username of
|
||||||
|
// the target bot, supergroup or channel in the format @username)
|
||||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
// VideoStartTimestamp Optional. New start timestamp for the forwarded video in the message
|
||||||
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the forwarded message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; only
|
||||||
|
// available when forwarding to private chats
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -85,13 +130,26 @@ func (api *API) ForwardMessageWithContext(ctx context.Context, params ForwardMes
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#forwardmessages
|
// See https://core.telegram.org/bots/api#forwardmessages
|
||||||
type ForwardMessages struct {
|
type ForwardMessages struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the messages will be
|
||||||
|
// forwarded; required if the messages are forwarded to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// FromChatID Required. Unique identifier for the chat where the original messages were sent (or username of
|
||||||
|
// the target bot, supergroup or channel in the format @username)
|
||||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
// MessageIDs Required. A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to
|
||||||
|
// forward. The identifiers must be specified in a strictly increasing order.
|
||||||
MessageIDs []int `json:"message_ids,omitempty"`
|
MessageIDs []int `json:"message_ids,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the messages silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the forwarded messages from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -117,25 +175,57 @@ func (api *API) ForwardMessagesWithContext(ctx context.Context, params ForwardMe
|
|||||||
// Since: Bot API 5.0
|
// Since: Bot API 5.0
|
||||||
// See https://core.telegram.org/bots/api#copymessage
|
// See https://core.telegram.org/bots/api#copymessage
|
||||||
type CopyMessage struct {
|
type CopyMessage struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// FromChatID Required. Unique identifier for the chat where the original message was sent (or username of
|
||||||
|
// the target bot, supergroup or channel in the format @username)
|
||||||
FromChatID int64 `json:"from_chat_id"`
|
FromChatID int64 `json:"from_chat_id"`
|
||||||
|
// MessageID Required. Message identifier in the chat specified in from_chat_id
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// VideoStartTimestamp Optional. New start timestamp for the copied video in the message
|
||||||
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||||
|
// Caption Optional. New caption for media, 0-1024 characters after entities parsing. If not specified, the
|
||||||
|
// original caption is kept.
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the new caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the new caption,
|
||||||
|
// which can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media. Ignored
|
||||||
|
// if a new caption isn't specified.
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; only
|
||||||
|
// available when copying to private chats
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -167,14 +257,28 @@ func (api *API) CopyMessageWithContext(ctx context.Context, params CopyMessage)
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#copymessages
|
// See https://core.telegram.org/bots/api#copymessages
|
||||||
type CopyMessages struct {
|
type CopyMessages struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the messages will be
|
||||||
|
// sent; required if the messages are sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// FromChatID Required. Unique identifier for the chat where the original messages were sent (or username of
|
||||||
|
// the target bot, supergroup or channel in the format @username)
|
||||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
// MessageIDs Required. A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to
|
||||||
|
// copy. The identifiers must be specified in a strictly increasing order.
|
||||||
MessageIDs []int `json:"message_ids,omitempty"`
|
MessageIDs []int `json:"message_ids,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the messages silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent messages from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// RemoveCaption Optional. Pass True to copy the messages without their captions
|
||||||
RemoveCaption bool `json:"remove_caption,omitempty"`
|
RemoveCaption bool `json:"remove_caption,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -200,29 +304,61 @@ func (api *API) CopyMessagesWithContext(ctx context.Context, params CopyMessages
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendlocation
|
// See https://core.telegram.org/bots/api#sendlocation
|
||||||
type SendLocation struct {
|
type SendLocation struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Latitude Required. Latitude of the location
|
||||||
Latitude float64 `json:"latitude"`
|
Latitude float64 `json:"latitude"`
|
||||||
|
// Longitude Required. Longitude of the location
|
||||||
Longitude float64 `json:"longitude"`
|
Longitude float64 `json:"longitude"`
|
||||||
|
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||||
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
||||||
|
// LivePeriod Optional. Period in seconds during which the location will be updated (see Live Locations),
|
||||||
|
// must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0
|
||||||
|
// for ephemeral messages.
|
||||||
LivePeriod int `json:"live_period,omitempty"`
|
LivePeriod int `json:"live_period,omitempty"`
|
||||||
|
// Heading Optional. For live locations, a direction in which the user is moving, in degrees. Must be
|
||||||
|
// between 1 and 360 if specified.
|
||||||
Heading int `json:"heading,omitempty"`
|
Heading int `json:"heading,omitempty"`
|
||||||
|
// ProximityAlertRadius Optional. For live locations, a maximum distance for proximity alerts about
|
||||||
|
// approaching another chat member, in meters. Must be between 1 and 100000 if specified.
|
||||||
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -247,31 +383,62 @@ func (api *API) SendLocationWithContext(ctx context.Context, params SendLocation
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#sendvenue
|
// See https://core.telegram.org/bots/api#sendvenue
|
||||||
type SendVenue struct {
|
type SendVenue struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Latitude Required. Latitude of the venue
|
||||||
Latitude float64 `json:"latitude"`
|
Latitude float64 `json:"latitude"`
|
||||||
|
// Longitude Required. Longitude of the venue
|
||||||
Longitude float64 `json:"longitude"`
|
Longitude float64 `json:"longitude"`
|
||||||
|
// Title Required. Name of the venue
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Address Required. Address of the venue
|
||||||
Address string `json:"address"`
|
Address string `json:"address"`
|
||||||
|
// FoursquareID Optional. Foursquare identifier of the venue
|
||||||
FoursquareID string `json:"foursquare_id,omitempty"`
|
FoursquareID string `json:"foursquare_id,omitempty"`
|
||||||
|
// FoursquareType Optional. Foursquare type of the venue, if known. (For example,
|
||||||
|
// “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
|
||||||
FoursquareType string `json:"foursquare_type,omitempty"`
|
FoursquareType string `json:"foursquare_type,omitempty"`
|
||||||
|
// GooglePlaceID Optional. Google Places identifier of the venue
|
||||||
GooglePlaceID string `json:"google_place_id,omitempty"`
|
GooglePlaceID string `json:"google_place_id,omitempty"`
|
||||||
|
// GooglePlaceType Optional. Google Places type of the venue. (See supported types.)
|
||||||
GooglePlaceType string `json:"google_place_type,omitempty"`
|
GooglePlaceType string `json:"google_place_type,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -296,27 +463,53 @@ func (api *API) SendVenueWithContext(ctx context.Context, params SendVenue) (Mes
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#sendcontact
|
// See https://core.telegram.org/bots/api#sendcontact
|
||||||
type SendContact struct {
|
type SendContact struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// PhoneNumber Required. Contact's phone number
|
||||||
PhoneNumber string `json:"phone_number"`
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
// FirstName Required. Contact's first name
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
|
// LastName Optional. Contact's last name
|
||||||
LastName string `json:"last_name,omitempty"`
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
// Vcard Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
|
||||||
Vcard string `json:"vcard"`
|
Vcard string `json:"vcard"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -341,43 +534,102 @@ func (api *API) SendContactWithContext(ctx context.Context, params SendContact)
|
|||||||
// Since: Bot API 4.2
|
// Since: Bot API 4.2
|
||||||
// See https://core.telegram.org/bots/api#sendpoll
|
// See https://core.telegram.org/bots/api#sendpoll
|
||||||
type SendPoll struct {
|
type SendPoll struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username. Polls can't be sent to channel direct messages chats.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
|
||||||
|
// Question Required. Poll question, 1-300 characters
|
||||||
Question string `json:"question"`
|
Question string `json:"question"`
|
||||||
|
// QuestionParseMode Optional. Mode for parsing entities in the question. See formatting options for more
|
||||||
|
// details. Currently, only custom emoji entities are allowed.
|
||||||
QuestionParseMode ParseMode `json:"question_parse_mode,omitempty"`
|
QuestionParseMode ParseMode `json:"question_parse_mode,omitempty"`
|
||||||
|
// QuestionEntities Optional. A JSON-serialized list of special entities that appear in the poll question.
|
||||||
|
// It can be specified instead of question_parse_mode.
|
||||||
QuestionEntities []MessageEntity `json:"question_entities,omitempty"`
|
QuestionEntities []MessageEntity `json:"question_entities,omitempty"`
|
||||||
|
// Options Required. A JSON-serialized list of 1-12 answer options
|
||||||
Options []InputPollOption `json:"options"`
|
Options []InputPollOption `json:"options"`
|
||||||
|
// IsAnonymous Optional. True, if the poll needs to be anonymous, defaults to True
|
||||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||||
|
// Type Optional. Poll type, “quiz” or “regular”, defaults to “regular”
|
||||||
Type PollType `json:"type"`
|
Type PollType `json:"type"`
|
||||||
|
// AllowsMultipleAnswers Optional. Pass True if the poll allows multiple answers, defaults to False
|
||||||
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"`
|
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"`
|
||||||
|
// AllowsRevoting Optional. Pass True if the poll allows to change chosen answer options, defaults to False
|
||||||
|
// for quizzes and to True for regular polls
|
||||||
AllowsRevoting bool `json:"allows_revoting,omitempty"`
|
AllowsRevoting bool `json:"allows_revoting,omitempty"`
|
||||||
|
// ShuffleOptions Optional. Pass True if the poll options must be shown in random order
|
||||||
ShuffleOptions bool `json:"shuffle_options,omitempty"`
|
ShuffleOptions bool `json:"shuffle_options,omitempty"`
|
||||||
|
// AllowAddingOptions Optional. Pass True if answer options can be added to the poll after creation; not
|
||||||
|
// supported for anonymous polls and quizzes
|
||||||
AllowAddingOptions bool `json:"allow_adding_options,omitempty"`
|
AllowAddingOptions bool `json:"allow_adding_options,omitempty"`
|
||||||
|
// HideResultsUntilCloses Optional. Pass True if poll results must be shown only after the poll closes
|
||||||
HideResultsUntilCloses bool `json:"hide_results_until_closes,omitempty"`
|
HideResultsUntilCloses bool `json:"hide_results_until_closes,omitempty"`
|
||||||
|
// MembersOnly Optional. Pass True if voting is limited to users who have been members of the chat where the
|
||||||
|
// poll is being sent for more than 24 hours; for channel chats only
|
||||||
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
||||||
|
// CountryCodes Optional. A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes
|
||||||
|
// indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a
|
||||||
|
// country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any
|
||||||
|
// country can participate in the poll.
|
||||||
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
||||||
|
// CorrectOptionIDs Optional. A JSON-serialized list of monotonically increasing 0-based identifiers of the
|
||||||
|
// correct answer options, required for polls in quiz mode
|
||||||
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"`
|
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"`
|
||||||
|
// Explanation Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon
|
||||||
|
// in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
|
||||||
Explanation string `json:"explanation,omitempty"`
|
Explanation string `json:"explanation,omitempty"`
|
||||||
|
// ExplanationParseMode Optional. Mode for parsing entities in the explanation. See formatting options for
|
||||||
|
// more details.
|
||||||
ExplanationParseMode ParseMode `json:"explanation_parse_mode,omitempty"`
|
ExplanationParseMode ParseMode `json:"explanation_parse_mode,omitempty"`
|
||||||
|
// ExplanationEntities Optional. A JSON-serialized list of special entities that appear in the poll
|
||||||
|
// explanation. It can be specified instead of explanation_parse_mode.
|
||||||
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
|
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
|
||||||
|
// ExplanationMedia Optional. Media added to the quiz explanation
|
||||||
ExplanationMedia *InputPollMedia `json:"explanation_media,omitempty"`
|
ExplanationMedia *InputPollMedia `json:"explanation_media,omitempty"`
|
||||||
|
// Media Optional. Media added to the poll description
|
||||||
Media *InputPollMedia `json:"media,omitempty"`
|
Media *InputPollMedia `json:"media,omitempty"`
|
||||||
|
// OpenPeriod Optional. Amount of time in seconds the poll will be active after creation, 5-2628000. Can't
|
||||||
|
// be used together with close_date.
|
||||||
OpenPeriod int `json:"open_period,omitempty"`
|
OpenPeriod int `json:"open_period,omitempty"`
|
||||||
|
// CloseDate Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at
|
||||||
|
// least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.
|
||||||
CloseDate int `json:"close_date"`
|
CloseDate int `json:"close_date"`
|
||||||
|
// IsClosed Optional. Pass True if the poll needs to be immediately closed. This can be useful for poll
|
||||||
|
// preview.
|
||||||
IsClosed bool `json:"is_closed,omitempty"`
|
IsClosed bool `json:"is_closed,omitempty"`
|
||||||
|
|
||||||
|
// Description Optional. Description of the poll to be sent, 0-1024 characters after entities parsing
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// DescriptionParseMode Optional. Mode for parsing entities in the poll description. See formatting options
|
||||||
|
// for more details.
|
||||||
DescriptionParseMode ParseMode `json:"description_parse_mode,omitempty"`
|
DescriptionParseMode ParseMode `json:"description_parse_mode,omitempty"`
|
||||||
|
// DescriptionEntities Optional. A JSON-serialized list of special entities that appear in the poll
|
||||||
|
// description, which can be specified instead of description_parse_mode
|
||||||
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
|
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -402,15 +654,26 @@ func (api *API) SendPollWithContext(ctx context.Context, params SendPoll) (Messa
|
|||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
// See https://core.telegram.org/bots/api#sendchecklist
|
// See https://core.telegram.org/bots/api#sendchecklist
|
||||||
type SendChecklist struct {
|
type SendChecklist struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// Checklist Required. A JSON-serialized object for the checklist to send
|
||||||
Checklist InputChecklist `json:"checklist"`
|
Checklist InputChecklist `json:"checklist"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// ReplyParameters Optional. A JSON-serialized object for description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -435,20 +698,45 @@ func (api *API) SendChecklistWithContext(ctx context.Context, params SendCheckli
|
|||||||
// Since: Bot API 4.7
|
// Since: Bot API 4.7
|
||||||
// See https://core.telegram.org/bots/api#senddice
|
// See https://core.telegram.org/bots/api#senddice
|
||||||
type SendDice struct {
|
type SendDice struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// Emoji Optional. Emoji on which the dice throw animation is based. Currently, must be one of “”,
|
||||||
|
// “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values
|
||||||
|
// 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”.
|
||||||
Emoji string `json:"emoji,omitempty"`
|
Emoji string `json:"emoji,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -473,11 +761,21 @@ func (api *API) SendDiceWithContext(ctx context.Context, params SendDice) (Messa
|
|||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
// See https://core.telegram.org/bots/api#sendmessagedraft
|
// See https://core.telegram.org/bots/api#sendmessagedraft
|
||||||
type SendMessageDraft struct {
|
type SendMessageDraft struct {
|
||||||
|
// ChatID Required. Unique identifier for the target private chat
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DraftID Required. Unique identifier of the message draft; must be non-zero. Changes to drafts with the
|
||||||
|
// same identifier are animated.
|
||||||
DraftID uint64 `json:"draft_id"`
|
DraftID uint64 `json:"draft_id"`
|
||||||
|
// Text Optional. Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty
|
||||||
|
// text to show a “Thinking…” placeholder.
|
||||||
Text string `json:"text"`
|
Text string `json:"text"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the message text. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// Entities Optional. A JSON-serialized list of special entities that appear in message text, which can be
|
||||||
|
// specified instead of parse_mode
|
||||||
Entities []MessageEntity `json:"entities,omitempty"`
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -503,9 +801,19 @@ func (api *API) SendMessageDraftWithContext(ctx context.Context, params SendMess
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendchataction
|
// See https://core.telegram.org/bots/api#sendchataction
|
||||||
type SendChatAction struct {
|
type SendChatAction struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the action
|
||||||
|
// will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot or supergroup in the
|
||||||
|
// format @username. Channel chats and channel direct messages chats aren't supported.
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread or topic of a forum; for
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// Action Required. Type of action to broadcast. Choose one, depending on what the user is about to receive:
|
||||||
|
// typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice
|
||||||
|
// or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers,
|
||||||
|
// find_location for location data, record_video_note or upload_video_note for video notes.
|
||||||
Action ChatActionType `json:"action"`
|
Action ChatActionType `json:"action"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -531,9 +839,18 @@ func (api *API) SendChatActionWithContext(ctx context.Context, params SendChatAc
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#setmessagereaction
|
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||||
type SetMessageReaction struct {
|
type SetMessageReaction struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of the target message. If the message belongs to a media group, the
|
||||||
|
// reaction is set to the first non-deleted message in the group instead.
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// Reaction Optional. A JSON-serialized list of reaction types to set on the message. Currently, as
|
||||||
|
// non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it
|
||||||
|
// is either already present on the message or explicitly allowed by chat administrators. Paid reactions
|
||||||
|
// can't be used by bots.
|
||||||
Reaction []ReactionType `json:"reaction"`
|
Reaction []ReactionType `json:"reaction"`
|
||||||
|
// IsBig Optional. Pass True to set the reaction with a big animation
|
||||||
IsBig bool `json:"is_big,omitempty"`
|
IsBig bool `json:"is_big,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -559,16 +876,31 @@ func (api *API) SetMessageReactionWithContext(ctx context.Context, params SetMes
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#editmessagetext
|
// See https://core.telegram.org/bots/api#editmessagetext
|
||||||
type EditMessageText struct {
|
type EditMessageText struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message to edit.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
// Text Optional. New text of the message, 1-4096 characters after entity parsing; required if rich_message
|
||||||
|
// isn't specified
|
||||||
Text string `json:"text,omitempty"` // required unless RichMessage is set
|
Text string `json:"text,omitempty"` // required unless RichMessage is set
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the message text. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// Entities Optional. A JSON-serialized list of special entities that appear in message text, which can be
|
||||||
|
// specified instead of parse_mode
|
||||||
Entities []MessageEntity `json:"entities,omitempty"`
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
// LinkPreviewOptions Optional. Link preview generation options for the message
|
||||||
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
// RichMessage contains structured rich-message content.
|
// RichMessage contains structured rich-message content.
|
||||||
RichMessage *InputRichMessage `json:"rich_message,omitempty"` // Since: Bot API 10.1; required if Text is not specified
|
RichMessage *InputRichMessage `json:"rich_message,omitempty"` // Since: Bot API 10.1; required if Text is not specified
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -609,14 +941,29 @@ func (api *API) EditMessageTextWithContext(ctx context.Context, params EditMessa
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#editmessagecaption
|
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||||
type EditMessageCaption struct {
|
type EditMessageCaption struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message to edit.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
// Caption Optional. New caption of the message, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption"`
|
Caption string `json:"caption"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the message caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media. Supported
|
||||||
|
// only for animation, photo and video messages.
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -657,11 +1004,20 @@ func (api *API) EditMessageCaptionWithContext(ctx context.Context, params EditMe
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#editmessagemedia
|
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||||
type EditMessageMedia struct {
|
type EditMessageMedia struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message to edit.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
// Media Required. A JSON-serialized object for the new media content of the message
|
||||||
Media InputMedia `json:"media"`
|
Media InputMedia `json:"media"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for a new inline keyboard
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -702,17 +1058,36 @@ func (api *API) EditMessageMediaWithContext(ctx context.Context, params EditMess
|
|||||||
// Since: Bot API 3.4
|
// Since: Bot API 3.4
|
||||||
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
type EditMessageLiveLocation struct {
|
type EditMessageLiveLocation struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message to edit.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
|
||||||
|
// Latitude Required. Latitude of new location
|
||||||
Latitude float64 `json:"latitude"`
|
Latitude float64 `json:"latitude"`
|
||||||
|
// Longitude Required. Longitude of new location
|
||||||
Longitude float64 `json:"longitude"`
|
Longitude float64 `json:"longitude"`
|
||||||
|
// LivePeriod Optional. New period in seconds during which the location can be updated, starting from the
|
||||||
|
// message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the
|
||||||
|
// new value must not exceed the current live_period by more than a day, and the live location expiration
|
||||||
|
// date must remain within the next 90 days. If not specified, then live_period remains unchanged.
|
||||||
LivePeriod int `json:"live_period,omitempty"`
|
LivePeriod int `json:"live_period,omitempty"`
|
||||||
|
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||||
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
||||||
|
// Heading Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if
|
||||||
|
// specified.
|
||||||
Heading int `json:"heading,omitempty"`
|
Heading int `json:"heading,omitempty"`
|
||||||
|
// ProximityAlertRadius Optional. The maximum distance for proximity alerts about approaching another chat
|
||||||
|
// member, in meters. Must be between 1 and 100000 if specified.
|
||||||
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for a new inline keyboard
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -753,10 +1128,19 @@ func (api *API) EditMessageLiveLocationWithContext(ctx context.Context, params E
|
|||||||
// Since: Bot API 3.4
|
// Since: Bot API 3.4
|
||||||
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
type StopMessageLiveLocation struct {
|
type StopMessageLiveLocation struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message with live
|
||||||
|
// location to stop.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for a new inline keyboard
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -797,10 +1181,17 @@ func (api *API) StopMessageLiveLocationWithContext(ctx context.Context, params S
|
|||||||
// Since: Bot API 9.1
|
// Since: Bot API 9.1
|
||||||
// See https://core.telegram.org/bots/api#editmessagechecklist
|
// See https://core.telegram.org/bots/api#editmessagechecklist
|
||||||
type EditMessageChecklist struct {
|
type EditMessageChecklist struct {
|
||||||
|
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id"`
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Unique identifier for the target message
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// Checklist Required. A JSON-serialized object for the new checklist
|
||||||
Checklist InputChecklist `json:"checklist"`
|
Checklist InputChecklist `json:"checklist"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for the new inline keyboard for the message
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -825,10 +1216,18 @@ func (api *API) EditMessageChecklistWithContext(ctx context.Context, params Edit
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||||
type EditMessageReplyMarkup struct {
|
type EditMessageReplyMarkup struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or
|
||||||
|
// username of the target bot, supergroup or channel in the format @username.
|
||||||
ChatID int64 `json:"chat_id,omitempty"`
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the message to edit.
|
||||||
MessageID int `json:"message_id,omitempty"`
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -869,9 +1268,15 @@ func (api *API) EditMessageReplyMarkupWithContext(ctx context.Context, params Ed
|
|||||||
// Since: Bot API 4.2
|
// Since: Bot API 4.2
|
||||||
// See https://core.telegram.org/bots/api#stoppoll
|
// See https://core.telegram.org/bots/api#stoppoll
|
||||||
type StopPoll struct {
|
type StopPoll struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message to be edited was sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of the original message with the poll
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for a new message inline keyboard
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -897,8 +1302,13 @@ func (api *API) StopPollWithContext(ctx context.Context, params StopPoll) (Poll,
|
|||||||
// Since: Bot API 9.2
|
// Since: Bot API 9.2
|
||||||
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||||
type ApproveSuggestedPost struct {
|
type ApproveSuggestedPost struct {
|
||||||
|
// ChatID Required. Unique identifier for the target direct messages chat
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of a suggested post message to approve
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// SendDate Optional. Point in time (Unix timestamp) when the post is expected to be published; omit if the
|
||||||
|
// date has already been specified when the suggested post was created. If specified, then the date must be
|
||||||
|
// not more than 2678400 seconds (30 days) in the future.
|
||||||
SendDate int `json:"send_date,omitempty"`
|
SendDate int `json:"send_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -924,8 +1334,11 @@ func (api *API) ApproveSuggestedPostWithContext(ctx context.Context, params Appr
|
|||||||
// Since: Bot API 9.2
|
// Since: Bot API 9.2
|
||||||
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||||
type DeclineSuggestedPost struct {
|
type DeclineSuggestedPost struct {
|
||||||
|
// ChatID Required. Unique identifier for the target direct messages chat
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of a suggested post message to decline
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// Comment Optional. Comment for the creator of the suggested post; 0-128 characters
|
||||||
Comment string `json:"comment,omitempty"`
|
Comment string `json:"comment,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -951,7 +1364,10 @@ func (api *API) DeclineSuggestedPostWithContext(ctx context.Context, params Decl
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#deletemessage
|
// See https://core.telegram.org/bots/api#deletemessage
|
||||||
type DeleteMessage struct {
|
type DeleteMessage struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of the message to delete
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -977,7 +1393,11 @@ func (api *API) DeleteMessageWithContext(ctx context.Context, params DeleteMessa
|
|||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
// See https://core.telegram.org/bots/api#deletemessages
|
// See https://core.telegram.org/bots/api#deletemessages
|
||||||
type DeleteMessages struct {
|
type DeleteMessages struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageIDs Required. A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage
|
||||||
|
// for limitations on which messages can be deleted.
|
||||||
MessageIDs []int `json:"message_ids"`
|
MessageIDs []int `json:"message_ids"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1003,10 +1423,21 @@ func (api *API) DeleteMessagesWithContext(ctx context.Context, params DeleteMess
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#answercallbackquery
|
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||||
type AnswerCallbackQuery struct {
|
type AnswerCallbackQuery struct {
|
||||||
|
// CallbackQueryID Required. Unique identifier for the query to be answered
|
||||||
CallbackQueryID string `json:"callback_query_id"`
|
CallbackQueryID string `json:"callback_query_id"`
|
||||||
|
// Text Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200
|
||||||
|
// characters.
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
|
// ShowAlert Optional. If True, an alert will be shown by the client instead of a notification at the top of
|
||||||
|
// the chat screen. Defaults to False.
|
||||||
ShowAlert bool `json:"show_alert,omitempty"`
|
ShowAlert bool `json:"show_alert,omitempty"`
|
||||||
|
// URL Optional. URL that will be opened by the user's client. If you have created a Game and accepted the
|
||||||
|
// conditions via @BotFather, specify the URL that opens your game - note that this will only work if the
|
||||||
|
// query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that
|
||||||
|
// open your bot with a parameter.
|
||||||
URL string `json:"url,omitempty"`
|
URL string `json:"url,omitempty"`
|
||||||
|
// CacheTime Optional. The maximum amount of time in seconds that the result of the callback query may be
|
||||||
|
// cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
|
||||||
CacheTime int `json:"cache_time,omitempty"`
|
CacheTime int `json:"cache_time,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1032,7 +1463,9 @@ func (api *API) AnswerCallbackQueryWithContext(ctx context.Context, params Answe
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#answerguestquery
|
// See https://core.telegram.org/bots/api#answerguestquery
|
||||||
type AnswerGuestQuery struct {
|
type AnswerGuestQuery struct {
|
||||||
|
// GuestQueryID Required. Unique identifier for the query to be answered
|
||||||
GuestQueryID string `json:"guest_query_id"`
|
GuestQueryID string `json:"guest_query_id"`
|
||||||
|
// Result Required. A JSON-serialized object describing the message to be sent
|
||||||
Result InlineQueryResult `json:"result"`
|
Result InlineQueryResult `json:"result"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1057,8 +1490,14 @@ func (api *API) AnswerGuestQueryWithContext(ctx context.Context, params AnswerGu
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#deleteallmessagereactions
|
// See https://core.telegram.org/bots/api#deleteallmessagereactions
|
||||||
type DeleteAllMessageReactions struct {
|
type DeleteAllMessageReactions struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// UserID Optional. Identifier of the user whose reactions will be removed, if the reactions were added by a
|
||||||
|
// user
|
||||||
UserID int64 `json:"user_id,omitempty"`
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
// ActorChatID Optional. Identifier of the chat whose reactions will be removed, if the reactions were added
|
||||||
|
// by a chat
|
||||||
ActorChatID int64 `json:"actor_chat_id,omitempty"`
|
ActorChatID int64 `json:"actor_chat_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1072,10 +1511,21 @@ func (api *API) DeleteAllMessageReactions(params DeleteAllMessageReactions) (boo
|
|||||||
}
|
}
|
||||||
|
|
||||||
// DeleteAllMessageReactionWithContext is the context-aware variant of DeleteAllMessageReactions.
|
// DeleteAllMessageReactionWithContext is the context-aware variant of DeleteAllMessageReactions.
|
||||||
|
//
|
||||||
|
// Deprecated: use DeleteAllMessageReactionsWithContext. The misspelled alias is
|
||||||
|
// retained for v1 compatibility and is subject to removal in v2.
|
||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
// See https://core.telegram.org/bots/api#deleteallmessagereactions
|
// See https://core.telegram.org/bots/api#deleteallmessagereactions
|
||||||
func (api *API) DeleteAllMessageReactionWithContext(ctx context.Context, params DeleteAllMessageReactions) (bool, error) {
|
func (api *API) DeleteAllMessageReactionWithContext(ctx context.Context, params DeleteAllMessageReactions) (bool, error) {
|
||||||
|
return api.DeleteAllMessageReactionsWithContext(ctx, params)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteAllMessageReactionsWithContext is the context-aware variant of DeleteAllMessageReactions.
|
||||||
|
// Since: Bot API 10.0
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deleteallmessagereactions
|
||||||
|
func (api *API) DeleteAllMessageReactionsWithContext(ctx context.Context, params DeleteAllMessageReactions) (bool, error) {
|
||||||
req := NewRequest[bool]("deleteAllMessageReactions", params)
|
req := NewRequest[bool]("deleteAllMessageReactions", params)
|
||||||
return req.DoWithContext(ctx, api)
|
return req.DoWithContext(ctx, api)
|
||||||
}
|
}
|
||||||
@@ -1084,9 +1534,16 @@ func (api *API) DeleteAllMessageReactionWithContext(ctx context.Context, params
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#deletemessagereaction
|
// See https://core.telegram.org/bots/api#deletemessagereaction
|
||||||
type DeleteMessageReaction struct {
|
type DeleteMessageReaction struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageID Required. Identifier of the target message
|
||||||
MessageID int `json:"message_id"`
|
MessageID int `json:"message_id"`
|
||||||
|
// UserID Optional. Identifier of the user whose reaction will be removed, if the reaction was added by a
|
||||||
|
// user
|
||||||
UserID int64 `json:"user_id,omitempty"`
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
// ActorChatID Optional. Identifier of the chat whose reaction will be removed, if the reaction was added by
|
||||||
|
// a chat
|
||||||
ActorChatID int64 `json:"actor_chat_id,omitempty"`
|
ActorChatID int64 `json:"actor_chat_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+488
-1
File diff suppressed because it is too large
Load Diff
+71
-1
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"math"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
@@ -12,9 +13,24 @@ import (
|
|||||||
// UpdateParams holds parameters for the getUpdates method.
|
// UpdateParams holds parameters for the getUpdates method.
|
||||||
// See https://core.telegram.org/bots/api#getupdates
|
// See https://core.telegram.org/bots/api#getupdates
|
||||||
type UpdateParams struct {
|
type UpdateParams struct {
|
||||||
|
// Offset Optional. Identifier of the first update to be returned. Must be greater by one than the highest
|
||||||
|
// among the identifiers of previously received updates. By default, updates starting with the earliest
|
||||||
|
// unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with
|
||||||
|
// an offset higher than its update_id. The negative offset can be specified to retrieve updates starting
|
||||||
|
// from -offset update from the end of the updates queue. All previous updates will be forgotten.
|
||||||
Offset *int `json:"offset,omitempty"`
|
Offset *int `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults
|
||||||
|
// to 100.
|
||||||
Limit *int `json:"limit,omitempty"`
|
Limit *int `json:"limit,omitempty"`
|
||||||
|
// Timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be
|
||||||
|
// positive, short polling should be used for testing purposes only.
|
||||||
Timeout *int `json:"timeout,omitempty"`
|
Timeout *int `json:"timeout,omitempty"`
|
||||||
|
// AllowedUpdates Optional. 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
|
||||||
|
// update types except chat_member, message_reaction, and message_reaction_count (default). If not
|
||||||
|
// specified, the previous setting will be used. Please note that this parameter doesn't affect updates
|
||||||
|
// created before the call to getUpdates, so unwanted updates may be received for a short period of time.
|
||||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -36,6 +52,7 @@ func (api *API) GetMeWithContext(ctx context.Context) (User, error) {
|
|||||||
// GetManagedBotToken holds parameters for the getManagedBotToken method.
|
// GetManagedBotToken holds parameters for the getManagedBotToken method.
|
||||||
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||||
type GetManagedBotToken struct {
|
type GetManagedBotToken struct {
|
||||||
|
// UserID Required. User identifier of the managed bot whose token will be returned
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -57,6 +74,7 @@ func (api *API) GetManagedBotTokenWithContext(ctx context.Context, params GetMan
|
|||||||
// ReplaceManagedBotToken holds parameters for the replaceManagedBotToken method.
|
// ReplaceManagedBotToken holds parameters for the replaceManagedBotToken method.
|
||||||
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||||
type ReplaceManagedBotToken struct {
|
type ReplaceManagedBotToken struct {
|
||||||
|
// UserID Required. User identifier of the managed bot whose token will be replaced
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -126,11 +144,28 @@ func (api *API) GetUpdatesWithContext(ctx context.Context, params UpdateParams)
|
|||||||
// To upload a self-signed certificate, use Uploader.SetWebhook.
|
// To upload a self-signed certificate, use Uploader.SetWebhook.
|
||||||
// See https://core.telegram.org/bots/api#setwebhook
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
type SetWebhook struct {
|
type SetWebhook struct {
|
||||||
|
// URL Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration.
|
||||||
URL string `json:"url"`
|
URL string `json:"url"`
|
||||||
|
// IPAddress Optional. The fixed IP address which will be used to send webhook requests instead of the IP
|
||||||
|
// address resolved through DNS
|
||||||
IPAddress string `json:"ip_address,omitempty"`
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
// MaxConnections Optional. The 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.
|
||||||
MaxConnections int8 `json:"max_connections,omitempty"`
|
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||||
|
// AllowedUpdates Optional. 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
|
||||||
|
// update types except chat_member, message_reaction, and message_reaction_count (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.
|
||||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
|
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
|
// SecretToken Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in
|
||||||
|
// every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header
|
||||||
|
// is useful to ensure that the request comes from a webhook set by you.
|
||||||
SecretToken string `json:"secret_token,omitempty"`
|
SecretToken string `json:"secret_token,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -155,6 +190,7 @@ func (api *API) SetWebhookWithContext(ctx context.Context, params SetWebhook) (b
|
|||||||
// DeleteWebhook holds parameters for the deleteWebhook method.
|
// DeleteWebhook holds parameters for the deleteWebhook method.
|
||||||
// See https://core.telegram.org/bots/api#deletewebhook
|
// See https://core.telegram.org/bots/api#deletewebhook
|
||||||
type DeleteWebhook struct {
|
type DeleteWebhook struct {
|
||||||
|
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -192,6 +228,7 @@ func (api *API) GetWebhookInfoWithContext(ctx context.Context) (WebhookInfo, err
|
|||||||
// GetFile holds parameters for the getFile method.
|
// GetFile holds parameters for the getFile method.
|
||||||
// See https://core.telegram.org/bots/api#getfile
|
// See https://core.telegram.org/bots/api#getfile
|
||||||
type GetFile struct {
|
type GetFile struct {
|
||||||
|
// FileID Required. File identifier to get information about
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -213,6 +250,8 @@ func (api *API) GetFileWithContext(ctx context.Context, params GetFile) (File, e
|
|||||||
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
|
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
|
||||||
// The link is usually obtained from File.FilePath.
|
// The link is usually obtained from File.FilePath.
|
||||||
// For large files, prefer OpenFileByLink or OpenFileByLinkWithContext to stream the response body.
|
// For large files, prefer OpenFileByLink or OpenFileByLinkWithContext to stream the response body.
|
||||||
|
// This unbounded helper is retained for v1 compatibility and is subject to change in v2;
|
||||||
|
// prefer GetFileByLinkLimit for untrusted or potentially large files.
|
||||||
// See https://core.telegram.org/bots/api#file
|
// See https://core.telegram.org/bots/api#file
|
||||||
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
||||||
return api.getFileByLink(context.Background(), link)
|
return api.getFileByLink(context.Background(), link)
|
||||||
@@ -226,6 +265,37 @@ func (api *API) GetFileByLinkWithContext(ctx context.Context, link string) ([]by
|
|||||||
return api.getFileByLink(ctx, link)
|
return api.getFileByLink(ctx, link)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetFileByLinkLimit downloads at most maxBytes from Telegram's file server.
|
||||||
|
// It returns ErrFileTooLarge when the response exceeds the limit.
|
||||||
|
func (api *API) GetFileByLinkLimit(link string, maxBytes int64) ([]byte, error) {
|
||||||
|
return api.GetFileByLinkLimitWithContext(context.Background(), link, maxBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileByLinkLimitWithContext is the context-aware variant of GetFileByLinkLimit.
|
||||||
|
func (api *API) GetFileByLinkLimitWithContext(ctx context.Context, link string, maxBytes int64) ([]byte, error) {
|
||||||
|
if maxBytes < 0 {
|
||||||
|
return nil, fmt.Errorf("maximum file size must not be negative: %d", maxBytes)
|
||||||
|
}
|
||||||
|
body, err := api.openFileByLink(ctx, link)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer func() { _ = body.Close() }()
|
||||||
|
|
||||||
|
readLimit := maxBytes
|
||||||
|
if readLimit < math.MaxInt64 {
|
||||||
|
readLimit++
|
||||||
|
}
|
||||||
|
data, err := io.ReadAll(io.LimitReader(body, readLimit))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if int64(len(data)) > maxBytes {
|
||||||
|
return nil, ErrFileTooLarge
|
||||||
|
}
|
||||||
|
return data, nil
|
||||||
|
}
|
||||||
|
|
||||||
// OpenFileByLink opens a streaming response body for a file hosted on Telegram's file server.
|
// OpenFileByLink opens a streaming response body for a file hosted on Telegram's file server.
|
||||||
// The caller must close the returned ReadCloser.
|
// The caller must close the returned ReadCloser.
|
||||||
// See https://core.telegram.org/bots/api#file
|
// See https://core.telegram.org/bots/api#file
|
||||||
@@ -266,7 +336,7 @@ func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser,
|
|||||||
|
|
||||||
res, err := api.client.Do(req)
|
res, err := api.client.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, redactHTTPError(err, api.token)
|
||||||
}
|
}
|
||||||
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
|
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
|
||||||
defer func() {
|
defer func() {
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package tgapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -109,6 +110,25 @@ func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGetFileByLinkLimitRejectsOversizedResponse(t *testing.T) {
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{Transport: roundTripFunc(func(_ *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader("12345")),
|
||||||
|
}, nil
|
||||||
|
})}),
|
||||||
|
)
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
|
||||||
|
_, err := api.GetFileByLinkLimit("files/report.txt", 4)
|
||||||
|
if !errors.Is(err, ErrFileTooLarge) {
|
||||||
|
t.Fatalf("expected ErrFileTooLarge, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestGetUpdatesOmitsAllowedUpdatesWhenEmpty(t *testing.T) {
|
func TestGetUpdatesOmitsAllowedUpdatesWhenEmpty(t *testing.T) {
|
||||||
var gotBody map[string]any
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,9 @@ import "context"
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||||
type SetPassportDataErrors struct {
|
type SetPassportDataErrors struct {
|
||||||
|
// UserID Required. User identifier
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Errors Required. A JSON-serialized Array describing the errors
|
||||||
Errors []PassportElementError `json:"errors"`
|
Errors []PassportElementError `json:"errors"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,16 +3,24 @@ package tgapi
|
|||||||
// PassportData contains information about Telegram Passport data shared with the bot.
|
// PassportData contains information about Telegram Passport data shared with the bot.
|
||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
type PassportData struct {
|
type PassportData struct {
|
||||||
|
// Data Array with information about documents and other Telegram Passport elements that was shared with the
|
||||||
|
// bot
|
||||||
Data []EncryptedPassportElement `json:"data"`
|
Data []EncryptedPassportElement `json:"data"`
|
||||||
|
// Credentials Encrypted credentials required to decrypt the data
|
||||||
Credentials EncryptedCredentials `json:"credentials"`
|
Credentials EncryptedCredentials `json:"credentials"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// PassportFile represents a file uploaded to Telegram Passport.
|
// PassportFile represents a file uploaded to Telegram Passport.
|
||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
type PassportFile struct {
|
type PassportFile struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// FileSize File size in bytes
|
||||||
FileSize int64 `json:"file_size"`
|
FileSize int64 `json:"file_size"`
|
||||||
|
// FileDate Unix time when the file was uploaded
|
||||||
FileDate int64 `json:"file_date"`
|
FileDate int64 `json:"file_date"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,23 +59,57 @@ const (
|
|||||||
// EncryptedPassportElement contains information about documents or other Telegram Passport elements.
|
// EncryptedPassportElement contains information about documents or other Telegram Passport elements.
|
||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
type EncryptedPassportElement struct {
|
type EncryptedPassportElement struct {
|
||||||
|
// Type Element type. One of “personal_details”, “passport”, “driver_license”,
|
||||||
|
// “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”,
|
||||||
|
// “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”,
|
||||||
|
// “email”.
|
||||||
Type PassportElementType `json:"type"`
|
Type PassportElementType `json:"type"`
|
||||||
|
// Data Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available
|
||||||
|
// only for “personal_details”, “passport”, “driver_license”, “identity_card”,
|
||||||
|
// “internal_passport” and “address” types. Can be decrypted and verified using the accompanying
|
||||||
|
// EncryptedCredentials.
|
||||||
Data string `json:"data,omitempty"`
|
Data string `json:"data,omitempty"`
|
||||||
|
// PhoneNumber Optional. User's verified phone number; available only for “phone_number” type
|
||||||
PhoneNumber string `json:"phone_number,omitempty"`
|
PhoneNumber string `json:"phone_number,omitempty"`
|
||||||
|
// Email Optional. User's verified email address; available only for “email” type
|
||||||
Email string `json:"email,omitempty"`
|
Email string `json:"email,omitempty"`
|
||||||
|
// Files Optional. Array of encrypted files with documents provided by the user; available only for
|
||||||
|
// “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and
|
||||||
|
// “temporary_registration” types. Files can be decrypted and verified using the accompanying
|
||||||
|
// EncryptedCredentials.
|
||||||
Files []PassportFile `json:"files,omitempty"`
|
Files []PassportFile `json:"files,omitempty"`
|
||||||
|
// FrontSide Optional. Encrypted file with the front side of the document, provided by the user; available
|
||||||
|
// only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file
|
||||||
|
// can be decrypted and verified using the accompanying EncryptedCredentials.
|
||||||
FrontSide *PassportFile `json:"front_side,omitempty"`
|
FrontSide *PassportFile `json:"front_side,omitempty"`
|
||||||
|
// ReverseSide Optional. Encrypted file with the reverse side of the document, provided by the user;
|
||||||
|
// available only for “driver_license” and “identity_card”. The file can be decrypted and verified
|
||||||
|
// using the accompanying EncryptedCredentials.
|
||||||
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
|
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
|
||||||
|
// Selfie Optional. Encrypted file with the selfie of the user holding a document, provided by the user;
|
||||||
|
// available if requested for “passport”, “driver_license”, “identity_card” and
|
||||||
|
// “internal_passport”. The file can be decrypted and verified using the accompanying
|
||||||
|
// EncryptedCredentials.
|
||||||
Selfie *PassportFile `json:"selfie,omitempty"`
|
Selfie *PassportFile `json:"selfie,omitempty"`
|
||||||
|
// Translation Optional. Array of encrypted files with translated versions of documents provided by the
|
||||||
|
// user; available if requested for “passport”, “driver_license”, “identity_card”,
|
||||||
|
// “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”,
|
||||||
|
// “passport_registration” and “temporary_registration” types. Files can be decrypted and verified
|
||||||
|
// using the accompanying EncryptedCredentials.
|
||||||
Translation *PassportFile `json:"translation,omitempty"`
|
Translation *PassportFile `json:"translation,omitempty"`
|
||||||
|
// Hash Base64-encoded element hash for using in PassportElementErrorUnspecified
|
||||||
Hash string `json:"hash,omitempty"`
|
Hash string `json:"hash,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// EncryptedCredentials contains data required for decrypting and authenticating EncryptedPassportElement.
|
// EncryptedCredentials contains data required for decrypting and authenticating EncryptedPassportElement.
|
||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
type EncryptedCredentials struct {
|
type EncryptedCredentials struct {
|
||||||
|
// Data Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets
|
||||||
|
// required for EncryptedPassportElement decryption and authentication
|
||||||
Data string `json:"data"`
|
Data string `json:"data"`
|
||||||
|
// Hash Base64-encoded data hash for data authentication
|
||||||
Hash string `json:"hash"`
|
Hash string `json:"hash"`
|
||||||
|
// Secret Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
|
||||||
Secret string `json:"secret"`
|
Secret string `json:"secret"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,16 +117,24 @@ type EncryptedCredentials struct {
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#passportelementerror
|
// See https://core.telegram.org/bots/api#passportelementerror
|
||||||
type PassportElementError struct {
|
type PassportElementError struct {
|
||||||
|
// Source identifies the source of the passport validation error.
|
||||||
Source string `json:"source"`
|
Source string `json:"source"`
|
||||||
|
// Type identifies the Telegram Passport element type with the error.
|
||||||
Type PassportElementType `json:"type"`
|
Type PassportElementType `json:"type"`
|
||||||
|
|
||||||
|
// FieldName Name of the data field which has the error
|
||||||
FieldName string `json:"field_name,omitempty"`
|
FieldName string `json:"field_name,omitempty"`
|
||||||
|
// DataHash Base64-encoded data hash
|
||||||
DataHash string `json:"data_hash,omitempty"`
|
DataHash string `json:"data_hash,omitempty"`
|
||||||
|
|
||||||
|
// FileHash is the base64-encoded hash of the file that contains the error.
|
||||||
FileHash string `json:"file_hash,omitempty"`
|
FileHash string `json:"file_hash,omitempty"`
|
||||||
|
// FileHashes List of base64-encoded file hashes
|
||||||
FileHashes []string `json:"file_hashes,omitempty"`
|
FileHashes []string `json:"file_hashes,omitempty"`
|
||||||
|
|
||||||
|
// ElementHash Base64-encoded element hash
|
||||||
ElementHash string `json:"element_hash,omitempty"`
|
ElementHash string `json:"element_hash,omitempty"`
|
||||||
|
|
||||||
|
// Message Error message
|
||||||
Message string `json:"message"`
|
Message string `json:"message"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,39 +6,103 @@ import "context"
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#sendinvoice
|
// See https://core.telegram.org/bots/api#sendinvoice
|
||||||
type SendInvoice struct {
|
type SendInvoice struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
// Title Required. Product name, 1-32 characters
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Description Required. Product description, 1-255 characters
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// Payload Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use
|
||||||
|
// it for your internal processes.
|
||||||
Payload string `json:"payload"`
|
Payload string `json:"payload"`
|
||||||
|
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||||
|
// payments in Telegram Stars.
|
||||||
ProviderToken string `json:"provider_token,omitempty"`
|
ProviderToken string `json:"provider_token,omitempty"`
|
||||||
|
// Currency Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for
|
||||||
|
// payments in Telegram Stars.
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// Prices Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax,
|
||||||
|
// discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in
|
||||||
|
// Telegram Stars.
|
||||||
Prices []LabeledPrice `json:"prices"`
|
Prices []LabeledPrice `json:"prices"`
|
||||||
|
|
||||||
|
// MaxTipAmount Optional. The maximum accepted amount for tips in the smallest units of the currency
|
||||||
|
// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See
|
||||||
|
// the exp parameter in currencies.json, it shows the number of digits past the decimal point for each
|
||||||
|
// currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
|
||||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||||
|
// SuggestedTipAmounts Optional. A JSON-serialized Array of suggested amounts of tips in the smallest units
|
||||||
|
// of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The
|
||||||
|
// suggested tip amounts must be positive, passed in a strictly increased order and must not exceed
|
||||||
|
// max_tip_amount.
|
||||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||||
|
// StartParameter Optional. Unique deep-linking parameter. If left empty, forwarded copies of the sent
|
||||||
|
// message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using
|
||||||
|
// the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep
|
||||||
|
// link to the bot (instead of a Pay button), with the value used as the start parameter.
|
||||||
StartParameter string `json:"start_parameter,omitempty"`
|
StartParameter string `json:"start_parameter,omitempty"`
|
||||||
|
// ProviderData Optional. JSON-serialized data about the invoice, which will be shared with the payment
|
||||||
|
// provider. A detailed description of required fields should be provided by the payment provider.
|
||||||
ProviderData string `json:"provider_data,omitempty"`
|
ProviderData string `json:"provider_data,omitempty"`
|
||||||
|
// PhotoURL Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing
|
||||||
|
// image for a service. People like it better when they see what they are paying for.
|
||||||
PhotoURL string `json:"photo_url,omitempty"`
|
PhotoURL string `json:"photo_url,omitempty"`
|
||||||
|
// PhotoSize Optional. Photo size in bytes
|
||||||
PhotoSize int `json:"photo_size,omitempty"`
|
PhotoSize int `json:"photo_size,omitempty"`
|
||||||
|
// PhotoWidth Optional. Photo width
|
||||||
PhotoWidth int `json:"photo_width,omitempty"`
|
PhotoWidth int `json:"photo_width,omitempty"`
|
||||||
|
// PhotoHeight Optional. Photo height
|
||||||
PhotoHeight int `json:"photo_height,omitempty"`
|
PhotoHeight int `json:"photo_height,omitempty"`
|
||||||
|
// NeedName Optional. Pass True if you require the user's full name to complete the order. Ignored for
|
||||||
|
// payments in Telegram Stars.
|
||||||
NeedName bool `json:"need_name,omitempty"`
|
NeedName bool `json:"need_name,omitempty"`
|
||||||
|
// NeedPhoneNumber Optional. Pass True if you require the user's phone number to complete the order. Ignored
|
||||||
|
// for payments in Telegram Stars.
|
||||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||||
|
// NeedEmail Optional. Pass True if you require the user's email address to complete the order. Ignored for
|
||||||
|
// payments in Telegram Stars.
|
||||||
NeedEmail bool `json:"need_email,omitempty"`
|
NeedEmail bool `json:"need_email,omitempty"`
|
||||||
|
// NeedShippingAddress Optional. Pass True if you require the user's shipping address to complete the order.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||||
|
// SendPhoneToProvider Optional. Pass True if the user's phone number should be sent to the provider.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||||
|
// SendEmailToProvider Optional. Pass True if the user's email address should be sent to the provider.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||||
|
// IsFlexible Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
|
||||||
|
// Telegram Stars.
|
||||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price'
|
||||||
|
// button will be shown. If not empty, the first button must be a Pay button.
|
||||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -63,29 +127,76 @@ func (api *API) SendInvoiceWithContext(ctx context.Context, params SendInvoice)
|
|||||||
// Since: Bot API 6.1
|
// Since: Bot API 6.1
|
||||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||||
type CreateInvoiceLink struct {
|
type CreateInvoiceLink struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the link
|
||||||
|
// will be created. For payments in Telegram Stars only.
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
|
||||||
|
// Title Required. Product name, 1-32 characters
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Description Required. Product description, 1-255 characters
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// Payload Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use
|
||||||
|
// it for your internal processes.
|
||||||
Payload string `json:"payload"`
|
Payload string `json:"payload"`
|
||||||
|
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||||
|
// payments in Telegram Stars.
|
||||||
ProviderToken string `json:"provider_token,omitempty"`
|
ProviderToken string `json:"provider_token,omitempty"`
|
||||||
|
// Currency Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for
|
||||||
|
// payments in Telegram Stars.
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// Prices Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax,
|
||||||
|
// discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in
|
||||||
|
// Telegram Stars.
|
||||||
Prices []LabeledPrice `json:"prices"`
|
Prices []LabeledPrice `json:"prices"`
|
||||||
|
|
||||||
|
// SubscriptionPeriod Optional. The number of seconds the subscription will be active for before the next
|
||||||
|
// payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it
|
||||||
|
// must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot
|
||||||
|
// at the same time, including multiple concurrent subscriptions from the same user. Subscription price must
|
||||||
|
// no exceed 10000 Telegram Stars.
|
||||||
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||||
|
// MaxTipAmount Optional. The maximum accepted amount for tips in the smallest units of the currency
|
||||||
|
// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See
|
||||||
|
// the exp parameter in currencies.json, it shows the number of digits past the decimal point for each
|
||||||
|
// currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
|
||||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||||
|
// SuggestedTipAmounts Optional. A JSON-serialized Array of suggested amounts of tips in the smallest units
|
||||||
|
// of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The
|
||||||
|
// suggested tip amounts must be positive, passed in a strictly increased order and must not exceed
|
||||||
|
// max_tip_amount.
|
||||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||||
|
// ProviderData Optional. JSON-serialized data about the invoice, which will be shared with the payment
|
||||||
|
// provider. A detailed description of required fields should be provided by the payment provider.
|
||||||
ProviderData string `json:"provider_data,omitempty"`
|
ProviderData string `json:"provider_data,omitempty"`
|
||||||
|
// PhotoURL Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing
|
||||||
|
// image for a service.
|
||||||
PhotoURL string `json:"photo_url,omitempty"`
|
PhotoURL string `json:"photo_url,omitempty"`
|
||||||
|
// PhotoSize Optional. Photo size in bytes
|
||||||
PhotoSize int `json:"photo_size,omitempty"`
|
PhotoSize int `json:"photo_size,omitempty"`
|
||||||
|
// PhotoWidth Optional. Photo width
|
||||||
PhotoWidth int `json:"photo_width,omitempty"`
|
PhotoWidth int `json:"photo_width,omitempty"`
|
||||||
|
// PhotoHeight Optional. Photo height
|
||||||
PhotoHeight int `json:"photo_height,omitempty"`
|
PhotoHeight int `json:"photo_height,omitempty"`
|
||||||
|
// NeedName Optional. Pass True if you require the user's full name to complete the order. Ignored for
|
||||||
|
// payments in Telegram Stars.
|
||||||
NeedName bool `json:"need_name,omitempty"`
|
NeedName bool `json:"need_name,omitempty"`
|
||||||
|
// NeedPhoneNumber Optional. Pass True if you require the user's phone number to complete the order. Ignored
|
||||||
|
// for payments in Telegram Stars.
|
||||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||||
|
// NeedEmail Optional. Pass True if you require the user's email address to complete the order. Ignored for
|
||||||
|
// payments in Telegram Stars.
|
||||||
NeedEmail bool `json:"need_email,omitempty"`
|
NeedEmail bool `json:"need_email,omitempty"`
|
||||||
|
// NeedShippingAddress Optional. Pass True if you require the user's shipping address to complete the order.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||||
|
// SendPhoneToProvider Optional. Pass True if the user's phone number should be sent to the provider.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||||
|
// SendEmailToProvider Optional. Pass True if the user's email address should be sent to the provider.
|
||||||
|
// Ignored for payments in Telegram Stars.
|
||||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||||
|
// IsFlexible Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
|
||||||
|
// Telegram Stars.
|
||||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -110,9 +221,16 @@ func (api *API) CreateInvoiceLinkWithContext(ctx context.Context, params CreateI
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#answershippingquery
|
// See https://core.telegram.org/bots/api#answershippingquery
|
||||||
type AnswerShippingQuery struct {
|
type AnswerShippingQuery struct {
|
||||||
|
// ShippingQueryID Required. Unique identifier for the query to be answered
|
||||||
ShippingQueryID string `json:"shipping_query_id"`
|
ShippingQueryID string `json:"shipping_query_id"`
|
||||||
|
// OK Required. Pass True if delivery to the specified address is possible and False if there are any
|
||||||
|
// problems (for example, if delivery to the specified address is not possible)
|
||||||
OK bool `json:"ok"`
|
OK bool `json:"ok"`
|
||||||
|
// ShippingOptions Optional. Required if ok is True. A JSON-serialized Array of available shipping options.
|
||||||
ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
|
ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
|
||||||
|
// ErrorMessage Optional. Required if ok is False. Error message in human readable form that explains why it
|
||||||
|
// is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”).
|
||||||
|
// Telegram will display this message to the user.
|
||||||
ErrorMessage string `json:"error_message,omitempty"`
|
ErrorMessage string `json:"error_message,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -138,8 +256,15 @@ func (api *API) AnswerShippingQueryWithContext(ctx context.Context, params Answe
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||||
type AnswerPreCheckoutQuery struct {
|
type AnswerPreCheckoutQuery struct {
|
||||||
|
// PreCheckoutQueryID Required. Unique identifier for the query to be answered
|
||||||
PreCheckoutQueryID string `json:"pre_checkout_query_id"`
|
PreCheckoutQueryID string `json:"pre_checkout_query_id"`
|
||||||
|
// OK Required. Specify True if everything is alright (goods are available, etc.) and the bot is ready to
|
||||||
|
// proceed with the order. Use False if there are any problems.
|
||||||
OK bool `json:"ok"`
|
OK bool `json:"ok"`
|
||||||
|
// ErrorMessage Optional. Required if ok is False. Error message in human readable form that explains the
|
||||||
|
// reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our
|
||||||
|
// amazing black T-shirts while you were busy filling out your payment details. Please choose a different
|
||||||
|
// color or garment!"). Telegram will display this message to the user.
|
||||||
ErrorMessage string `json:"error_message,omitempty"`
|
ErrorMessage string `json:"error_message,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+62
-2
@@ -4,17 +4,28 @@ package tgapi
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#labeledprice
|
// See https://core.telegram.org/bots/api#labeledprice
|
||||||
type LabeledPrice struct {
|
type LabeledPrice struct {
|
||||||
|
// Label Portion label
|
||||||
Label string `json:"label"`
|
Label string `json:"label"`
|
||||||
|
// Amount Price of the product in the smallest units of the currency (integer, not float/double). For
|
||||||
|
// example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows
|
||||||
|
// the number of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||||
Amount int `json:"amount"`
|
Amount int `json:"amount"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Invoice contains basic information about an invoice.
|
// Invoice contains basic information about an invoice.
|
||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
type Invoice struct {
|
type Invoice struct {
|
||||||
|
// Title Product name
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Description Product description
|
||||||
Description string `json:"description"`
|
Description string `json:"description"`
|
||||||
|
// StartParameter Unique bot deep-linking parameter that can be used to generate this invoice
|
||||||
StartParameter string `json:"start_parameter"`
|
StartParameter string `json:"start_parameter"`
|
||||||
|
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||||
|
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||||
|
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||||
TotalAmount int `json:"total_amount"`
|
TotalAmount int `json:"total_amount"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -22,9 +33,13 @@ type Invoice struct {
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#shippingquery
|
// See https://core.telegram.org/bots/api#shippingquery
|
||||||
type ShippingQuery struct {
|
type ShippingQuery struct {
|
||||||
|
// ID Unique query identifier
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// From User who sent the query
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// InvoicePayload Bot-specified invoice payload
|
||||||
InvoicePayload string `json:"invoice_payload"`
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
// ShippingAddress User specified shipping address
|
||||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,11 +47,17 @@ type ShippingQuery struct {
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#shippingaddress
|
// See https://core.telegram.org/bots/api#shippingaddress
|
||||||
type ShippingAddress struct {
|
type ShippingAddress struct {
|
||||||
|
// CountryCode Two-letter ISO 3166-1 alpha-2 country code
|
||||||
CountryCode string `json:"country_code"`
|
CountryCode string `json:"country_code"`
|
||||||
|
// State State, if applicable
|
||||||
State string `json:"state"`
|
State string `json:"state"`
|
||||||
|
// City City
|
||||||
City string `json:"city"`
|
City string `json:"city"`
|
||||||
|
// StreetLine1 First line for the address
|
||||||
StreetLine1 string `json:"street_line1"`
|
StreetLine1 string `json:"street_line1"`
|
||||||
|
// StreetLine2 Second line for the address
|
||||||
StreetLine2 string `json:"street_line2"`
|
StreetLine2 string `json:"street_line2"`
|
||||||
|
// PostCode Address post code
|
||||||
PostCode string `json:"post_code"`
|
PostCode string `json:"post_code"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -44,9 +65,13 @@ type ShippingAddress struct {
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#orderinfo
|
// See https://core.telegram.org/bots/api#orderinfo
|
||||||
type OrderInfo struct {
|
type OrderInfo struct {
|
||||||
|
// Name Optional. User name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// PhoneNumber Optional. User's phone number
|
||||||
PhoneNumber string `json:"phone_number"`
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
// Email Optional. User email
|
||||||
Email string `json:"email"`
|
Email string `json:"email"`
|
||||||
|
// ShippingAddress Optional. User shipping address
|
||||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,12 +79,21 @@ type OrderInfo struct {
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#precheckoutquery
|
// See https://core.telegram.org/bots/api#precheckoutquery
|
||||||
type PreCheckoutQuery struct {
|
type PreCheckoutQuery struct {
|
||||||
|
// ID Unique query identifier
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// From User who sent the query
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||||
|
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||||
|
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||||
TotalAmount int `json:"total_amount"`
|
TotalAmount int `json:"total_amount"`
|
||||||
|
// InvoicePayload Bot-specified invoice payload
|
||||||
InvoicePayload string `json:"invoice_payload"`
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||||
ShippingOptionID string `json:"shipping_option_id"`
|
ShippingOptionID string `json:"shipping_option_id"`
|
||||||
|
// OrderInfo Optional. Order information provided by the user
|
||||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -67,7 +101,9 @@ type PreCheckoutQuery struct {
|
|||||||
// Since: Bot API 7.10
|
// Since: Bot API 7.10
|
||||||
// See https://core.telegram.org/bots/api#paidmediapurchased
|
// See https://core.telegram.org/bots/api#paidmediapurchased
|
||||||
type PaidMediaPurchased struct {
|
type PaidMediaPurchased struct {
|
||||||
|
// From User who purchased the media
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// PaidMediaPayload Bot-specified paid media payload
|
||||||
PaidMediaPayload string `json:"paid_media_payload"`
|
PaidMediaPayload string `json:"paid_media_payload"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,35 +111,59 @@ type PaidMediaPurchased struct {
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#shippingoption
|
// See https://core.telegram.org/bots/api#shippingoption
|
||||||
type ShippingOption struct {
|
type ShippingOption struct {
|
||||||
|
// ID Shipping option identifier
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// Title Option title
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Prices List of price portions
|
||||||
Prices []LabeledPrice `json:"prices"`
|
Prices []LabeledPrice `json:"prices"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SuccessfulPayment contains basic information about a successful payment.
|
// SuccessfulPayment contains basic information about a successful payment.
|
||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
type SuccessfulPayment struct {
|
type SuccessfulPayment struct {
|
||||||
|
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||||
|
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||||
|
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||||
TotalAmount int `json:"total_amount"`
|
TotalAmount int `json:"total_amount"`
|
||||||
|
// InvoicePayload Bot-specified invoice payload
|
||||||
InvoicePayload string `json:"invoice_payload"`
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
|
||||||
|
// SubscriptionExpirationDate Optional. Expiration date of the subscription, in Unix time; for recurring
|
||||||
|
// payments only
|
||||||
SubscriptionExpirationDate int `json:"subscription_expiration_date,omitempty"` // Since: Bot API 8.0
|
SubscriptionExpirationDate int `json:"subscription_expiration_date,omitempty"` // Since: Bot API 8.0
|
||||||
|
// IsRecurring Optional. True, if the payment is a recurring payment for a subscription
|
||||||
IsRecurring bool `json:"is_recurring,omitempty"` // Since: Bot API 8.0
|
IsRecurring bool `json:"is_recurring,omitempty"` // Since: Bot API 8.0
|
||||||
|
// IsFirstRecurring Optional. True, if the payment is the first payment for a subscription
|
||||||
IsFirstRecurring bool `json:"is_first_recurring,omitempty"` // Since: Bot API 8.0
|
IsFirstRecurring bool `json:"is_first_recurring,omitempty"` // Since: Bot API 8.0
|
||||||
|
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||||
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
||||||
|
// OrderInfo Optional. Order information provided by the user
|
||||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||||
|
|
||||||
|
// TelegramPaymentChargeID Telegram payment identifier
|
||||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
ProviderPaymentChargeID string `json:"proviced_payment_charge_id"`
|
// ProviderPaymentChargeID Provider payment identifier
|
||||||
|
ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// RefundedPayment contains basic information about a refunded payment.
|
// RefundedPayment contains basic information about a refunded payment.
|
||||||
// Since: Bot API 7.7
|
// Since: Bot API 7.7
|
||||||
type RefundedPayment struct {
|
type RefundedPayment struct {
|
||||||
|
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently,
|
||||||
|
// always “XTR”.
|
||||||
Currency string `json:"currency"`
|
Currency string `json:"currency"`
|
||||||
|
// TotalAmount Total refunded price in the smallest units of the currency (integer, not float/double). For
|
||||||
|
// example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows
|
||||||
|
// the number of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||||
TotalAmount int `json:"total_amount"`
|
TotalAmount int `json:"total_amount"`
|
||||||
|
// InvoicePayload Bot-specified invoice payload
|
||||||
InvoicePayload string `json:"invoice_payload"`
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
|
||||||
|
// TelegramPaymentChargeID Telegram payment identifier
|
||||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
ProviderPaymentChargeID string `json:"proviced_payment_charge_id,omitempty"`
|
// ProviderPaymentChargeID Optional. Provider payment identifier
|
||||||
|
ProviderPaymentChargeID string `json:"provider_payment_charge_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|||||||
+9
-4
@@ -2,6 +2,7 @@ package tgapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -126,10 +127,14 @@ func (p *workerPool) worker() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (p *workerPool) executeEnvelope(envelope requestEnvelope) {
|
func (p *workerPool) executeEnvelope(envelope requestEnvelope) {
|
||||||
value, err := envelope.doFunc(envelope.ctx)
|
result := requestResult{}
|
||||||
envelope.resultCh <- requestResult{
|
defer func() {
|
||||||
value: value,
|
if recovered := recover(); recovered != nil {
|
||||||
err: err,
|
result.value = nil
|
||||||
|
result.err = fmt.Errorf("%w: %v", ErrPoolWorkerPanic, recovered)
|
||||||
}
|
}
|
||||||
|
envelope.resultCh <- result
|
||||||
close(envelope.resultCh)
|
close(envelope.resultCh)
|
||||||
|
}()
|
||||||
|
result.value, result.err = envelope.doFunc(envelope.ctx)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,6 +18,34 @@ func TestWorkerPoolSubmitAfterStop(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestWorkerPoolRecoversTaskPanicAndContinues(t *testing.T) {
|
||||||
|
pool := newWorkerPool(1, 2)
|
||||||
|
pool.start()
|
||||||
|
defer pool.stop()
|
||||||
|
|
||||||
|
panicked, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
panic("boom")
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("submit panic task returned error: %v", err)
|
||||||
|
}
|
||||||
|
result := <-panicked
|
||||||
|
if !errors.Is(result.err, ErrPoolWorkerPanic) {
|
||||||
|
t.Fatalf("expected ErrPoolWorkerPanic, got %v", result.err)
|
||||||
|
}
|
||||||
|
|
||||||
|
continued, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
return "ok", nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("submit follow-up returned error: %v", err)
|
||||||
|
}
|
||||||
|
result = <-continued
|
||||||
|
if result.err != nil || result.value != "ok" {
|
||||||
|
t.Fatalf("worker did not continue: %#v", result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestWorkerPoolQueueFull(t *testing.T) {
|
func TestWorkerPoolQueueFull(t *testing.T) {
|
||||||
pool := newWorkerPool(1, 1)
|
pool := newWorkerPool(1, 1)
|
||||||
pool.start()
|
pool.start()
|
||||||
|
|||||||
@@ -66,7 +66,9 @@ type RichBlockListItem struct {
|
|||||||
HasCheckbox bool
|
HasCheckbox bool
|
||||||
// IsChecked reports whether the list-item checkbox is checked.
|
// IsChecked reports whether the list-item checkbox is checked.
|
||||||
IsChecked bool
|
IsChecked bool
|
||||||
|
// Value is the numeric marker value for an ordered list item.
|
||||||
Value int // for ordered lists: numeric value of the marker
|
Value int // for ordered lists: numeric value of the marker
|
||||||
|
// Type selects the ordered-list marker style: a, A, i, I, or 1.
|
||||||
Type RichBlockListItemType // for ordered lists: "a", "A", "i", "I" or "1"
|
Type RichBlockListItemType // for ordered lists: "a", "A", "i", "I" or "1"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -119,7 +121,9 @@ type RichBlockTableCell struct {
|
|||||||
ColSpan int
|
ColSpan int
|
||||||
// RowSpan is the number of table rows spanned by the cell.
|
// RowSpan is the number of table rows spanned by the cell.
|
||||||
RowSpan int
|
RowSpan int
|
||||||
|
// Align is the horizontal alignment: left, center, or right.
|
||||||
Align string // "left", "center" or "right"
|
Align string // "left", "center" or "right"
|
||||||
|
// VAlign is the vertical alignment: top, middle, or bottom.
|
||||||
VAlign string // "top", "middle" or "bottom"
|
VAlign string // "top", "middle" or "bottom"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -192,6 +196,7 @@ var richBlockWrapTags = map[string]bool{
|
|||||||
type RichBlockSectionHeading struct {
|
type RichBlockSectionHeading struct {
|
||||||
// Text contains the formatted or plain text content.
|
// Text contains the formatted or plain text content.
|
||||||
Text RichText
|
Text RichText
|
||||||
|
// Size is the heading level from 1 through 6, where 1 is largest.
|
||||||
Size int // 1-6, 1 is the largest
|
Size int // 1-6, 1 is the largest
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -405,6 +410,7 @@ func (b RichBlockTable) MarshalJSON() ([]byte, error) {
|
|||||||
type RichBlockMap struct {
|
type RichBlockMap struct {
|
||||||
// Location contains the map location.
|
// Location contains the map location.
|
||||||
Location Location
|
Location Location
|
||||||
|
// Zoom is the map zoom level in the range 13 through 20.
|
||||||
Zoom int // 13-20
|
Zoom int // 13-20
|
||||||
// Width is the requested media or map width in pixels.
|
// Width is the requested media or map width in pixels.
|
||||||
Width int
|
Width int
|
||||||
|
|||||||
+94
-6
@@ -3,16 +3,31 @@ package tgapi
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
maximumRichJSONDepth = 64
|
||||||
|
maximumRichJSONNodes = 10_000
|
||||||
)
|
)
|
||||||
|
|
||||||
// UnmarshalRichText parses a RichText tree from JSON: a string, an array, or
|
// UnmarshalRichText parses a RichText tree from JSON: a string, an array, or
|
||||||
// a typed object. Unknown object types that carry a text field are preserved
|
// a typed object. Unknown object types that carry a text field are preserved
|
||||||
// as RichTextWrap so their nested text remains usable; unmodeled fields are
|
// as RichTextWrap so their nested text remains usable; unmodeled fields are
|
||||||
// discarded.
|
// discarded. The fallback representation is subject to change in v2 so unknown
|
||||||
|
// fields can be preserved losslessly.
|
||||||
//
|
//
|
||||||
// Since: Bot API 10.1
|
// Since: Bot API 10.1
|
||||||
func UnmarshalRichText(data []byte) (RichText, error) {
|
func UnmarshalRichText(data []byte) (RichText, error) {
|
||||||
|
if err := validateRichJSON(data); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return unmarshalRichText(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func unmarshalRichText(data []byte) (RichText, error) {
|
||||||
if bytes.Equal(bytes.TrimSpace(data), []byte("null")) {
|
if bytes.Equal(bytes.TrimSpace(data), []byte("null")) {
|
||||||
return nil, fmt.Errorf("richtext: null is not a rich text value")
|
return nil, fmt.Errorf("richtext: null is not a rich text value")
|
||||||
}
|
}
|
||||||
@@ -26,7 +41,7 @@ func UnmarshalRichText(data []byte) (RichText, error) {
|
|||||||
if err := json.Unmarshal(data, &raw); err == nil {
|
if err := json.Unmarshal(data, &raw); err == nil {
|
||||||
arr := make(RichTextArray, len(raw))
|
arr := make(RichTextArray, len(raw))
|
||||||
for i, it := range raw {
|
for i, it := range raw {
|
||||||
rt, err := UnmarshalRichText(it)
|
rt, err := unmarshalRichText(it)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -47,7 +62,7 @@ func UnmarshalRichText(data []byte) (RichText, error) {
|
|||||||
var inner RichText
|
var inner RichText
|
||||||
if len(head.Text) > 0 {
|
if len(head.Text) > 0 {
|
||||||
var err error
|
var err error
|
||||||
if inner, err = UnmarshalRichText(head.Text); err != nil {
|
if inner, err = unmarshalRichText(head.Text); err != nil {
|
||||||
return nil, fmt.Errorf("richtext %q: bad text: %w", head.Type, err)
|
return nil, fmt.Errorf("richtext %q: bad text: %w", head.Type, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -202,10 +217,18 @@ func UnmarshalRichText(data []byte) (RichText, error) {
|
|||||||
|
|
||||||
// UnmarshalRichBlock parses a single RichBlock from JSON, dispatching on the
|
// UnmarshalRichBlock parses a single RichBlock from JSON, dispatching on the
|
||||||
// type tag. Unknown types that carry a text field are decoded as RichBlockWrap
|
// type tag. Unknown types that carry a text field are decoded as RichBlockWrap
|
||||||
// so their nested text remains usable; unmodeled fields are discarded.
|
// so their nested text remains usable; unmodeled fields are discarded. The
|
||||||
|
// fallback representation is subject to change in v2 for lossless round trips.
|
||||||
//
|
//
|
||||||
// Since: Bot API 10.1
|
// Since: Bot API 10.1
|
||||||
func UnmarshalRichBlock(data []byte) (RichBlock, error) {
|
func UnmarshalRichBlock(data []byte) (RichBlock, error) {
|
||||||
|
if err := validateRichJSON(data); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return unmarshalRichBlock(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func unmarshalRichBlock(data []byte) (RichBlock, error) {
|
||||||
var head struct {
|
var head struct {
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
Text json.RawMessage `json:"text"`
|
Text json.RawMessage `json:"text"`
|
||||||
@@ -454,8 +477,19 @@ func UnmarshalRichBlock(data []byte) (RichBlock, error) {
|
|||||||
|
|
||||||
// UnmarshalRichMessage parses a root RichMessage from JSON.
|
// UnmarshalRichMessage parses a root RichMessage from JSON.
|
||||||
//
|
//
|
||||||
|
// For v1 compatibility, missing and null blocks are accepted as an empty
|
||||||
|
// message. This permissive behavior is subject to change in v2; use
|
||||||
|
// UnmarshalRichMessageStrict when validating untrusted input.
|
||||||
|
//
|
||||||
// Since: Bot API 10.1
|
// Since: Bot API 10.1
|
||||||
func UnmarshalRichMessage(data []byte) (RichMessage, error) {
|
func UnmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||||
|
if err := validateRichJSON(data); err != nil {
|
||||||
|
return RichMessage{}, err
|
||||||
|
}
|
||||||
|
return unmarshalRichMessage(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func unmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||||
var raw struct {
|
var raw struct {
|
||||||
Blocks json.RawMessage `json:"blocks"`
|
Blocks json.RawMessage `json:"blocks"`
|
||||||
IsRTL bool `json:"is_rtl"`
|
IsRTL bool `json:"is_rtl"`
|
||||||
@@ -470,6 +504,28 @@ func UnmarshalRichMessage(data []byte) (RichMessage, error) {
|
|||||||
return RichMessage{blocks, raw.IsRTL}, nil
|
return RichMessage{blocks, raw.IsRTL}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UnmarshalRichMessageStrict parses a RichMessage and requires a non-null blocks array.
|
||||||
|
//
|
||||||
|
// Since: Bot API 10.1
|
||||||
|
func UnmarshalRichMessageStrict(data []byte) (RichMessage, error) {
|
||||||
|
if err := validateRichJSON(data); err != nil {
|
||||||
|
return RichMessage{}, err
|
||||||
|
}
|
||||||
|
var root map[string]json.RawMessage
|
||||||
|
if err := json.Unmarshal(data, &root); err != nil {
|
||||||
|
return RichMessage{}, fmt.Errorf("richmessage: %w", err)
|
||||||
|
}
|
||||||
|
blocks, ok := root["blocks"]
|
||||||
|
if !ok || bytes.Equal(bytes.TrimSpace(blocks), []byte("null")) {
|
||||||
|
return RichMessage{}, errors.New("richmessage: blocks must be a non-null array")
|
||||||
|
}
|
||||||
|
var rawBlocks []json.RawMessage
|
||||||
|
if err := json.Unmarshal(blocks, &rawBlocks); err != nil {
|
||||||
|
return RichMessage{}, errors.New("richmessage: blocks must be an array")
|
||||||
|
}
|
||||||
|
return unmarshalRichMessage(data)
|
||||||
|
}
|
||||||
|
|
||||||
// UnmarshalJSON implements json.Unmarshaler.
|
// UnmarshalJSON implements json.Unmarshaler.
|
||||||
//
|
//
|
||||||
// Since: Bot API 10.1
|
// Since: Bot API 10.1
|
||||||
@@ -491,7 +547,7 @@ func parseOptRichText(raw json.RawMessage) (RichText, error) {
|
|||||||
if len(raw) == 0 || string(raw) == "null" {
|
if len(raw) == 0 || string(raw) == "null" {
|
||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
return UnmarshalRichText(raw)
|
return unmarshalRichText(raw)
|
||||||
}
|
}
|
||||||
|
|
||||||
func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
||||||
@@ -504,7 +560,7 @@ func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
|||||||
}
|
}
|
||||||
blocks := make([]RichBlock, len(raws))
|
blocks := make([]RichBlock, len(raws))
|
||||||
for i, r := range raws {
|
for i, r := range raws {
|
||||||
b, err := UnmarshalRichBlock(r)
|
b, err := unmarshalRichBlock(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -512,3 +568,35 @@ func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
|||||||
}
|
}
|
||||||
return blocks, nil
|
return blocks, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func validateRichJSON(data []byte) error {
|
||||||
|
decoder := json.NewDecoder(bytes.NewReader(data))
|
||||||
|
depth := 0
|
||||||
|
nodes := 0
|
||||||
|
for {
|
||||||
|
token, err := decoder.Token()
|
||||||
|
if errors.Is(err, io.EOF) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
nodes++
|
||||||
|
if nodes > maximumRichJSONNodes {
|
||||||
|
return fmt.Errorf("%w: maximum %d", ErrRichJSONNodes, maximumRichJSONNodes)
|
||||||
|
}
|
||||||
|
delim, ok := token.(json.Delim)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch delim {
|
||||||
|
case '{', '[':
|
||||||
|
depth++
|
||||||
|
if depth > maximumRichJSONDepth {
|
||||||
|
return fmt.Errorf("%w: maximum %d", ErrRichJSONDepth, maximumRichJSONDepth)
|
||||||
|
}
|
||||||
|
case '}', ']':
|
||||||
|
depth--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package tgapi
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
@@ -266,3 +267,28 @@ func TestUnmarshalRichBlockRejectsMalformedFields(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalRichMessageStrict(t *testing.T) {
|
||||||
|
for _, raw := range []string{`null`, `{}`, `{"blocks":null}`, `{"blocks":{}}`} {
|
||||||
|
t.Run(raw, func(t *testing.T) {
|
||||||
|
if _, err := UnmarshalRichMessageStrict([]byte(raw)); err == nil {
|
||||||
|
t.Fatal("expected strict decoder error")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if _, err := UnmarshalRichMessageStrict([]byte(`{"blocks":[]}`)); err != nil {
|
||||||
|
t.Fatalf("strict decoder rejected an empty blocks array: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRichJSONStructuralLimits(t *testing.T) {
|
||||||
|
deep := strings.Repeat("[", maximumRichJSONDepth+1) + `"x"` + strings.Repeat("]", maximumRichJSONDepth+1)
|
||||||
|
if _, err := UnmarshalRichText([]byte(deep)); !errors.Is(err, ErrRichJSONDepth) {
|
||||||
|
t.Fatalf("expected ErrRichJSONDepth, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
wide := "[" + strings.Repeat("0,", maximumRichJSONNodes) + "0]"
|
||||||
|
if _, err := UnmarshalRichText([]byte(wide)); !errors.Is(err, ErrRichJSONNodes) {
|
||||||
|
t.Fatalf("expected ErrRichJSONNodes, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,7 +6,10 @@ import "context"
|
|||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
// See https://core.telegram.org/bots/api#getstartransactions
|
// See https://core.telegram.org/bots/api#getstartransactions
|
||||||
type GetStarTransactions struct {
|
type GetStarTransactions struct {
|
||||||
|
// Offset Optional. Number of transactions to skip in the response
|
||||||
Offset int `json:"offset,omitempty"`
|
Offset int `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. The maximum number of transactions to be retrieved. Values between 1-100 are accepted.
|
||||||
|
// Defaults to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -48,7 +51,9 @@ func (api *API) GetStarTransactionsWithContext(ctx context.Context, params GetSt
|
|||||||
// Since: Bot API 7.4
|
// Since: Bot API 7.4
|
||||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||||
type RefundStarPayment struct {
|
type RefundStarPayment struct {
|
||||||
|
// UserID Required. Identifier of the user whose payment will be refunded
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// TelegramPaymentChargeID Required. Telegram payment identifier
|
||||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,8 +79,13 @@ func (api *API) RefundStarPaymentWithContext(ctx context.Context, params RefundS
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||||
type EditUserStarSubscription struct {
|
type EditUserStarSubscription struct {
|
||||||
|
// UserID Required. Identifier of the user whose subscription will be edited
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// TelegramPaymentChargeID Required. Telegram payment identifier for the subscription
|
||||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
|
// IsCanceled Required. Pass True to cancel extension of the user subscription; the subscription must be
|
||||||
|
// active up to the end of the current subscription period. Pass False to allow the user to re-enable a
|
||||||
|
// subscription that was previously canceled by the bot.
|
||||||
IsCanceled bool `json:"is_canceled"`
|
IsCanceled bool `json:"is_canceled"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,11 +4,22 @@ package tgapi
|
|||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
// See https://core.telegram.org/bots/api#startransaction
|
// See https://core.telegram.org/bots/api#startransaction
|
||||||
type StarTransaction struct {
|
type StarTransaction struct {
|
||||||
|
// ID Unique identifier of the transaction. Coincides with the identifier of the original transaction for
|
||||||
|
// refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming
|
||||||
|
// payments from users.
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// Amount Integer amount of Telegram Stars transferred by the transaction
|
||||||
Amount int `json:"amount"`
|
Amount int `json:"amount"`
|
||||||
|
// NanostarAmount Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the
|
||||||
|
// transaction; from 0 to 999999999
|
||||||
NanostarAmount int `json:"nanostar_amount,omitempty"`
|
NanostarAmount int `json:"nanostar_amount,omitempty"`
|
||||||
|
// Date Date the transaction was created in Unix time
|
||||||
Date int `json:"date"`
|
Date int `json:"date"`
|
||||||
|
// Source Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment
|
||||||
|
// refunding a failed withdrawal). Only for incoming transactions.
|
||||||
Source map[string]any `json:"source,omitempty"`
|
Source map[string]any `json:"source,omitempty"`
|
||||||
|
// Receiver Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for
|
||||||
|
// a withdrawal). Only for outgoing transactions.
|
||||||
Receiver map[string]any `json:"receiver,omitempty"`
|
Receiver map[string]any `json:"receiver,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -16,5 +27,6 @@ type StarTransaction struct {
|
|||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
// See https://core.telegram.org/bots/api#startransactions
|
// See https://core.telegram.org/bots/api#startransactions
|
||||||
type StarTransactions struct {
|
type StarTransactions struct {
|
||||||
|
// Transactions The list of transactions
|
||||||
Transactions []StarTransaction `json:"transactions"`
|
Transactions []StarTransaction `json:"transactions"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,24 +6,51 @@ import "context"
|
|||||||
// Since: Bot API 1.3
|
// Since: Bot API 1.3
|
||||||
// See https://core.telegram.org/bots/api#sendsticker
|
// See https://core.telegram.org/bots/api#sendsticker
|
||||||
type SendSticker struct {
|
type SendSticker struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Sticker Required. Sticker to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||||
|
// servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the
|
||||||
|
// Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on
|
||||||
|
// Sending Files ». Video and animated stickers can't be sent via an HTTP URL.
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||||
Emoji string `json:"emoji,omitempty"`
|
Emoji string `json:"emoji,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -48,6 +75,7 @@ func (api *API) SendStickerWithContext(ctx context.Context, params SendSticker)
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#getstickerset
|
// See https://core.telegram.org/bots/api#getstickerset
|
||||||
type GetStickerSet struct {
|
type GetStickerSet struct {
|
||||||
|
// Name Required. Name of the sticker set
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -72,6 +100,8 @@ func (api *API) GetStickerSetWithContext(ctx context.Context, params GetStickerS
|
|||||||
// Since: Bot API 6.2
|
// Since: Bot API 6.2
|
||||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||||
type GetCustomEmojiStickers struct {
|
type GetCustomEmojiStickers struct {
|
||||||
|
// CustomEmojiIDs Required. A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji
|
||||||
|
// identifiers can be specified.
|
||||||
CustomEmojiIDs []string `json:"custom_emoji_ids"`
|
CustomEmojiIDs []string `json:"custom_emoji_ids"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -96,7 +126,9 @@ func (api *API) GetCustomEmojiStickersWithContext(ctx context.Context, params Ge
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#uploadstickerfile
|
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||||
type UploadStickerFile struct {
|
type UploadStickerFile struct {
|
||||||
|
// UserID Required. User identifier of sticker file owner
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// StickerFormat Required. Format of the sticker, must be one of “static”, “animated”, “video”
|
||||||
StickerFormat InputStickerFormat `json:"sticker_format"`
|
StickerFormat InputStickerFormat `json:"sticker_format"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,12 +162,23 @@ func (api *API) UploadStickerFileWithContext(ctx context.Context, params UploadS
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||||
type CreateNewStickerSet struct {
|
type CreateNewStickerSet struct {
|
||||||
|
// UserID Required. User identifier of created sticker set owner
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Name Required. Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can
|
||||||
|
// contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive
|
||||||
|
// underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Title Required. Sticker set title, 1-64 characters
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
|
||||||
|
// Stickers Required. A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
|
||||||
Stickers []InputSticker `json:"stickers"`
|
Stickers []InputSticker `json:"stickers"`
|
||||||
|
// StickerType Optional. Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”.
|
||||||
|
// By default, a regular sticker set is created.
|
||||||
StickerType StickerType `json:"sticker_type,omitempty"`
|
StickerType StickerType `json:"sticker_type,omitempty"`
|
||||||
|
// NeedsRepainting Optional. Pass True if stickers in the sticker set must be repainted to the color of text
|
||||||
|
// when used in messages, the accent color if used as emoji status, white on chat photos, or another
|
||||||
|
// appropriate color based on context; for custom emoji sticker sets only
|
||||||
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,8 +204,12 @@ func (api *API) CreateNewStickerSetWithContext(ctx context.Context, params Creat
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#addstickertoset
|
// See https://core.telegram.org/bots/api#addstickertoset
|
||||||
type AddStickerToSet struct {
|
type AddStickerToSet struct {
|
||||||
|
// UserID Required. User identifier of sticker set owner
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Sticker Required. A JSON-serialized object with information about the added sticker. If exactly the same
|
||||||
|
// sticker had already been added to the set, then the set isn't changed.
|
||||||
Sticker InputSticker `json:"sticker"`
|
Sticker InputSticker `json:"sticker"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -188,7 +235,9 @@ func (api *API) AddStickerToSetWithContext(ctx context.Context, params AddSticke
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||||
type SetStickerPositionInSet struct {
|
type SetStickerPositionInSet struct {
|
||||||
|
// Sticker Required. File identifier of the sticker
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// Position Required. New sticker position in the set, zero-based
|
||||||
Position int `json:"position"`
|
Position int `json:"position"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -214,6 +263,7 @@ func (api *API) SetStickerPositionInSetWithContext(ctx context.Context, params S
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||||
type DeleteStickerFromSet struct {
|
type DeleteStickerFromSet struct {
|
||||||
|
// Sticker Required. File identifier of the sticker
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -239,9 +289,14 @@ func (api *API) DeleteStickerFromSetWithContext(ctx context.Context, params Dele
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||||
type ReplaceStickerInSet struct {
|
type ReplaceStickerInSet struct {
|
||||||
|
// UserID Required. User identifier of the sticker set owner
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// OldSticker Required. File identifier of the replaced sticker
|
||||||
OldSticker string `json:"old_sticker"`
|
OldSticker string `json:"old_sticker"`
|
||||||
|
// Sticker Required. A JSON-serialized object with information about the added sticker. If exactly the same
|
||||||
|
// sticker had already been added to the set, then the set remains unchanged.
|
||||||
Sticker InputSticker `json:"sticker"`
|
Sticker InputSticker `json:"sticker"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -267,7 +322,9 @@ func (api *API) ReplaceStickerInSetWithContext(ctx context.Context, params Repla
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||||
type SetStickerEmojiList struct {
|
type SetStickerEmojiList struct {
|
||||||
|
// Sticker Required. File identifier of the sticker
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// EmojiList Required. A JSON-serialized list of 1-20 emoji associated with the sticker
|
||||||
EmojiList []string `json:"emoji_list"`
|
EmojiList []string `json:"emoji_list"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -293,7 +350,10 @@ func (api *API) SetStickerEmojiListWithContext(ctx context.Context, params SetSt
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||||
type SetStickerKeywords struct {
|
type SetStickerKeywords struct {
|
||||||
|
// Sticker Required. File identifier of the sticker
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// Keywords Optional. A JSON-serialized list of 0-20 search keywords for the sticker with total length of up
|
||||||
|
// to 64 characters
|
||||||
Keywords []string `json:"keywords"`
|
Keywords []string `json:"keywords"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -319,7 +379,10 @@ func (api *API) SetStickerKeywordsWithContext(ctx context.Context, params SetSti
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||||
type SetStickerMaskPosition struct {
|
type SetStickerMaskPosition struct {
|
||||||
|
// Sticker Required. File identifier of the sticker
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// MaskPosition Optional. A JSON-serialized object with the position where the mask should be placed on
|
||||||
|
// faces. Omit the parameter to remove the mask position.
|
||||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -345,7 +408,9 @@ func (api *API) SetStickerMaskPositionWithContext(ctx context.Context, params Se
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||||
type SetStickerSetTitle struct {
|
type SetStickerSetTitle struct {
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Title Required. Sticker set title, 1-64 characters
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -371,9 +436,22 @@ func (api *API) SetStickerSetTitleWithContext(ctx context.Context, params SetSti
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||||
type SetStickerSetThumbnail struct {
|
type SetStickerSetThumbnail struct {
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// UserID Required. User identifier of the sticker set owner
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Thumbnail Optional. A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and
|
||||||
|
// have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size
|
||||||
|
// (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical
|
||||||
|
// requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see
|
||||||
|
// https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a
|
||||||
|
// file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a
|
||||||
|
// String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More
|
||||||
|
// information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP
|
||||||
|
// URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
|
||||||
Thumbnail string `json:"thumbnail"`
|
Thumbnail string `json:"thumbnail"`
|
||||||
|
// Format Required. Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image,
|
||||||
|
// “animated” for a .TGS animation, or “video” for a .WEBM video
|
||||||
Format InputStickerFormat `json:"format"`
|
Format InputStickerFormat `json:"format"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -399,7 +477,10 @@ func (api *API) SetStickerSetThumbnailWithContext(ctx context.Context, params Se
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||||
type SetCustomEmojiStickerSetThumbnail struct {
|
type SetCustomEmojiStickerSetThumbnail struct {
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// CustomEmojiID Optional. Custom emoji identifier of a sticker from the sticker set; pass an empty string
|
||||||
|
// to drop the thumbnail and use the first sticker as the thumbnail
|
||||||
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -425,6 +506,7 @@ func (api *API) SetCustomEmojiStickerSetThumbnailWithContext(ctx context.Context
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#deletestickerset
|
// See https://core.telegram.org/bots/api#deletestickerset
|
||||||
type DeleteStickerSet struct {
|
type DeleteStickerSet struct {
|
||||||
|
// Name Required. Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -18,9 +18,16 @@ const (
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#maskposition
|
// See https://core.telegram.org/bots/api#maskposition
|
||||||
type MaskPosition struct {
|
type MaskPosition struct {
|
||||||
|
// Point The part of the face relative to which the mask should be placed. One of “forehead”,
|
||||||
|
// “eyes”, “mouth”, or “chin”.
|
||||||
Point MaskPositionPoint `json:"point"`
|
Point MaskPositionPoint `json:"point"`
|
||||||
|
// XShift Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For
|
||||||
|
// example, choosing -1.0 will place mask just to the left of the default mask position.
|
||||||
XShift float32 `json:"x_shift"`
|
XShift float32 `json:"x_shift"`
|
||||||
|
// YShift Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For
|
||||||
|
// example, 1.0 will place the mask just below the default mask position.
|
||||||
YShift float32 `json:"y_shift"`
|
YShift float32 `json:"y_shift"`
|
||||||
|
// Scale Mask scaling coefficient. For example, 2.0 means double size.
|
||||||
Scale float32 `json:"scale"`
|
Scale float32 `json:"scale"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -40,20 +47,36 @@ const (
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sticker
|
// See https://core.telegram.org/bots/api#sticker
|
||||||
type Sticker struct {
|
type Sticker struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// Width Sticker width
|
||||||
Width int `json:"width"`
|
Width int `json:"width"`
|
||||||
|
// Height Sticker height
|
||||||
Height int `json:"height"`
|
Height int `json:"height"`
|
||||||
|
|
||||||
|
// Type Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the
|
||||||
|
// sticker is independent from its format, which is determined by the fields is_animated and is_video.
|
||||||
Type StickerType `json:"type"` // Since: Bot API 6.2
|
Type StickerType `json:"type"` // Since: Bot API 6.2
|
||||||
|
// IsAnimated True, if the sticker is animated
|
||||||
IsAnimated bool `json:"is_animated"` // Since: Bot API 4.4
|
IsAnimated bool `json:"is_animated"` // Since: Bot API 4.4
|
||||||
|
// IsVideo True, if the sticker is a video sticker
|
||||||
IsVideo bool `json:"is_video"` // Since: Bot API 5.7
|
IsVideo bool `json:"is_video"` // Since: Bot API 5.7
|
||||||
|
// Thumbnail Optional. Sticker thumbnail in the .WEBP or .JPG format
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Since: Bot API 6.6
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Since: Bot API 6.6
|
||||||
|
// Emoji Optional. Emoji associated with the sticker
|
||||||
Emoji *string `json:"emoji,omitempty"`
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
// SetName Optional. Name of the sticker set to which the sticker belongs
|
||||||
SetName *string `json:"set_name,omitempty"` // Since: Bot API 3.2
|
SetName *string `json:"set_name,omitempty"` // Since: Bot API 3.2
|
||||||
|
// MaskPosition Optional. For mask stickers, the position where the mask should be placed
|
||||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"` // Since: Bot API 3.2
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"` // Since: Bot API 3.2
|
||||||
|
// CustomEmojiID Optional. For custom emoji stickers, unique identifier of the custom emoji
|
||||||
CustomEmojiID *string `json:"custom_emoji_id,omitempty"` // Since: Bot API 6.2
|
CustomEmojiID *string `json:"custom_emoji_id,omitempty"` // Since: Bot API 6.2
|
||||||
|
// NeedRepainting reports whether Telegram must recolor the custom emoji sticker.
|
||||||
NeedRepainting *bool `json:"need_repainting,omitempty"` // Since: Bot API 6.6
|
NeedRepainting *bool `json:"need_repainting,omitempty"` // Since: Bot API 6.6
|
||||||
|
// FileSize Optional. File size in bytes
|
||||||
FileSize *int64 `json:"file_size,omitempty"`
|
FileSize *int64 `json:"file_size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,10 +84,15 @@ type Sticker struct {
|
|||||||
// Since: Bot API 3.2
|
// Since: Bot API 3.2
|
||||||
// See https://core.telegram.org/bots/api#stickerset
|
// See https://core.telegram.org/bots/api#stickerset
|
||||||
type StickerSet struct {
|
type StickerSet struct {
|
||||||
|
// Name Sticker set name
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Title Sticker set title
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// StickerType Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
|
||||||
StickerType StickerType `json:"sticker_type"`
|
StickerType StickerType `json:"sticker_type"`
|
||||||
|
// Stickers List of all set stickers
|
||||||
Stickers []Sticker `json:"stickers"`
|
Stickers []Sticker `json:"stickers"`
|
||||||
|
// Thumbnail Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
|
||||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -84,9 +112,19 @@ const (
|
|||||||
// Since: Bot API 6.6
|
// Since: Bot API 6.6
|
||||||
// See https://core.telegram.org/bots/api#inputsticker
|
// See https://core.telegram.org/bots/api#inputsticker
|
||||||
type InputSticker struct {
|
type InputSticker struct {
|
||||||
|
// Sticker The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram
|
||||||
|
// servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass
|
||||||
|
// “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name>
|
||||||
|
// name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files »
|
||||||
Sticker string `json:"sticker"`
|
Sticker string `json:"sticker"`
|
||||||
|
// Format Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated”
|
||||||
|
// for a .TGS animation, “video” for a .WEBM video
|
||||||
Format InputStickerFormat `json:"format"`
|
Format InputStickerFormat `json:"format"`
|
||||||
|
// EmojiList List of 1-20 emoji associated with the sticker
|
||||||
EmojiList []string `json:"emoji_list"`
|
EmojiList []string `json:"emoji_list"`
|
||||||
|
// MaskPosition Optional. Position where the mask should be placed on faces. For “mask” stickers only.
|
||||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||||
|
// Keywords Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters.
|
||||||
|
// For “regular” and “custom_emoji” stickers only.
|
||||||
Keywords []string `json:"keywords,omitempty"`
|
Keywords []string `json:"keywords,omitempty"`
|
||||||
}
|
}
|
||||||
|
|||||||
+329
-1
@@ -74,37 +74,91 @@ const (
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#update
|
// See https://core.telegram.org/bots/api#update
|
||||||
type Update struct {
|
type Update struct {
|
||||||
|
// Type is the locally derived update type and is not part of Telegram JSON.
|
||||||
Type UpdateType `json:"-"`
|
Type UpdateType `json:"-"`
|
||||||
|
|
||||||
|
// UpdateID The update's unique identifier. Update identifiers start from a certain positive number and
|
||||||
|
// increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows
|
||||||
|
// you to ignore repeated updates or to restore the correct update sequence, should they get out of order.
|
||||||
|
// If there are no new updates for at least a week, then identifier of the next update will be chosen
|
||||||
|
// randomly instead of sequentially.
|
||||||
UpdateID int `json:"update_id"`
|
UpdateID int `json:"update_id"`
|
||||||
|
// Message Optional. New incoming message of any kind - text, photo, sticker, etc.
|
||||||
Message *Message `json:"message,omitempty"`
|
Message *Message `json:"message,omitempty"`
|
||||||
|
// EditedMessage Optional. New version of a message that is known to the bot and was edited. This update may
|
||||||
|
// at times be triggered by changes to message fields that are either unavailable or not actively used by
|
||||||
|
// your bot.
|
||||||
EditedMessage *Message `json:"edited_message,omitempty"`
|
EditedMessage *Message `json:"edited_message,omitempty"`
|
||||||
|
// ChannelPost Optional. New incoming channel post of any kind - text, photo, sticker, etc.
|
||||||
ChannelPost *Message `json:"channel_post,omitempty"` // Since: Bot API 2.3
|
ChannelPost *Message `json:"channel_post,omitempty"` // Since: Bot API 2.3
|
||||||
|
// EditedChannelPost Optional. New version of a channel post that is known to the bot and was edited. This
|
||||||
|
// update may at times be triggered by changes to message fields that are either unavailable or not actively
|
||||||
|
// used by your bot.
|
||||||
EditedChannelPost *Message `json:"edited_channel_post,omitempty"` // Since: Bot API 2.3
|
EditedChannelPost *Message `json:"edited_channel_post,omitempty"` // Since: Bot API 2.3
|
||||||
|
|
||||||
|
// BusinessConnection Optional. The bot was connected to or disconnected from a business account, or a user
|
||||||
|
// edited an existing connection with the bot
|
||||||
BusinessConnection *BusinessConnection `json:"business_connection,omitempty"` // Since: Bot API 7.2
|
BusinessConnection *BusinessConnection `json:"business_connection,omitempty"` // Since: Bot API 7.2
|
||||||
|
// BusinessMessage Optional. New message from a connected business account
|
||||||
BusinessMessage *Message `json:"business_message,omitempty"` // Since: Bot API 7.2
|
BusinessMessage *Message `json:"business_message,omitempty"` // Since: Bot API 7.2
|
||||||
|
// EditedBusinessMessage Optional. New version of a message from a connected business account
|
||||||
EditedBusinessMessage *Message `json:"edited_business_message,omitempty"` // Since: Bot API 7.2
|
EditedBusinessMessage *Message `json:"edited_business_message,omitempty"` // Since: Bot API 7.2
|
||||||
|
// DeletedBusinessMessages Optional. Messages were deleted from a connected business account
|
||||||
DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,omitempty"` // Since: Bot API 7.2
|
DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,omitempty"` // Since: Bot API 7.2
|
||||||
|
// GuestMessage Optional. New guest message. The bot can use the field Message.guest_query_id and the method
|
||||||
|
// answerGuestQuery to send a message in response.
|
||||||
GuestMessage *Message `json:"guest_message,omitempty"` // Since: Bot API 10.0
|
GuestMessage *Message `json:"guest_message,omitempty"` // Since: Bot API 10.0
|
||||||
|
// MessageReaction Optional. A reaction to a message was changed by a user. The bot must be an administrator
|
||||||
|
// in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive
|
||||||
|
// these updates. The update isn't received for reactions set by bots.
|
||||||
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"` // Since: Bot API 7.0
|
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"` // Since: Bot API 7.0
|
||||||
|
// MessageReactionCount Optional. Reactions to a message with anonymous reactions were changed. The bot must
|
||||||
|
// be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of
|
||||||
|
// allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few
|
||||||
|
// minutes.
|
||||||
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"` // Since: Bot API 7.0
|
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"` // Since: Bot API 7.0
|
||||||
|
|
||||||
|
// InlineQuery Optional. New incoming inline query
|
||||||
InlineQuery *InlineQuery `json:"inline_query,omitempty"` // Since: Bot API 1.7
|
InlineQuery *InlineQuery `json:"inline_query,omitempty"` // Since: Bot API 1.7
|
||||||
|
// ChosenInlineResult Optional. The result of an inline query that was chosen by a user and sent to their
|
||||||
|
// chat partner. Please see our documentation on the feedback collecting for details on how to enable these
|
||||||
|
// updates for your bot.
|
||||||
ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"` // Since: Bot API 1.8
|
ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"` // Since: Bot API 1.8
|
||||||
|
// CallbackQuery Optional. New incoming callback query
|
||||||
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"` // Since: Bot API 2.0
|
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"` // Since: Bot API 2.0
|
||||||
|
// ShippingQuery Optional. New incoming shipping query. Only for invoices with flexible price.
|
||||||
ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"` // Since: Bot API 3.0
|
ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"` // Since: Bot API 3.0
|
||||||
|
// PreCheckoutQuery Optional. New incoming pre-checkout query. Contains full information about checkout.
|
||||||
PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"` // Since: Bot API 3.0
|
PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"` // Since: Bot API 3.0
|
||||||
|
// PurchasedPaidMedia Optional. A user purchased paid media with a non-empty payload sent by the bot in a
|
||||||
|
// non-channel chat
|
||||||
PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"` // Since: Bot API 7.10
|
PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"` // Since: Bot API 7.10
|
||||||
|
|
||||||
|
// Poll Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which
|
||||||
|
// are sent by the bot.
|
||||||
Poll *Poll `json:"poll,omitempty"` // Since: Bot API 4.2
|
Poll *Poll `json:"poll,omitempty"` // Since: Bot API 4.2
|
||||||
|
// PollAnswer Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in
|
||||||
|
// polls that were sent by the bot itself.
|
||||||
PollAnswer *PollAnswer `json:"poll_answer,omitempty"` // Since: Bot API 4.6
|
PollAnswer *PollAnswer `json:"poll_answer,omitempty"` // Since: Bot API 4.6
|
||||||
|
// MyChatMember Optional. The bot's chat member status was updated in a chat. For private chats, this update
|
||||||
|
// is received only when the bot is blocked or unblocked by the user.
|
||||||
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"` // Since: Bot API 5.1
|
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"` // Since: Bot API 5.1
|
||||||
|
// ChatMember Optional. A chat member's status was updated in a chat. The bot must be an administrator in
|
||||||
|
// the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these
|
||||||
|
// updates.
|
||||||
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"` // Since: Bot API 5.1
|
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"` // Since: Bot API 5.1
|
||||||
|
// ChatJoinRequest Optional. A request to join the chat has been sent. The bot must have the
|
||||||
|
// can_invite_users administrator right in the chat to receive these updates.
|
||||||
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"` // Since: Bot API 5.4
|
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"` // Since: Bot API 5.4
|
||||||
|
// ChatBoost Optional. A chat boost was added or changed. The bot must be an administrator in the chat to
|
||||||
|
// receive these updates.
|
||||||
ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"` // Since: Bot API 7.0
|
ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"` // Since: Bot API 7.0
|
||||||
|
// RemovedChatBoost Optional. A boost was removed from a chat. The bot must be an administrator in the chat
|
||||||
|
// to receive these updates.
|
||||||
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"` // Since: Bot API 7.0
|
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"` // Since: Bot API 7.0
|
||||||
|
|
||||||
|
// ManagedBot Optional. A new bot was created to be managed by the bot, or token or owner of a managed bot
|
||||||
|
// was changed
|
||||||
ManagedBot *ManagedBotUpdated `json:"managed_bot,omitempty"` // Since: Bot API 9.6
|
ManagedBot *ManagedBotUpdated `json:"managed_bot,omitempty"` // Since: Bot API 9.6
|
||||||
// Subscription contains a bot subscription update.
|
// Subscription contains a bot subscription update.
|
||||||
Subscription *BotSubscriptionUpdated `json:"subscription,omitempty"` // Since: Bot API 10.2
|
Subscription *BotSubscriptionUpdated `json:"subscription,omitempty"` // Since: Bot API 10.2
|
||||||
@@ -188,22 +242,39 @@ func (u *Update) UnmarshalJSON(data []byte) error {
|
|||||||
// Since: Bot API 2.2
|
// Since: Bot API 2.2
|
||||||
// See https://core.telegram.org/bots/api#webhookinfo
|
// See https://core.telegram.org/bots/api#webhookinfo
|
||||||
type WebhookInfo struct {
|
type WebhookInfo struct {
|
||||||
|
// URL Webhook URL, may be empty if webhook is not set up
|
||||||
URL string `json:"url"`
|
URL string `json:"url"`
|
||||||
|
// HasCustomCertificate True, if a custom certificate was provided for webhook certificate checks
|
||||||
HasCustomCertificate bool `json:"has_custom_certificate"`
|
HasCustomCertificate bool `json:"has_custom_certificate"`
|
||||||
|
// PendingUpdateCount Number of updates awaiting delivery
|
||||||
PendingUpdateCount int `json:"pending_update_count"`
|
PendingUpdateCount int `json:"pending_update_count"`
|
||||||
|
// IPAddress Optional. Currently used webhook IP address
|
||||||
IPAddress string `json:"ip_address,omitempty"`
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
// LastErrorDate Optional. Unix time for the most recent error that happened when trying to deliver an
|
||||||
|
// update via webhook
|
||||||
LastErrorDate int `json:"last_error_date,omitempty"`
|
LastErrorDate int `json:"last_error_date,omitempty"`
|
||||||
|
// LastErrorMessage Optional. Error message in human-readable format for the most recent error that happened
|
||||||
|
// when trying to deliver an update via webhook
|
||||||
LastErrorMessage string `json:"last_error_message,omitempty"`
|
LastErrorMessage string `json:"last_error_message,omitempty"`
|
||||||
|
// LastSynchronizationErrorDate Optional. Unix time of the most recent error that happened when trying to
|
||||||
|
// synchronize available updates with Telegram datacenters
|
||||||
LastSynchronizationErrorDate int `json:"last_synchronization_error_date,omitempty"`
|
LastSynchronizationErrorDate int `json:"last_synchronization_error_date,omitempty"`
|
||||||
|
// MaxConnections Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for
|
||||||
|
// update delivery
|
||||||
MaxConnections int `json:"max_connections,omitempty"`
|
MaxConnections int `json:"max_connections,omitempty"`
|
||||||
|
// AllowedUpdates Optional. A list of update types the bot is subscribed to. Defaults to all update types
|
||||||
|
// except chat_member, message_reaction, and message_reaction_count.
|
||||||
AllowedUpdates []string `json:"allowed_updates,omitempty"`
|
AllowedUpdates []string `json:"allowed_updates,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ProximityAlertTriggered represents the content of a service message sent when a user triggers a proximity alert.
|
// ProximityAlertTriggered represents the content of a service message sent when a user triggers a proximity alert.
|
||||||
// Since: Bot API 5.0
|
// Since: Bot API 5.0
|
||||||
type ProximityAlertTriggered struct {
|
type ProximityAlertTriggered struct {
|
||||||
|
// Traveler User that triggered the alert
|
||||||
Traveler User `json:"traveler"`
|
Traveler User `json:"traveler"`
|
||||||
|
// Watcher User that set the alert
|
||||||
Watcher User `json:"watcher"`
|
Watcher User `json:"watcher"`
|
||||||
|
// Distance The distance between the users
|
||||||
Distance int `json:"distance"`
|
Distance int `json:"distance"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -211,11 +282,20 @@ type ProximityAlertTriggered struct {
|
|||||||
// Since: Bot API 1.7
|
// Since: Bot API 1.7
|
||||||
// See https://core.telegram.org/bots/api#inlinequery
|
// See https://core.telegram.org/bots/api#inlinequery
|
||||||
type InlineQuery struct {
|
type InlineQuery struct {
|
||||||
|
// ID Unique identifier for this query
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// From Sender
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// Query Text of the query (up to 256 characters)
|
||||||
Query string `json:"query"`
|
Query string `json:"query"`
|
||||||
|
// Offset Offset of the results to be returned, can be controlled by the bot
|
||||||
Offset string `json:"offset"`
|
Offset string `json:"offset"`
|
||||||
|
// ChatType Optional. Type of the chat from which the inline query was sent. Can be either “sender” for
|
||||||
|
// a private chat with the inline query sender, “private”, “group”, “supergroup”, or
|
||||||
|
// “channel”. The chat type should be always known for requests sent from official clients and most
|
||||||
|
// third-party clients, unless the request was sent from a secret chat.
|
||||||
ChatType *ChatType `json:"chat_type,omitempty"`
|
ChatType *ChatType `json:"chat_type,omitempty"`
|
||||||
|
// Location Optional. Sender location, only for bots that request user location
|
||||||
Location *Location `json:"location,omitempty"`
|
Location *Location `json:"location,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -223,10 +303,17 @@ type InlineQuery struct {
|
|||||||
// Since: Bot API 1.8
|
// Since: Bot API 1.8
|
||||||
// See https://core.telegram.org/bots/api#choseninlineresult
|
// See https://core.telegram.org/bots/api#choseninlineresult
|
||||||
type ChosenInlineResult struct {
|
type ChosenInlineResult struct {
|
||||||
|
// ResultID The unique identifier for the result that was chosen
|
||||||
ResultID string `json:"result_id"`
|
ResultID string `json:"result_id"`
|
||||||
|
// From The user that chose the result
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// Location Optional. Sender location, only for bots that require user location
|
||||||
Location *Location `json:"location,omitempty"`
|
Location *Location `json:"location,omitempty"`
|
||||||
|
// InlineMessageID Optional. Identifier of the sent inline message. Available only if there is an inline
|
||||||
|
// keyboard attached to the message. Will be also received in callback queries and can be used to edit the
|
||||||
|
// message.
|
||||||
InlineMessageID string `json:"inline_message_id"`
|
InlineMessageID string `json:"inline_message_id"`
|
||||||
|
// Query The query that was used to obtain the result
|
||||||
Query string `json:"query"`
|
Query string `json:"query"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -234,9 +321,16 @@ type ChosenInlineResult struct {
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#file
|
// See https://core.telegram.org/bots/api#file
|
||||||
type File struct {
|
type File struct {
|
||||||
|
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||||
FileID string `json:"file_id"`
|
FileID string `json:"file_id"`
|
||||||
|
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||||
|
// different bots. Can't be used to download or reuse the file.
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||||
|
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||||
|
// integer or double-precision float type are safe for storing this value.
|
||||||
FileSize int64 `json:"file_size,omitempty"`
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
// FilePath Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
|
||||||
FilePath string `json:"file_path,omitempty"`
|
FilePath string `json:"file_path,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -244,13 +338,23 @@ type File struct {
|
|||||||
// Since: Bot API 5.1
|
// Since: Bot API 5.1
|
||||||
// See https://core.telegram.org/bots/api#chatmemberupdated
|
// See https://core.telegram.org/bots/api#chatmemberupdated
|
||||||
type ChatMemberUpdated struct {
|
type ChatMemberUpdated struct {
|
||||||
|
// Chat Chat the user belongs to
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// From Performer of the action, which resulted in the change
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// Date Date the change was done in Unix time
|
||||||
Date int64 `json:"date"`
|
Date int64 `json:"date"`
|
||||||
|
// OldChatMember Previous information about the chat member
|
||||||
OldChatMember ChatMember `json:"old_chat_member"`
|
OldChatMember ChatMember `json:"old_chat_member"`
|
||||||
|
// NewChatMember New information about the chat member
|
||||||
NewChatMember ChatMember `json:"new_chat_member"`
|
NewChatMember ChatMember `json:"new_chat_member"`
|
||||||
|
// InviteLink Optional. Chat invite link, which was used by the user to join the chat; for joining by invite
|
||||||
|
// link events only
|
||||||
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
||||||
|
// ViaJoinRequest Optional. True, if the user joined the chat after sending a direct join request without
|
||||||
|
// using an invite link and being approved by an administrator
|
||||||
ViaJoinRequest *bool `json:"via_join_request,omitempty"`
|
ViaJoinRequest *bool `json:"via_join_request,omitempty"`
|
||||||
|
// ViaChatFolderInviteLink Optional. True, if the user joined the chat via a chat folder invite link
|
||||||
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
|
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -258,11 +362,21 @@ type ChatMemberUpdated struct {
|
|||||||
// Since: Bot API 5.4
|
// Since: Bot API 5.4
|
||||||
// See https://core.telegram.org/bots/api#chatjoinrequest
|
// See https://core.telegram.org/bots/api#chatjoinrequest
|
||||||
type ChatJoinRequest struct {
|
type ChatJoinRequest struct {
|
||||||
|
// Chat Chat to which the request was sent
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// From User that sent the join request
|
||||||
From User `json:"from"`
|
From User `json:"from"`
|
||||||
|
// UserChatID Identifier of a private chat with the user who sent the join request. This number may have
|
||||||
|
// more than 32 significant bits and some programming languages may have difficulty/silent defects in
|
||||||
|
// interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float
|
||||||
|
// type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages
|
||||||
|
// until the join request is processed, assuming no other administrator contacted the user.
|
||||||
UserChatID int64 `json:"user_chat_id"`
|
UserChatID int64 `json:"user_chat_id"`
|
||||||
|
// Date Date the request was sent in Unix time
|
||||||
Date int64 `json:"date"`
|
Date int64 `json:"date"`
|
||||||
|
// Bio Optional. Bio of the user
|
||||||
Bio *string `json:"bio,omitempty"`
|
Bio *string `json:"bio,omitempty"`
|
||||||
|
// InviteLink Optional. Chat invite link that was used by the user to send the join request
|
||||||
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
||||||
|
|
||||||
// QueryID identifies the join request query; present only for bots
|
// QueryID identifies the join request query; present only for bots
|
||||||
@@ -275,20 +389,33 @@ type ChatJoinRequest struct {
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#location
|
// See https://core.telegram.org/bots/api#location
|
||||||
type Location struct {
|
type Location struct {
|
||||||
|
// Latitude Latitude as defined by the sender
|
||||||
Latitude float64 `json:"latitude"`
|
Latitude float64 `json:"latitude"`
|
||||||
|
// Longitude Longitude as defined by the sender
|
||||||
Longitude float64 `json:"longitude"`
|
Longitude float64 `json:"longitude"`
|
||||||
|
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||||
HorizontalAccuracy float64 `json:"horizontal_accuracy"`
|
HorizontalAccuracy float64 `json:"horizontal_accuracy"`
|
||||||
|
// LivePeriod Optional. Time relative to the message sending date, during which the location can be updated;
|
||||||
|
// in seconds. For active live locations only.
|
||||||
LivePeriod int `json:"live_period"`
|
LivePeriod int `json:"live_period"`
|
||||||
|
// Heading Optional. The direction in which user is moving, in degrees; 1-360. For active live locations
|
||||||
|
// only.
|
||||||
Heading int `json:"heading"`
|
Heading int `json:"heading"`
|
||||||
|
// ProximityAlertRadius Optional. The maximum distance for proximity alerts about approaching another chat
|
||||||
|
// member, in meters. For sent live locations only.
|
||||||
ProximityAlertRadius int `json:"proximity_alert_radius"`
|
ProximityAlertRadius int `json:"proximity_alert_radius"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// LocationAddress represents a human-readable address of a location.
|
// LocationAddress represents a human-readable address of a location.
|
||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
type LocationAddress struct {
|
type LocationAddress struct {
|
||||||
|
// CountryCode The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
|
||||||
CountryCode string `json:"country_code"`
|
CountryCode string `json:"country_code"`
|
||||||
|
// State Optional. State of the location
|
||||||
State *string `json:"state,omitempty"`
|
State *string `json:"state,omitempty"`
|
||||||
|
// City Optional. City of the location
|
||||||
City *string `json:"city,omitempty"`
|
City *string `json:"city,omitempty"`
|
||||||
|
// Street Optional. Street address of the location
|
||||||
Street *string `json:"street,omitempty"`
|
Street *string `json:"street,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -296,12 +423,20 @@ type LocationAddress struct {
|
|||||||
// Since: Bot API 2.0
|
// Since: Bot API 2.0
|
||||||
// See https://core.telegram.org/bots/api#venue
|
// See https://core.telegram.org/bots/api#venue
|
||||||
type Venue struct {
|
type Venue struct {
|
||||||
|
// Location Venue location. Can't be a live location.
|
||||||
Location Location `json:"location"`
|
Location Location `json:"location"`
|
||||||
|
// Title Name of the venue
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
|
// Address Address of the venue
|
||||||
Address string `json:"address"`
|
Address string `json:"address"`
|
||||||
|
// FoursquareID Optional. Foursquare identifier of the venue
|
||||||
FoursquareID string `json:"foursquare_id,omitempty"`
|
FoursquareID string `json:"foursquare_id,omitempty"`
|
||||||
|
// FoursquareType Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”,
|
||||||
|
// “arts_entertainment/aquarium” or “food/icecream”.)
|
||||||
FoursquareType string `json:"foursquare_type,omitempty"`
|
FoursquareType string `json:"foursquare_type,omitempty"`
|
||||||
|
// GooglePlaceID Optional. Google Places identifier of the venue
|
||||||
GooglePlaceID string `json:"google_place_id,omitempty"`
|
GooglePlaceID string `json:"google_place_id,omitempty"`
|
||||||
|
// GooglePlaceType Optional. Google Places type of the venue. (See supported types.)
|
||||||
GooglePlaceType string `json:"google_place_type,omitempty"`
|
GooglePlaceType string `json:"google_place_type,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -309,153 +444,253 @@ type Venue struct {
|
|||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
// See https://core.telegram.org/bots/api#webappinfo
|
// See https://core.telegram.org/bots/api#webappinfo
|
||||||
type WebAppInfo struct {
|
type WebAppInfo struct {
|
||||||
|
// URL An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
|
||||||
URL string `json:"url"`
|
URL string `json:"url"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// WebAppData represents data sent from a Web App to the bot.
|
// WebAppData represents data sent from a Web App to the bot.
|
||||||
// Since: Bot API 6.0
|
// Since: Bot API 6.0
|
||||||
type WebAppData struct {
|
type WebAppData struct {
|
||||||
|
// Data The data. Be aware that a bad client can send arbitrary data in this field.
|
||||||
Data string `json:"data"`
|
Data string `json:"data"`
|
||||||
|
// ButtonText Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad
|
||||||
|
// client can send arbitrary data in this field.
|
||||||
ButtonText string `json:"button_text"`
|
ButtonText string `json:"button_text"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// StarAmount represents an amount of Telegram Stars.
|
// StarAmount represents an amount of Telegram Stars.
|
||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
type StarAmount struct {
|
type StarAmount struct {
|
||||||
|
// Amount Integer amount of Telegram Stars, rounded to 0; can be negative
|
||||||
Amount int `json:"amount"`
|
Amount int `json:"amount"`
|
||||||
|
// NanostarAmount Optional. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to
|
||||||
|
// 999999999; can be negative if and only if amount is non-positive
|
||||||
NanostarAmount int `json:"nanostar_amount"`
|
NanostarAmount int `json:"nanostar_amount"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// AcceptedGiftTypes represents the types of gifts accepted by a user or chat.
|
// AcceptedGiftTypes represents the types of gifts accepted by a user or chat.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type AcceptedGiftTypes struct {
|
type AcceptedGiftTypes struct {
|
||||||
|
// UnlimitedGifts True, if unlimited regular gifts are accepted
|
||||||
UnlimitedGifts bool `json:"unlimited_gifts"`
|
UnlimitedGifts bool `json:"unlimited_gifts"`
|
||||||
|
// LimitedGifts True, if limited regular gifts are accepted
|
||||||
LimitedGifts bool `json:"limited_gifts"`
|
LimitedGifts bool `json:"limited_gifts"`
|
||||||
|
// UniqueGifts True, if unique gifts or gifts that can be upgraded to unique for free are accepted
|
||||||
UniqueGifts bool `json:"unique_gifts"`
|
UniqueGifts bool `json:"unique_gifts"`
|
||||||
|
// PremiumSubscription True, if a Telegram Premium subscription is accepted
|
||||||
PremiumSubscription bool `json:"premium_subscription"`
|
PremiumSubscription bool `json:"premium_subscription"`
|
||||||
|
// GiftsFromChannels True, if transfers of unique gifts from channels are accepted
|
||||||
GiftsFromChannels bool `json:"gifts_from_channels"`
|
GiftsFromChannels bool `json:"gifts_from_channels"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiftBackground represents the background of a gift.
|
// GiftBackground represents the background of a gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type GiftBackground struct {
|
type GiftBackground struct {
|
||||||
|
// CenterColor Center color of the background in RGB format
|
||||||
CenterColor int `json:"center_color"`
|
CenterColor int `json:"center_color"`
|
||||||
|
// EdgeColor Edge color of the background in RGB format
|
||||||
EdgeColor int `json:"edge_color"`
|
EdgeColor int `json:"edge_color"`
|
||||||
|
// TextColor Text color of the background in RGB format
|
||||||
TextColor int `json:"text_color"`
|
TextColor int `json:"text_color"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Gift represents a gift that can be sent.
|
// Gift represents a gift that can be sent.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type Gift struct {
|
type Gift struct {
|
||||||
|
// ID Unique identifier of the gift
|
||||||
ID string `json:"id"`
|
ID string `json:"id"`
|
||||||
|
// Sticker The sticker that represents the gift
|
||||||
Sticker Sticker `json:"sticker"`
|
Sticker Sticker `json:"sticker"`
|
||||||
|
// StarCount The number of Telegram Stars that must be paid to send the sticker
|
||||||
StarCount int `json:"star_count"`
|
StarCount int `json:"star_count"`
|
||||||
|
// UpdateStarCount is the number of Stars required to upgrade the gift.
|
||||||
UpdateStarCount *int `json:"update_star_count,omitempty"`
|
UpdateStarCount *int `json:"update_star_count,omitempty"`
|
||||||
|
// IsPremium Optional. True, if the gift can only be purchased by Telegram Premium subscribers
|
||||||
IsPremium *bool `json:"is_premium,omitempty"`
|
IsPremium *bool `json:"is_premium,omitempty"`
|
||||||
|
// HasColors Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance
|
||||||
HasColors *bool `json:"has_colors,omitempty"`
|
HasColors *bool `json:"has_colors,omitempty"`
|
||||||
|
// TotalCount Optional. The total number of gifts of this type that can be sent by all users; for limited
|
||||||
|
// gifts only
|
||||||
TotalCount *int `json:"total_count,omitempty"`
|
TotalCount *int `json:"total_count,omitempty"`
|
||||||
|
// RemainingCount Optional. The number of remaining gifts of this type that can be sent by all users; for
|
||||||
|
// limited gifts only
|
||||||
RemainingCount *int `json:"remaining_count,omitempty"`
|
RemainingCount *int `json:"remaining_count,omitempty"`
|
||||||
|
// PersonalTotalCount Optional. The total number of gifts of this type that can be sent by the bot; for
|
||||||
|
// limited gifts only
|
||||||
PersonalTotalCount *int `json:"personal_total_count,omitempty"`
|
PersonalTotalCount *int `json:"personal_total_count,omitempty"`
|
||||||
|
// PersonalRemainingCount Optional. The number of remaining gifts of this type that can be sent by the bot;
|
||||||
|
// for limited gifts only
|
||||||
PersonalRemainingCount *int `json:"personal_remaining_count,omitempty"`
|
PersonalRemainingCount *int `json:"personal_remaining_count,omitempty"`
|
||||||
|
// Background Optional. Background of the gift
|
||||||
Background *GiftBackground `json:"background,omitempty"`
|
Background *GiftBackground `json:"background,omitempty"`
|
||||||
|
// UniqueGiftVariantColor identifies the color used by unique variants of the gift.
|
||||||
UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"`
|
UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"`
|
||||||
|
// PublisherChat Optional. Information about the chat that published the gift
|
||||||
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Gifts represents a list of gifts.
|
// Gifts represents a list of gifts.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type Gifts struct {
|
type Gifts struct {
|
||||||
|
// Gifts The list of gifts
|
||||||
Gifts []Gift `json:"gifts"`
|
Gifts []Gift `json:"gifts"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftModel describes the model component of a unique gift.
|
// UniqueGiftModel describes the model component of a unique gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGiftModel struct {
|
type UniqueGiftModel struct {
|
||||||
|
// Name Name of the model
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Sticker The sticker that represents the unique gift
|
||||||
Sticker Sticker `json:"sticker"`
|
Sticker Sticker `json:"sticker"`
|
||||||
|
// RarityPerMille The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0
|
||||||
|
// for crafted gifts.
|
||||||
RarityPerMille int `json:"rarity_per_mille"`
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
|
// Rarity Optional. Rarity of the model if it is a crafted model. Currently, can be “uncommon”,
|
||||||
|
// “rare”, “epic”, or “legendary”.
|
||||||
Rarity string `json:"rarity,omitempty"`
|
Rarity string `json:"rarity,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftSymbol describes the symbol component of a unique gift.
|
// UniqueGiftSymbol describes the symbol component of a unique gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGiftSymbol struct {
|
type UniqueGiftSymbol struct {
|
||||||
|
// Name Name of the symbol
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Sticker The sticker that represents the unique gift
|
||||||
Sticker Sticker `json:"sticker"`
|
Sticker Sticker `json:"sticker"`
|
||||||
|
// RarityPerMille The number of unique gifts that receive this model for every 1000 gifts upgraded
|
||||||
RarityPerMille int `json:"rarity_per_mille"`
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftBackdropColors describes the colors of a unique gift backdrop.
|
// UniqueGiftBackdropColors describes the colors of a unique gift backdrop.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGiftBackdropColors struct {
|
type UniqueGiftBackdropColors struct {
|
||||||
|
// CenterColor The color in the center of the backdrop in RGB format
|
||||||
CenterColor int `json:"center_color"`
|
CenterColor int `json:"center_color"`
|
||||||
|
// EdgeColor The color on the edges of the backdrop in RGB format
|
||||||
EdgeColor int `json:"edge_color"`
|
EdgeColor int `json:"edge_color"`
|
||||||
|
// SymbolColor The color to be applied to the symbol in RGB format
|
||||||
SymbolColor int `json:"symbol_color"`
|
SymbolColor int `json:"symbol_color"`
|
||||||
|
// TextColor The color for the text on the backdrop in RGB format
|
||||||
TextColor int `json:"text_color"`
|
TextColor int `json:"text_color"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftBackdrop describes the backdrop of a unique gift.
|
// UniqueGiftBackdrop describes the backdrop of a unique gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGiftBackdrop struct {
|
type UniqueGiftBackdrop struct {
|
||||||
|
// Name Name of the backdrop
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Colors Colors of the backdrop
|
||||||
Colors UniqueGiftBackdropColors `json:"colors"`
|
Colors UniqueGiftBackdropColors `json:"colors"`
|
||||||
|
// RarityPerMille The number of unique gifts that receive this backdrop for every 1000 gifts upgraded
|
||||||
RarityPerMille int `json:"rarity_per_mille"`
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftColors represents color information for a unique gift.
|
// UniqueGiftColors represents color information for a unique gift.
|
||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
type UniqueGiftColors struct {
|
type UniqueGiftColors struct {
|
||||||
|
// ModelCustomEmojiID Custom emoji identifier of the unique gift's model
|
||||||
ModelCustomEmojiID string `json:"model_custom_emoji_id"`
|
ModelCustomEmojiID string `json:"model_custom_emoji_id"`
|
||||||
|
// SymbolCustomEmojiID Custom emoji identifier of the unique gift's symbol
|
||||||
SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
|
SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
|
||||||
|
// LightThemeMainColor Main color used in light themes; RGB format
|
||||||
LightThemeMainColor int `json:"light_theme_main_color"`
|
LightThemeMainColor int `json:"light_theme_main_color"`
|
||||||
|
// LightThemeOtherColors List of 1-3 additional colors used in light themes; RGB format
|
||||||
LightThemeOtherColors []int `json:"light_theme_other_colors"`
|
LightThemeOtherColors []int `json:"light_theme_other_colors"`
|
||||||
|
// DarkThemeMainColor Main color used in dark themes; RGB format
|
||||||
DarkThemeMainColor int `json:"dark_theme_main_color"`
|
DarkThemeMainColor int `json:"dark_theme_main_color"`
|
||||||
|
// DarkThemeOtherColors List of 1-3 additional colors used in dark themes; RGB format
|
||||||
DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
|
DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGift represents a unique gift.
|
// UniqueGift represents a unique gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGift struct {
|
type UniqueGift struct {
|
||||||
|
// GiftID Identifier of the regular gift from which the gift was upgraded
|
||||||
GiftID string `json:"gift_id"`
|
GiftID string `json:"gift_id"`
|
||||||
|
// BaseName Human-readable name of the regular gift from which this unique gift was upgraded
|
||||||
BaseName string `json:"base_name"`
|
BaseName string `json:"base_name"`
|
||||||
|
// Name Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas.
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
|
// Number Unique number of the upgraded gift among gifts upgraded from the same regular gift
|
||||||
Number int `json:"number"`
|
Number int `json:"number"`
|
||||||
|
// Model Model of the gift
|
||||||
Model UniqueGiftModel `json:"model"`
|
Model UniqueGiftModel `json:"model"`
|
||||||
|
// Symbol Symbol of the gift
|
||||||
Symbol UniqueGiftSymbol `json:"symbol"`
|
Symbol UniqueGiftSymbol `json:"symbol"`
|
||||||
|
// Backdrop Backdrop of the gift
|
||||||
Backdrop UniqueGiftBackdrop `json:"backdrop"`
|
Backdrop UniqueGiftBackdrop `json:"backdrop"`
|
||||||
|
|
||||||
|
// IsPremium Optional. True, if the original regular gift was exclusively purchaseable by Telegram Premium
|
||||||
|
// subscribers
|
||||||
IsPremium bool `json:"is_premium,omitempty"`
|
IsPremium bool `json:"is_premium,omitempty"`
|
||||||
|
// IsBurned Optional. True, if the gift was used to craft another gift and isn't available anymore
|
||||||
IsBurned bool `json:"is_burned,omitempty"`
|
IsBurned bool `json:"is_burned,omitempty"`
|
||||||
|
// IsFromBlockchain Optional. True, if the gift is assigned from the TON blockchain and can't be resold or
|
||||||
|
// transferred in Telegram
|
||||||
IsFromBlockchain bool `json:"is_from_blockchain,omitempty"`
|
IsFromBlockchain bool `json:"is_from_blockchain,omitempty"`
|
||||||
|
// Colors Optional. The color scheme that can be used by the gift's owner for the chat's name, replies to
|
||||||
|
// messages and link previews; for business account gifts and gifts that are currently on sale only
|
||||||
Colors *UniqueGiftColors `json:"colors,omitempty"`
|
Colors *UniqueGiftColors `json:"colors,omitempty"`
|
||||||
|
// PublisherChat Optional. Information about the chat that published the gift
|
||||||
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiftInfo contains information about a received gift.
|
// GiftInfo contains information about a received gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type GiftInfo struct {
|
type GiftInfo struct {
|
||||||
|
// Gift Information about the gift
|
||||||
Gift Gift `json:"gift"`
|
Gift Gift `json:"gift"`
|
||||||
|
|
||||||
|
// OwnedGiftID Optional. Unique identifier of the received gift for the bot; only present for gifts received
|
||||||
|
// on behalf of business accounts
|
||||||
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
||||||
|
// ConvertStarCount Optional. Number of Telegram Stars that can be claimed by the receiver by converting the
|
||||||
|
// gift; omitted if conversion to Telegram Stars is impossible
|
||||||
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
||||||
|
// PrepaidUpgradeStarCount Optional. Number of Telegram Stars that were prepaid for the ability to upgrade
|
||||||
|
// the gift
|
||||||
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||||
|
// IsUpgradeSeparate Optional. True, if the gift's upgrade was purchased after the gift was sent
|
||||||
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
||||||
|
// CanBeUpgraded Optional. True, if the gift can be upgraded to a unique gift
|
||||||
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
||||||
|
// Text Optional. Text of the message that was added to the gift
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
|
// Entities Optional. Special entities that appear in the text
|
||||||
Entities []MessageEntity `json:"entities,omitempty"`
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
// IsPrivate Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise,
|
||||||
|
// everyone will be able to see them
|
||||||
IsPrivate bool `json:"is_private,omitempty"`
|
IsPrivate bool `json:"is_private,omitempty"`
|
||||||
|
// UniqueGiftNumber Optional. Unique number reserved for this gift when upgraded. See the number field in
|
||||||
|
// UniqueGift.
|
||||||
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// UniqueGiftInfo contains information about a received unique gift.
|
// UniqueGiftInfo contains information about a received unique gift.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type UniqueGiftInfo struct {
|
type UniqueGiftInfo struct {
|
||||||
|
// Gift Information about the gift
|
||||||
Gift UniqueGift `json:"gift"`
|
Gift UniqueGift `json:"gift"`
|
||||||
|
// Origin Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts,
|
||||||
|
// “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from
|
||||||
|
// other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for
|
||||||
|
// gifts bought or sold through gift purchase offers.
|
||||||
Origin string `json:"origin"`
|
Origin string `json:"origin"`
|
||||||
|
// LastResaleCurrency Optional. For gifts bought from other users, the currency in which the payment for the
|
||||||
|
// gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for TON grams.
|
||||||
LastResaleCurrency string `json:"last_resale_currency,omitempty"`
|
LastResaleCurrency string `json:"last_resale_currency,omitempty"`
|
||||||
|
// LastResaleAmount Optional. For gifts bought from other users, the price paid for the gift in either
|
||||||
|
// Telegram Stars or nanograms
|
||||||
LastResaleAmount int `json:"last_resale_amount,omitempty"`
|
LastResaleAmount int `json:"last_resale_amount,omitempty"`
|
||||||
|
// OwnedGiftID Optional. Unique identifier of the received gift for the bot; only present for gifts received
|
||||||
|
// on behalf of business accounts
|
||||||
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
||||||
|
// TransferStarCount Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if
|
||||||
|
// the bot cannot transfer the gift
|
||||||
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
||||||
|
// NextTransferDate Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in
|
||||||
|
// the past, then the gift can be transferred now.
|
||||||
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -473,91 +708,166 @@ const (
|
|||||||
// OwnedGift represents a gift owned by a user or chat.
|
// OwnedGift represents a gift owned by a user or chat.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type OwnedGift struct {
|
type OwnedGift struct {
|
||||||
|
// Type identifies the regular or unique owned-gift variant.
|
||||||
Type OwnedGiftType `json:"type"`
|
Type OwnedGiftType `json:"type"`
|
||||||
OwnedGiftID string `json:"ownen_gift_id,omitempty"`
|
// OwnedGiftID uniquely identifies a business account's owned gift when available.
|
||||||
|
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
||||||
|
// SendDate Date the gift was sent in Unix time
|
||||||
SendDate int `json:"send_date,omitempty"`
|
SendDate int `json:"send_date,omitempty"`
|
||||||
|
// IsSaved Optional. True, if the gift is displayed on the account's profile page; for gifts received on
|
||||||
|
// behalf of business accounts only
|
||||||
IsSaved bool `json:"is_saved,omitempty"`
|
IsSaved bool `json:"is_saved,omitempty"`
|
||||||
|
|
||||||
|
// Gift contains the regular gift for the regular variant.
|
||||||
// Fields specific to "regular" type
|
// Fields specific to "regular" type
|
||||||
Gift Gift `json:"gift"`
|
Gift Gift `json:"gift"`
|
||||||
|
// SenderUser Optional. Sender of the gift if it is a known user
|
||||||
SenderUser *User `json:"sender_user,omitempty"`
|
SenderUser *User `json:"sender_user,omitempty"`
|
||||||
|
// Text Optional. Text of the message that was added to the gift
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
|
// Entities Optional. Special entities that appear in the text
|
||||||
Entities []MessageEntity `json:"entities,omitempty"`
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
// IsPrivate Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise,
|
||||||
|
// everyone will be able to see them
|
||||||
IsPrivate bool `json:"is_private,omitempty"`
|
IsPrivate bool `json:"is_private,omitempty"`
|
||||||
|
// CanBeUpgraded Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf
|
||||||
|
// of business accounts only
|
||||||
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
||||||
|
// WasRefunded Optional. True, if the gift was refunded and isn't available anymore
|
||||||
WasRefunded bool `json:"was_refunded,omitempty"`
|
WasRefunded bool `json:"was_refunded,omitempty"`
|
||||||
|
// ConvertStarCount Optional. Number of Telegram Stars that can be claimed by the receiver instead of the
|
||||||
|
// gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business
|
||||||
|
// accounts only
|
||||||
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
||||||
|
// PrepaidUpgradeStarCount Optional. Number of Telegram Stars that were paid for the ability to upgrade the
|
||||||
|
// gift
|
||||||
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||||
|
// IsUpgradeSeparate Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts
|
||||||
|
// received on behalf of business accounts only
|
||||||
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
||||||
|
// UniqueGiftNumber Optional. Unique number reserved for this gift when upgraded. See the number field in
|
||||||
|
// UniqueGift.
|
||||||
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
||||||
|
|
||||||
|
// CanBeTransferred Optional. True, if the gift can be transferred to another owner; for gifts received on
|
||||||
|
// behalf of business accounts only
|
||||||
// Fields specific to "unique" type
|
// Fields specific to "unique" type
|
||||||
CanBeTransferred bool `json:"can_be_transferred,omitempty"`
|
CanBeTransferred bool `json:"can_be_transferred,omitempty"`
|
||||||
|
// TransferStarCount Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if
|
||||||
|
// the bot cannot transfer the gift
|
||||||
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
||||||
|
// NextTransferDate Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in
|
||||||
|
// the past, then the gift can be transferred now.
|
||||||
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OwnedGifts represents a list of owned gifts with pagination.
|
// OwnedGifts represents a list of owned gifts with pagination.
|
||||||
// Since: Bot API 9.0
|
// Since: Bot API 9.0
|
||||||
type OwnedGifts struct {
|
type OwnedGifts struct {
|
||||||
|
// TotalCount The total number of gifts owned by the user or the chat
|
||||||
TotalCount int `json:"total_count"`
|
TotalCount int `json:"total_count"`
|
||||||
|
// Gifts The list of gifts
|
||||||
Gifts []OwnedGift `json:"gifts"`
|
Gifts []OwnedGift `json:"gifts"`
|
||||||
|
// NextOffset Optional. Offset for the next request. If empty, then there are no more results.
|
||||||
NextOffset string `json:"next_offset"`
|
NextOffset string `json:"next_offset"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiveawayCreated represents a service message about a giveaway being created.
|
// GiveawayCreated represents a service message about a giveaway being created.
|
||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
type GiveawayCreated struct {
|
type GiveawayCreated struct {
|
||||||
|
// PrizeStarCount Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram
|
||||||
|
// Star giveaways only
|
||||||
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Giveaway represents a message about a scheduled giveaway.
|
// Giveaway represents a message about a scheduled giveaway.
|
||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
type Giveaway struct {
|
type Giveaway struct {
|
||||||
|
// Chats The list of chats which the user must join to participate in the giveaway
|
||||||
Chats []Chat `json:"chats"`
|
Chats []Chat `json:"chats"`
|
||||||
|
// WinnersSelectionDate Point in time (Unix timestamp) when winners of the giveaway will be selected
|
||||||
WinnersSelectionDate int `json:"winners_selection_date"`
|
WinnersSelectionDate int `json:"winners_selection_date"`
|
||||||
|
// WinnerCount The number of users which are supposed to be selected as winners of the giveaway
|
||||||
WinnerCount int `json:"winner_count"`
|
WinnerCount int `json:"winner_count"`
|
||||||
|
|
||||||
|
// OnlyNewMembers Optional. True, if only users who join the chats after the giveaway started should be
|
||||||
|
// eligible to win
|
||||||
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
||||||
|
// HasPublicWinners Optional. True, if the list of giveaway winners will be visible to everyone
|
||||||
HasPublicWinners bool `json:"has_public_winners,omitempty"`
|
HasPublicWinners bool `json:"has_public_winners,omitempty"`
|
||||||
|
// PrizeDescription Optional. Description of additional giveaway prize
|
||||||
PrizeDescription string `json:"prize_description,omitempty"`
|
PrizeDescription string `json:"prize_description,omitempty"`
|
||||||
|
// CountryCodes Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries
|
||||||
|
// from which eligible users for the giveaway must come. If empty, then all users can participate in the
|
||||||
|
// giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
|
||||||
CountryCodes []string `json:"country_codes,omitempty"`
|
CountryCodes []string `json:"country_codes,omitempty"`
|
||||||
|
// PrizeStarCount Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram
|
||||||
|
// Star giveaways only
|
||||||
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
|
// PremiumSubscriptionMonthCount Optional. The number of months the Telegram Premium subscription won from
|
||||||
|
// the giveaway will be active for; for Telegram Premium giveaways only
|
||||||
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiveawayWinners represents a message about the completion of a giveaway with public winners.
|
// GiveawayWinners represents a message about the completion of a giveaway with public winners.
|
||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
type GiveawayWinners struct {
|
type GiveawayWinners struct {
|
||||||
|
// Chat The chat that created the giveaway
|
||||||
Chat Chat `json:"chat"`
|
Chat Chat `json:"chat"`
|
||||||
|
// GiveawayMessageID Identifier of the message with the giveaway in the chat
|
||||||
GiveawayMessageID int `json:"giveaway_message_id"`
|
GiveawayMessageID int `json:"giveaway_message_id"`
|
||||||
|
// WinnersSelectionDate Point in time (Unix timestamp) when winners of the giveaway were selected
|
||||||
WinnersSelectionDate int `json:"winners_selection_date"`
|
WinnersSelectionDate int `json:"winners_selection_date"`
|
||||||
|
// WinnerCount Total number of winners in the giveaway
|
||||||
WinnerCount int `json:"winner_count"`
|
WinnerCount int `json:"winner_count"`
|
||||||
|
// Winners List of up to 100 winners of the giveaway
|
||||||
Winners []User `json:"winners"`
|
Winners []User `json:"winners"`
|
||||||
|
|
||||||
|
// AdditionalChatCount Optional. The number of other chats the user had to join in order to be eligible for
|
||||||
|
// the giveaway
|
||||||
AdditionalChatCount int `json:"additional_chat_count,omitempty"`
|
AdditionalChatCount int `json:"additional_chat_count,omitempty"`
|
||||||
|
// PrizeStarCount Optional. The number of Telegram Stars that were split between giveaway winners; for
|
||||||
|
// Telegram Star giveaways only
|
||||||
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
|
// PremiumSubscriptionMonthCount Optional. The number of months the Telegram Premium subscription won from
|
||||||
|
// the giveaway will be active for; for Telegram Premium giveaways only
|
||||||
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
||||||
|
// UnclaimedPrizeCount Optional. Number of undistributed prizes
|
||||||
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
||||||
|
// OnlyNewMembers Optional. True, if only users who had joined the chats after the giveaway started were
|
||||||
|
// eligible to win
|
||||||
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
||||||
|
// WasRefunded Optional. True, if the giveaway was canceled because the payment for it was refunded
|
||||||
WasRefunded bool `json:"was_refunded,omitempty"`
|
WasRefunded bool `json:"was_refunded,omitempty"`
|
||||||
|
// PrizeDescription Optional. Description of additional giveaway prize
|
||||||
PrizeDescription string `json:"prize_description,omitempty"`
|
PrizeDescription string `json:"prize_description,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// GiveawayCompleted represents a service message about the completion of a giveaway without public winners.
|
// GiveawayCompleted represents a service message about the completion of a giveaway without public winners.
|
||||||
// Since: Bot API 7.0
|
// Since: Bot API 7.0
|
||||||
type GiveawayCompleted struct {
|
type GiveawayCompleted struct {
|
||||||
|
// WinnerCount Number of winners in the giveaway
|
||||||
WinnerCount int `json:"winner_count"`
|
WinnerCount int `json:"winner_count"`
|
||||||
|
// UnclaimedPrizeCount Optional. Number of undistributed prizes
|
||||||
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
||||||
|
// GiveawayMessage Optional. Message with the giveaway that was completed, if it wasn't deleted
|
||||||
GiveawayMessage *Message `json:"giveaway_message,omitempty"`
|
GiveawayMessage *Message `json:"giveaway_message,omitempty"`
|
||||||
|
// IsStarGiveaway Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the
|
||||||
|
// giveaway is a Telegram Premium giveaway.
|
||||||
IsStarGiveaway bool `json:"is_star_giveaway,omitempty"`
|
IsStarGiveaway bool `json:"is_star_giveaway,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// WriteAccessAllowed represents a service message about a user allowing a bot to write messages.
|
// WriteAccessAllowed represents a service message about a user allowing a bot to write messages.
|
||||||
// Since: Bot API 6.4
|
// Since: Bot API 6.4
|
||||||
type WriteAccessAllowed struct {
|
type WriteAccessAllowed struct {
|
||||||
|
// FromRequest Optional. True, if the access was granted after the user accepted an explicit request from a
|
||||||
|
// Web App sent by the method requestWriteAccess
|
||||||
FromRequest bool `json:"from_request,omitempty"`
|
FromRequest bool `json:"from_request,omitempty"`
|
||||||
|
// WebAppName Optional. Name of the Web App, if the access was granted when the Web App was launched from a
|
||||||
|
// link
|
||||||
WebAppName string `json:"web_app_name,omitempty"`
|
WebAppName string `json:"web_app_name,omitempty"`
|
||||||
|
// FromAttachmentMenu Optional. True, if the access was granted when the bot was added to the attachment or
|
||||||
|
// side menu
|
||||||
FromAttachmentMenu bool `json:"from_attachment_menu,omitempty"`
|
FromAttachmentMenu bool `json:"from_attachment_menu,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -577,14 +887,21 @@ const (
|
|||||||
// BackgroundFill describes the way a background is filled.
|
// BackgroundFill describes the way a background is filled.
|
||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
type BackgroundFill struct {
|
type BackgroundFill struct {
|
||||||
|
// Type identifies the concrete fill variant.
|
||||||
Type BackgroundFillType `json:"type"`
|
Type BackgroundFillType `json:"type"`
|
||||||
|
|
||||||
|
// Color The color of the background fill in the RGB24 format
|
||||||
Color int `json:"color,omitempty"`
|
Color int `json:"color,omitempty"`
|
||||||
|
|
||||||
|
// TopColor Top color of the gradient in the RGB24 format
|
||||||
TopColor int `json:"top_color,omitempty"`
|
TopColor int `json:"top_color,omitempty"`
|
||||||
|
// BottomColor Bottom color of the gradient in the RGB24 format
|
||||||
BottomColor int `json:"bottom_color,omitempty"`
|
BottomColor int `json:"bottom_color,omitempty"`
|
||||||
|
// RotationAngle Clockwise rotation angle of the background fill in degrees; 0-359
|
||||||
RotationAngle int `json:"rotation_angle,omitempty"`
|
RotationAngle int `json:"rotation_angle,omitempty"`
|
||||||
|
|
||||||
|
// Colors A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24
|
||||||
|
// format
|
||||||
Colors []int `json:"colors,omitempty"`
|
Colors []int `json:"colors,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -606,18 +923,29 @@ const (
|
|||||||
// BackgroundType describes the type of a background.
|
// BackgroundType describes the type of a background.
|
||||||
// Since: Bot API 7.5
|
// Since: Bot API 7.5
|
||||||
type BackgroundType struct {
|
type BackgroundType struct {
|
||||||
|
// Type identifies the concrete background variant.
|
||||||
Type BackgroundTypeType `json:"type"`
|
Type BackgroundTypeType `json:"type"`
|
||||||
|
|
||||||
|
// Fill contains the background fill for fill and pattern variants.
|
||||||
Fill *BackgroundFill `json:"fill,omitempty"`
|
Fill *BackgroundFill `json:"fill,omitempty"`
|
||||||
|
// DarkThemeDimming Dimming of the background in dark themes, as a percentage; 0-100
|
||||||
DarkThemeDimming int `json:"dark_theme_dimming,omitempty"`
|
DarkThemeDimming int `json:"dark_theme_dimming,omitempty"`
|
||||||
|
|
||||||
|
// Document contains the wallpaper or pattern document for document-backed variants.
|
||||||
Document *Document `json:"document,omitempty"`
|
Document *Document `json:"document,omitempty"`
|
||||||
|
// IsBlurred Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred
|
||||||
|
// with radius 12
|
||||||
IsBlurred bool `json:"is_blurred,omitempty"`
|
IsBlurred bool `json:"is_blurred,omitempty"`
|
||||||
|
// IsMoving Optional. True, if the background moves slightly when the device is tilted
|
||||||
IsMoving bool `json:"is_moving,omitempty"`
|
IsMoving bool `json:"is_moving,omitempty"`
|
||||||
|
|
||||||
|
// Intensity Intensity of the pattern when it is shown above the filled background; 0-100
|
||||||
Intensity int `json:"intensity,omitempty"`
|
Intensity int `json:"intensity,omitempty"`
|
||||||
|
// IsInverted Optional. True, if the background fill must be applied only to the pattern itself. All other
|
||||||
|
// pixels are black in this case. For dark themes only.
|
||||||
IsInverted bool `json:"is_inverted,omitempty"`
|
IsInverted bool `json:"is_inverted,omitempty"`
|
||||||
|
|
||||||
|
// ThemeName Name of the chat theme, which is usually an emoji
|
||||||
ThemeName string `json:"theme_name,omitempty"`
|
ThemeName string `json:"theme_name,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+35
-27
@@ -4,6 +4,7 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"mime/multipart"
|
"mime/multipart"
|
||||||
"net/http"
|
"net/http"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -133,6 +134,7 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
}
|
}
|
||||||
url := fmt.Sprintf("%s/bot%s%s/%s", up.api.apiURL, up.api.token, methodPrefix, r.method)
|
url := fmt.Sprintf("%s/bot%s%s/%s", up.api.apiURL, up.api.token, methodPrefix, r.method)
|
||||||
|
|
||||||
|
retries := 0
|
||||||
for {
|
for {
|
||||||
if up.api.Limiter != nil {
|
if up.api.Limiter != nil {
|
||||||
if err := up.api.Limiter.Check(ctx, up.api.dropOverflowLimit, r.chatID); err != nil {
|
if err := up.api.Limiter.Check(ctx, up.api.dropOverflowLimit, r.chatID); err != nil {
|
||||||
@@ -140,23 +142,21 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
buf, contentType, err := prepareMultipart(r.files, r.params)
|
requestBody, contentType := prepareMultipartStream(r.files, r.params)
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "POST", url, requestBody)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return zero, err
|
_ = requestBody.Close()
|
||||||
}
|
return zero, fmt.Errorf("failed to create upload request: %w", err)
|
||||||
req, err := http.NewRequestWithContext(ctx, "POST", url, buf)
|
|
||||||
if err != nil {
|
|
||||||
return zero, err
|
|
||||||
}
|
}
|
||||||
req.Header.Set("Content-Type", contentType)
|
req.Header.Set("Content-Type", contentType)
|
||||||
req.Header.Set("Accept", "application/json")
|
req.Header.Set("Accept", "application/json")
|
||||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||||
req.ContentLength = int64(buf.Len())
|
|
||||||
|
|
||||||
up.logger.Debugln("UPLOADER REQ", url)
|
up.logger.Debugln("UPLOADER REQ", url)
|
||||||
resp, err := up.api.client.Do(req)
|
resp, err := up.api.client.Do(req)
|
||||||
|
_ = requestBody.Close()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return zero, err
|
return zero, fmt.Errorf("HTTP upload request failed: %w", redactHTTPError(err, up.api.token))
|
||||||
}
|
}
|
||||||
|
|
||||||
body, err := readBody(resp.Body)
|
body, err := readBody(resp.Body)
|
||||||
@@ -172,6 +172,11 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !response.Ok {
|
if !response.Ok {
|
||||||
|
responseErr := &ResponseError{
|
||||||
|
Code: response.ErrorCode,
|
||||||
|
Description: response.Description,
|
||||||
|
Parameters: response.Parameters,
|
||||||
|
}
|
||||||
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||||
after := *response.Parameters.RetryAfter
|
after := *response.Parameters.RetryAfter
|
||||||
up.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatID)
|
up.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatID)
|
||||||
@@ -182,19 +187,19 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
up.api.Limiter.SetGlobalLock(after)
|
up.api.Limiter.SetGlobalLock(after)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if retries >= up.api.maxRetries {
|
||||||
|
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||||
|
}
|
||||||
|
retries++
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return zero, ctx.Err()
|
return zero, ctx.Err()
|
||||||
case <-time.After(time.Duration(after) * time.Second):
|
case <-time.After(retryDelay(after)):
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return zero, &ResponseError{
|
return zero, responseErr
|
||||||
Code: response.ErrorCode,
|
|
||||||
Description: response.Description,
|
|
||||||
Parameters: response.Parameters,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return response.Result, nil
|
return response.Result, nil
|
||||||
}
|
}
|
||||||
@@ -232,36 +237,39 @@ func (r UploaderRequest[R, P]) Do(up *Uploader) (R, error) {
|
|||||||
return r.DoWithContext(context.Background(), up)
|
return r.DoWithContext(context.Background(), up)
|
||||||
}
|
}
|
||||||
|
|
||||||
func prepareMultipart[P any](files []UploaderFile, params P) (*bytes.Buffer, string, error) {
|
func prepareMultipartStream[P any](files []UploaderFile, params P) (io.ReadCloser, string) {
|
||||||
buf := bytes.NewBuffer(nil)
|
reader, writer := io.Pipe()
|
||||||
w := multipart.NewWriter(buf)
|
multipartWriter := multipart.NewWriter(writer)
|
||||||
|
contentType := multipartWriter.FormDataContentType()
|
||||||
|
go func() {
|
||||||
|
err := writeMultipart(multipartWriter, files, params)
|
||||||
|
_ = writer.CloseWithError(err)
|
||||||
|
}()
|
||||||
|
return reader, contentType
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeMultipart[P any](w *multipart.Writer, files []UploaderFile, params P) error {
|
||||||
for _, file := range files {
|
for _, file := range files {
|
||||||
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = w.Close()
|
_ = w.Close()
|
||||||
return nil, "", err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = fw.Write(file.data)
|
_, err = io.Copy(fw, bytes.NewReader(file.data))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = w.Close()
|
_ = w.Close()
|
||||||
return nil, "", err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
err := utils.Encode(w, params)
|
err := utils.Encode(w, params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = w.Close()
|
_ = w.Close()
|
||||||
return nil, "", err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
err = w.Close()
|
return w.Close()
|
||||||
if err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf, w.FormDataContentType(), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func uploaderTypeByExt(filename string) UploaderFileType {
|
func uploaderTypeByExt(filename string) UploaderFileType {
|
||||||
|
|||||||
@@ -278,19 +278,17 @@ func TestPrepareMultipartRichMessageUsesAttachName(t *testing.T) {
|
|||||||
}},
|
}},
|
||||||
}
|
}
|
||||||
|
|
||||||
buf, contentType, err := prepareMultipart(
|
body, contentType := prepareMultipartStream(
|
||||||
[]UploaderFile{NewUploaderFile("animation.mp4", []byte("animation")).SetAttachName("animation")},
|
[]UploaderFile{NewUploaderFile("animation.mp4", []byte("animation")).SetAttachName("animation")},
|
||||||
params,
|
params,
|
||||||
)
|
)
|
||||||
if err != nil {
|
defer func() { _ = body.Close() }()
|
||||||
t.Fatalf("prepareMultipart returned error: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, contentTypeParams, err := mime.ParseMediaType(contentType)
|
_, contentTypeParams, err := mime.ParseMediaType(contentType)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("ParseMediaType returned error: %v", err)
|
t.Fatalf("ParseMediaType returned error: %v", err)
|
||||||
}
|
}
|
||||||
reader := multipart.NewReader(buf, contentTypeParams["boundary"])
|
reader := multipart.NewReader(body, contentTypeParams["boundary"])
|
||||||
|
|
||||||
parts := make(map[string]string)
|
parts := make(map[string]string)
|
||||||
var fileData []byte
|
var fileData []byte
|
||||||
@@ -324,6 +322,43 @@ func TestPrepareMultipartRichMessageUsesAttachName(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUploaderStopsAfterConfiguredRetryLimit(t *testing.T) {
|
||||||
|
calls := 0
|
||||||
|
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
_, _ = io.Copy(io.Discard, req.Body)
|
||||||
|
calls++
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader(
|
||||||
|
`{"ok":false,"error_code":429,"description":"retry","parameters":{"retry_after":0}}`,
|
||||||
|
)),
|
||||||
|
}, nil
|
||||||
|
})}
|
||||||
|
|
||||||
|
api := NewAPI(NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client).
|
||||||
|
SetMaxRetries(1))
|
||||||
|
defer func() { _ = api.Close() }()
|
||||||
|
uploader := NewUploader(api)
|
||||||
|
defer func() { _ = uploader.Close() }()
|
||||||
|
|
||||||
|
_, err := uploader.SendPhoto(
|
||||||
|
UploadPhoto{ChatID: 42},
|
||||||
|
NewUploaderFile("photo.jpg", []byte("img")),
|
||||||
|
)
|
||||||
|
if !errors.Is(err, ErrRetryLimit) {
|
||||||
|
t.Fatalf("expected ErrRetryLimit, got %v", err)
|
||||||
|
}
|
||||||
|
var responseErr *ResponseError
|
||||||
|
if !errors.As(err, &responseErr) || responseErr.Code != http.StatusTooManyRequests {
|
||||||
|
t.Fatalf("expected wrapped 429 ResponseError, got %v", err)
|
||||||
|
}
|
||||||
|
if calls != 2 {
|
||||||
|
t.Fatalf("request count = %d, want 2", calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func readMultipartRequest(req *http.Request) (map[string]string, string, []byte, error) {
|
func readMultipartRequest(req *http.Request) (map[string]string, string, []byte, error) {
|
||||||
_, params, err := mime.ParseMediaType(req.Header.Get("Content-Type"))
|
_, params, err := mime.ParseMediaType(req.Header.Get("Content-Type"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -45,28 +45,58 @@ func (u *Uploader) SendRichMessageDraftWithContext(ctx context.Context, params S
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendphoto
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
type UploadPhoto struct {
|
type UploadPhoto struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Caption Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the photo caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the photo needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,30 +122,60 @@ func (u *Uploader) SendPhotoWithContext(ctx context.Context, params UploadPhoto,
|
|||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
// See https://core.telegram.org/bots/api#sendaudio
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
type UploadAudio struct {
|
type UploadAudio struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Caption Optional. Audio caption, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the audio caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// Duration Optional. Duration of the audio in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Performer Optional. Performer
|
||||||
Performer string `json:"performer,omitempty"`
|
Performer string `json:"performer,omitempty"`
|
||||||
|
// Title Optional. Track name
|
||||||
Title string `json:"title,omitempty"`
|
Title string `json:"title,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -141,27 +201,57 @@ func (u *Uploader) SendAudioWithContext(ctx context.Context, params UploadAudio,
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#senddocument
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
type UploadDocument struct {
|
type UploadDocument struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Caption Optional. Document caption (may also be used when resending documents by file_id), 0-1024
|
||||||
|
// characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the document caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// DisableContentTypeDetection Optional. Disables automatic server-side content type detection for files
|
||||||
|
// uploaded using multipart/form-data
|
||||||
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -187,34 +277,69 @@ func (u *Uploader) SendDocumentWithContext(ctx context.Context, params UploadDoc
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#sendvideo
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
type UploadVideo struct {
|
type UploadVideo struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Duration Optional. Duration of sent video in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Width Optional. Video width
|
||||||
Width int `json:"width,omitempty"`
|
Width int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Video height
|
||||||
Height int `json:"height,omitempty"`
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||||
StartTimestamp int64 `json:"start_timestamp,omitempty"`
|
StartTimestamp int64 `json:"start_timestamp,omitempty"`
|
||||||
|
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||||
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -240,32 +365,65 @@ func (u *Uploader) SendVideoWithContext(ctx context.Context, params UploadVideo,
|
|||||||
// Since: Bot API 4.0
|
// Since: Bot API 4.0
|
||||||
// See https://core.telegram.org/bots/api#sendanimation
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
type UploadAnimation struct {
|
type UploadAnimation struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Duration Optional. Duration of sent animation in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Width Optional. Animation width
|
||||||
Width int `json:"width,omitempty"`
|
Width int `json:"width,omitempty"`
|
||||||
|
// Height Optional. Animation height
|
||||||
Height int `json:"height,omitempty"`
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
// Caption Optional. Animation caption (may also be used when resending animation by file_id), 0-1024
|
||||||
|
// characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the animation caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the animation needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,27 +449,55 @@ func (u *Uploader) SendAnimationWithContext(ctx context.Context, params UploadAn
|
|||||||
// Since: Bot API 1.2
|
// Since: Bot API 1.2
|
||||||
// See https://core.telegram.org/bots/api#sendvoice
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
type UploadVoice struct {
|
type UploadVoice struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Caption Optional. Voice message caption, 0-1024 characters after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the voice message caption. See formatting options for
|
||||||
|
// more details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
// Duration Optional. Duration of the voice message in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -337,25 +523,49 @@ func (u *Uploader) SendVoiceWithContext(ctx context.Context, params UploadVoice,
|
|||||||
// Since: Bot API 3.0
|
// Since: Bot API 3.0
|
||||||
// See https://core.telegram.org/bots/api#sendvideonote
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
type UploadVideoNote struct {
|
type UploadVideoNote struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||||
|
// channel in the format @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
|
||||||
|
// Duration Optional. Duration of sent video in seconds
|
||||||
Duration int `json:"duration,omitempty"`
|
Duration int `json:"duration,omitempty"`
|
||||||
|
// Length Optional. Video width and height, i.e. diameter of the video message
|
||||||
Length int `json:"length,omitempty"`
|
Length int `json:"length,omitempty"`
|
||||||
|
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -381,6 +591,8 @@ func (u *Uploader) SendVideoNoteWithContext(ctx context.Context, params UploadVi
|
|||||||
// Since: Bot API 3.1
|
// Since: Bot API 3.1
|
||||||
// See https://core.telegram.org/bots/api#setchatphoto
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
type UploadChatPhoto struct {
|
type UploadChatPhoto struct {
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel in the format
|
||||||
|
// @username
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -407,11 +619,28 @@ func (u *Uploader) SetChatPhotoWithContext(ctx context.Context, params UploadCha
|
|||||||
// Use this type when uploading a self-signed certificate file.
|
// Use this type when uploading a self-signed certificate file.
|
||||||
// See https://core.telegram.org/bots/api#setwebhook
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
type UploadSetWebhook struct {
|
type UploadSetWebhook struct {
|
||||||
|
// URL Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration.
|
||||||
URL string `json:"url"`
|
URL string `json:"url"`
|
||||||
|
// IPAddress Optional. The fixed IP address which will be used to send webhook requests instead of the IP
|
||||||
|
// address resolved through DNS
|
||||||
IPAddress string `json:"ip_address,omitempty"`
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
// MaxConnections Optional. The 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.
|
||||||
MaxConnections int8 `json:"max_connections,omitempty"`
|
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||||
|
// AllowedUpdates Optional. 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
|
||||||
|
// update types except chat_member, message_reaction, and message_reaction_count (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.
|
||||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
|
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
|
// SecretToken Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in
|
||||||
|
// every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header
|
||||||
|
// is useful to ensure that the request comes from a webhook set by you.
|
||||||
SecretToken string `json:"secret_token,omitempty"`
|
SecretToken string `json:"secret_token,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -437,28 +666,58 @@ func (u *Uploader) SetWebhookWithContext(ctx context.Context, params UploadSetWe
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||||
type UploadLivePhoto struct {
|
type UploadLivePhoto struct {
|
||||||
|
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||||
|
// message will be sent
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
// ChatID Required. Unique identifier for the target chat or username of the target channel (in the format
|
||||||
|
// @channelusername)
|
||||||
ChatID int64 `json:"chat_id"`
|
ChatID int64 `json:"chat_id"`
|
||||||
|
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||||
|
// supergroups and private chats of bots with forum topic mode enabled only
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||||
|
// sent; required if the message is sent to a direct messages chat
|
||||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||||
|
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||||
|
// after entities parsing
|
||||||
Caption string `json:"caption,omitempty"`
|
Caption string `json:"caption,omitempty"`
|
||||||
|
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||||
|
// details.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||||
|
// can be specified instead of parse_mode
|
||||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||||
|
// sound.
|
||||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||||
|
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||||
|
// balance.
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||||
|
// chats only
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||||
|
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||||
|
// post, then that suggested post is automatically declined.
|
||||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
// ReplyParameters Optional. Description of the message to reply to
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||||
|
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,8 +6,13 @@ import "context"
|
|||||||
// Since: Bot API 1.4
|
// Since: Bot API 1.4
|
||||||
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||||
type GetUserProfilePhotos struct {
|
type GetUserProfilePhotos struct {
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Offset Optional. Sequential number of the first photo to be returned. By default, all photos are
|
||||||
|
// returned.
|
||||||
Offset int `json:"offset,omitempty"`
|
Offset int `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults
|
||||||
|
// to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,8 +37,13 @@ func (api *API) GetUserProfilePhotosWithContext(ctx context.Context, params GetU
|
|||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||||
type GetUserProfileAudios struct {
|
type GetUserProfileAudios struct {
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Offset Optional. Sequential number of the first audio to be returned. By default, all audios are
|
||||||
|
// returned.
|
||||||
Offset int `json:"offset,omitempty"`
|
Offset int `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults
|
||||||
|
// to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,8 +68,12 @@ func (api *API) GetUserProfileAudiosWithContext(ctx context.Context, params GetU
|
|||||||
// Since: Bot API 8.0
|
// Since: Bot API 8.0
|
||||||
// See https://core.telegram.org/bots/api#setuseremojistatus
|
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||||
type SetUserEmojiStatus struct {
|
type SetUserEmojiStatus struct {
|
||||||
|
// UserID Required. Unique identifier of the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// EmojiID Optional. Custom emoji identifier of the emoji status to set. Pass an empty string to remove the
|
||||||
|
// status.
|
||||||
EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
|
EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||||
|
// ExpirationDate Optional. Expiration date of the emoji status, if any
|
||||||
ExpirationDate int `json:"emoji_status_expiration_date,omitempty"`
|
ExpirationDate int `json:"emoji_status_expiration_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -85,14 +99,28 @@ func (api *API) SetUserEmojiStatusWithContext(ctx context.Context, params SetUse
|
|||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
// See https://core.telegram.org/bots/api#getusergifts
|
// See https://core.telegram.org/bots/api#getusergifts
|
||||||
type GetUserGifts struct {
|
type GetUserGifts struct {
|
||||||
|
// UserID Required. Unique identifier of the user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// ExcludeUnlimited Optional. Pass True to exclude gifts that can be purchased an unlimited number of times
|
||||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
// ExcludeLimitedUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number of
|
||||||
|
// times and can be upgraded to unique
|
||||||
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
// ExcludeLimitedNonUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number
|
||||||
|
// of times and can't be upgraded to unique
|
||||||
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
// ExcludeUnique Optional. Pass True to exclude unique gifts
|
||||||
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
// ExcludeFromBlockchain Optional. Pass True to exclude gifts that were assigned from the TON blockchain and
|
||||||
|
// can't be resold or transferred in Telegram
|
||||||
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
// SortByPrice Optional. Pass True to sort results by gift price instead of send date. Sorting is applied
|
||||||
|
// before pagination.
|
||||||
SortByPrice bool `json:"sort_by_price,omitempty"`
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
// Offset Optional. Offset of the first entry to return as received from the previous request; use an empty
|
||||||
|
// string to get the first chunk of results
|
||||||
Offset string `json:"offset,omitempty"`
|
Offset string `json:"offset,omitempty"`
|
||||||
|
// Limit Optional. The maximum number of gifts to be returned; 1-100. Defaults to 100.
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -117,8 +145,11 @@ func (api *API) GetUserGiftsWithContext(ctx context.Context, params GetUserGifts
|
|||||||
// Since: Bot API 10.0
|
// Since: Bot API 10.0
|
||||||
// See https://core.telegram.org/bots/api#getuserpersonalchatmessages
|
// See https://core.telegram.org/bots/api#getuserpersonalchatmessages
|
||||||
type GetUserPersonalChatMessages struct {
|
type GetUserPersonalChatMessages struct {
|
||||||
|
// UserID Required. Unique identifier for the target user
|
||||||
UserID int64 `json:"user_id"`
|
UserID int64 `json:"user_id"`
|
||||||
|
// Offset is the zero-based offset of the first message to return.
|
||||||
Offset int `json:"offset,omitempty"`
|
Offset int `json:"offset,omitempty"`
|
||||||
|
// Limit Required. The maximum number of messages to return; 1-20
|
||||||
Limit int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,23 +4,48 @@ package tgapi
|
|||||||
// Since: Bot API 1.0
|
// Since: Bot API 1.0
|
||||||
// See https://core.telegram.org/bots/api#user
|
// See https://core.telegram.org/bots/api#user
|
||||||
type User struct {
|
type User struct {
|
||||||
|
// ID Unique identifier for this user or bot. This number may have more than 32 significant bits and some
|
||||||
|
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
|
||||||
|
// significant bits, so a 64-bit integer or double-precision float type are safe for storing this
|
||||||
|
// identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
|
// FirstName User's or bot's first name
|
||||||
FirstName string `json:"first_name"`
|
FirstName string `json:"first_name"`
|
||||||
|
// LastName Optional. User's or bot's last name
|
||||||
LastName *string `json:"last_name,omitempty"`
|
LastName *string `json:"last_name,omitempty"`
|
||||||
|
// Username Optional. User's or bot's username
|
||||||
Username *string `json:"username,omitempty"`
|
Username *string `json:"username,omitempty"`
|
||||||
|
|
||||||
|
// IsBot True, if this user is a bot
|
||||||
IsBot bool `json:"is_bot"` // Since: Bot API 3.3
|
IsBot bool `json:"is_bot"` // Since: Bot API 3.3
|
||||||
|
// LanguageCode Optional. IETF language tag of the user's language
|
||||||
LanguageCode *string `json:"language_code,omitempty"` // Since: Bot API 3.0
|
LanguageCode *string `json:"language_code,omitempty"` // Since: Bot API 3.0
|
||||||
|
// IsPremium Optional. True, if this user is a Telegram Premium user
|
||||||
IsPremium *bool `json:"is_premium,omitempty"` // Since: Bot API 6.1
|
IsPremium *bool `json:"is_premium,omitempty"` // Since: Bot API 6.1
|
||||||
|
// AddedToAttachmentMenu Optional. True, if this user added the bot to the attachment menu
|
||||||
AddedToAttachmentMenu *bool `json:"added_to_attachment_menu,omitempty"` // Since: Bot API 6.1
|
AddedToAttachmentMenu *bool `json:"added_to_attachment_menu,omitempty"` // Since: Bot API 6.1
|
||||||
|
// CanJoinGroups Optional. True, if the bot can be invited to groups. Returned only in getMe.
|
||||||
CanJoinGroups *bool `json:"can_join_groups,omitempty"` // Since: Bot API 4.6
|
CanJoinGroups *bool `json:"can_join_groups,omitempty"` // Since: Bot API 4.6
|
||||||
|
// CanReadAllGroupMessages Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
|
||||||
CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"` // Since: Bot API 4.6
|
CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"` // Since: Bot API 4.6
|
||||||
|
// SupportsInlineQueries Optional. True, if the bot supports inline queries. Returned only in getMe.
|
||||||
SupportsInlineQueries *bool `json:"supports_inline_queries,omitempty"` // Since: Bot API 4.6
|
SupportsInlineQueries *bool `json:"supports_inline_queries,omitempty"` // Since: Bot API 4.6
|
||||||
|
// CanConnectToBusiness Optional. True, if the bot can be connected to a user account to manage it. Returned
|
||||||
|
// only in getMe.
|
||||||
CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"` // Since: Bot API 7.2
|
CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"` // Since: Bot API 7.2
|
||||||
|
// HasMainWebApp Optional. True, if the bot has a main Web App. Returned only in getMe.
|
||||||
HasMainWebApp *bool `json:"has_main_web_app,omitempty"` // Since: Bot API 7.8
|
HasMainWebApp *bool `json:"has_main_web_app,omitempty"` // Since: Bot API 7.8
|
||||||
|
// HasTopicsEnabled Optional. True, if the bot has forum topic mode enabled in private chats. Returned only
|
||||||
|
// in getMe.
|
||||||
HasTopicsEnabled *bool `json:"has_topics_enabled,omitempty"` // Since: Bot API 9.3
|
HasTopicsEnabled *bool `json:"has_topics_enabled,omitempty"` // Since: Bot API 9.3
|
||||||
|
// AllowsUsersToCreateTopics Optional. True, if the bot allows users to create and delete topics in private
|
||||||
|
// chats. Returned only in getMe.
|
||||||
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"` // Since: Bot API 9.4
|
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"` // Since: Bot API 9.4
|
||||||
|
// CanManageBots Optional. True, if other bots can be created to be controlled by the bot. Returned only in
|
||||||
|
// getMe.
|
||||||
CanManageBots *bool `json:"can_manage_bots,omitempty"` // Since: Bot API 9.6
|
CanManageBots *bool `json:"can_manage_bots,omitempty"` // Since: Bot API 9.6
|
||||||
|
// SupportsGuestQueries Optional. True, if the bot supports guest queries from chats it is not a member of.
|
||||||
|
// Returned only in getMe.
|
||||||
SupportsGuestQueries *bool `json:"supports_guest_queries,omitempty"` // Since: Bot API 10.0
|
SupportsGuestQueries *bool `json:"supports_guest_queries,omitempty"` // Since: Bot API 10.0
|
||||||
|
|
||||||
// SupportsJoinRequestQueries reports that the bot supports join request
|
// SupportsJoinRequestQueries reports that the bot supports join request
|
||||||
@@ -32,7 +57,9 @@ type User struct {
|
|||||||
// Since: Bot API 1.4
|
// Since: Bot API 1.4
|
||||||
// See https://core.telegram.org/bots/api#userprofilephotos
|
// See https://core.telegram.org/bots/api#userprofilephotos
|
||||||
type UserProfilePhotos struct {
|
type UserProfilePhotos struct {
|
||||||
|
// TotalCount Total number of profile pictures the target user has
|
||||||
TotalCount int `json:"total_count"`
|
TotalCount int `json:"total_count"`
|
||||||
|
// Photos Requested profile pictures (in up to 4 sizes each)
|
||||||
Photos [][]PhotoSize `json:"photos"`
|
Photos [][]PhotoSize `json:"photos"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -40,7 +67,9 @@ type UserProfilePhotos struct {
|
|||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
// See https://core.telegram.org/bots/api#userprofileaudios
|
// See https://core.telegram.org/bots/api#userprofileaudios
|
||||||
type UserProfileAudios struct {
|
type UserProfileAudios struct {
|
||||||
|
// TotalCount Total number of profile audios for the target user
|
||||||
TotalCount int `json:"total_count"`
|
TotalCount int `json:"total_count"`
|
||||||
|
// Audios Requested profile audios
|
||||||
Audios []Audio `json:"audios"`
|
Audios []Audio `json:"audios"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -48,9 +77,15 @@ type UserProfileAudios struct {
|
|||||||
// Since: Bot API 9.3
|
// Since: Bot API 9.3
|
||||||
// See https://core.telegram.org/bots/api#userrating
|
// See https://core.telegram.org/bots/api#userrating
|
||||||
type UserRating struct {
|
type UserRating struct {
|
||||||
|
// Level Current level of the user, indicating their reliability when purchasing digital goods and services.
|
||||||
|
// A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.
|
||||||
Level int `json:"level"`
|
Level int `json:"level"`
|
||||||
|
// Rating Numerical value of the user's rating; the higher the rating, the better
|
||||||
Rating int `json:"rating"`
|
Rating int `json:"rating"`
|
||||||
|
// CurrentLevelRating The rating value required to get the current level
|
||||||
CurrentLevelRating int `json:"current_level_rating"`
|
CurrentLevelRating int `json:"current_level_rating"`
|
||||||
|
// NextLevelRating Optional. The rating value required to get to the next level; omitted if the maximum
|
||||||
|
// level was reached
|
||||||
NextLevelRating int `json:"next_level_rating"`
|
NextLevelRating int `json:"next_level_rating"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,7 +93,10 @@ type UserRating struct {
|
|||||||
// Since: Bot API 7.2
|
// Since: Bot API 7.2
|
||||||
// See https://core.telegram.org/bots/api#birthdate
|
// See https://core.telegram.org/bots/api#birthdate
|
||||||
type Birthdate struct {
|
type Birthdate struct {
|
||||||
|
// Day Day of the user's birth; 1-31
|
||||||
Day int `json:"day"`
|
Day int `json:"day"`
|
||||||
|
// Month Month of the user's birth; 1-12
|
||||||
Month int `json:"month"`
|
Month int `json:"month"`
|
||||||
|
// Year Optional. Year of the user's birth
|
||||||
Year int `json:"year"`
|
Year int `json:"year"`
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestTelegramWireFieldNames(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
value any
|
||||||
|
keys []string
|
||||||
|
bad []string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "successful payment provider charge",
|
||||||
|
value: SuccessfulPayment{ProviderPaymentChargeID: "provider"},
|
||||||
|
keys: []string{"provider_payment_charge_id"},
|
||||||
|
bad: []string{"proviced_payment_charge_id"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "refunded payment provider charge",
|
||||||
|
value: RefundedPayment{ProviderPaymentChargeID: "provider"},
|
||||||
|
keys: []string{"provider_payment_charge_id"},
|
||||||
|
bad: []string{"proviced_payment_charge_id"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "owned gift id",
|
||||||
|
value: OwnedGift{OwnedGiftID: "gift"},
|
||||||
|
keys: []string{"owned_gift_id"},
|
||||||
|
bad: []string{"ownen_gift_id"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "input checklist permissions",
|
||||||
|
value: InputChecklist{
|
||||||
|
OtherCanAddTasks: true,
|
||||||
|
OtherCanMarkTasksAsDone: true,
|
||||||
|
},
|
||||||
|
keys: []string{"others_can_add_tasks", "others_can_mark_tasks_as_done"},
|
||||||
|
bad: []string{"other_can_add_tasks", "other_can_mark_tasks_as_done"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "available reactions",
|
||||||
|
value: ChatFullInfo{AvailableReaction: []ReactionType{{Type: "emoji"}}},
|
||||||
|
keys: []string{"available_reactions"},
|
||||||
|
bad: []string{"available_reaction"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "reply quote parse mode",
|
||||||
|
value: ReplyParameters{QuoteParsingMode: "HTML"},
|
||||||
|
keys: []string{"quote_parse_mode"},
|
||||||
|
bad: []string{"quote_parsing_mode"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
data, err := json.Marshal(tt.value)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
for _, key := range tt.keys {
|
||||||
|
if !strings.Contains(string(data), `"`+key+`"`) {
|
||||||
|
t.Errorf("expected key %q in %s", key, data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, key := range tt.bad {
|
||||||
|
if strings.Contains(string(data), `"`+key+`"`) {
|
||||||
|
t.Errorf("unexpected misspelled key %q in %s", key, data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+42
-5
@@ -41,7 +41,7 @@ func (s MarkdownV2) Mention(userID uint64) MarkdownV2 {
|
|||||||
|
|
||||||
// Emoji returns s as a Telegram MarkdownV2 custom emoji.
|
// Emoji returns s as a Telegram MarkdownV2 custom emoji.
|
||||||
func (s MarkdownV2) Emoji(emojiID string) MarkdownV2 {
|
func (s MarkdownV2) Emoji(emojiID string) MarkdownV2 {
|
||||||
return "[" + s + "](tg://emoji?id=" + escapeMarkdownV2LinkDestination(emojiID) + ")"
|
return " + ")"
|
||||||
}
|
}
|
||||||
|
|
||||||
// Time returns s as a Telegram MarkdownV2 localized timestamp.
|
// Time returns s as a Telegram MarkdownV2 localized timestamp.
|
||||||
@@ -56,14 +56,19 @@ func (s MarkdownV2) TimeFormat(unix uint64, format string) MarkdownV2 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// InlineCode returns s wrapped as inline code Telegram MarkdownV2 text.
|
// InlineCode returns s wrapped as inline code Telegram MarkdownV2 text.
|
||||||
func (s MarkdownV2) InlineCode() MarkdownV2 { return "`" + s + "`" }
|
func (s MarkdownV2) InlineCode() MarkdownV2 {
|
||||||
|
return "`" + escapeMarkdownV2Code(unescapeMarkdownV2Fragment(s)) + "`"
|
||||||
|
}
|
||||||
|
|
||||||
// BlockCode returns s wrapped as a Telegram MarkdownV2 code block.
|
// BlockCode returns s wrapped as a Telegram MarkdownV2 code block.
|
||||||
func (s MarkdownV2) BlockCode() MarkdownV2 { return "```\n" + s + "\n```" }
|
func (s MarkdownV2) BlockCode() MarkdownV2 {
|
||||||
|
return "```\n" + escapeMarkdownV2Code(unescapeMarkdownV2Fragment(s)) + "\n```"
|
||||||
|
}
|
||||||
|
|
||||||
// BlockCodeLanguage returns s wrapped as a Telegram MarkdownV2 code block with language.
|
// BlockCodeLanguage returns s wrapped as a Telegram MarkdownV2 code block with language.
|
||||||
func (s MarkdownV2) BlockCodeLanguage(lang string) MarkdownV2 {
|
func (s MarkdownV2) BlockCodeLanguage(lang string) MarkdownV2 {
|
||||||
return "```" + MarkdownV2(lang) + "\n" + s + "\n```"
|
return "```" + MarkdownV2(sanitizeMarkdownV2CodeLanguage(lang)) + "\n" +
|
||||||
|
escapeMarkdownV2Code(unescapeMarkdownV2Fragment(s)) + "\n```"
|
||||||
}
|
}
|
||||||
|
|
||||||
// Quote returns s as a Telegram MarkdownV2 blockquote.
|
// Quote returns s as a Telegram MarkdownV2 blockquote.
|
||||||
@@ -72,7 +77,39 @@ func (s MarkdownV2) Quote() MarkdownV2 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// QuoteExpandable returns s as a Telegram MarkdownV2 expandable blockquote.
|
// QuoteExpandable returns s as a Telegram MarkdownV2 expandable blockquote.
|
||||||
func (s MarkdownV2) QuoteExpandable() MarkdownV2 { return "**>" + s }
|
func (s MarkdownV2) QuoteExpandable() MarkdownV2 {
|
||||||
|
return MarkdownV2("**>" + strings.ReplaceAll(string(s), "\n", "\n>") + "||")
|
||||||
|
}
|
||||||
|
|
||||||
|
func unescapeMarkdownV2Fragment(s MarkdownV2) string {
|
||||||
|
fragment := string(s)
|
||||||
|
var result strings.Builder
|
||||||
|
result.Grow(len(fragment))
|
||||||
|
for i := 0; i < len(fragment); i++ {
|
||||||
|
if fragment[i] == '\\' && i+1 < len(fragment) && fragment[i+1] >= 1 && fragment[i+1] <= 126 {
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
result.WriteByte(fragment[i])
|
||||||
|
}
|
||||||
|
return result.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func escapeMarkdownV2Code(s string) MarkdownV2 {
|
||||||
|
s = strings.ReplaceAll(s, "\\", "\\\\")
|
||||||
|
s = strings.ReplaceAll(s, "`", "\\`")
|
||||||
|
return MarkdownV2(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func sanitizeMarkdownV2CodeLanguage(lang string) string {
|
||||||
|
return strings.Map(func(r rune) rune {
|
||||||
|
switch r {
|
||||||
|
case '`', '\\', '\r', '\n':
|
||||||
|
return -1
|
||||||
|
default:
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
}, lang)
|
||||||
|
}
|
||||||
|
|
||||||
func escapeMarkdownV2LinkDestination(s string) MarkdownV2 {
|
func escapeMarkdownV2LinkDestination(s string) MarkdownV2 {
|
||||||
s = strings.ReplaceAll(s, "\\", "\\\\")
|
s = strings.ReplaceAll(s, "\\", "\\\\")
|
||||||
|
|||||||
+4
-2
@@ -35,7 +35,9 @@ func TestMarkdownV2FormattingMethods(t *testing.T) {
|
|||||||
{name: "block code", got: EscapeMarkdownV2("text").BlockCode(), want: "```\ntext\n```"},
|
{name: "block code", got: EscapeMarkdownV2("text").BlockCode(), want: "```\ntext\n```"},
|
||||||
{name: "block code language", got: EscapeMarkdownV2("text").BlockCodeLanguage("go"), want: "```go\ntext\n```"},
|
{name: "block code language", got: EscapeMarkdownV2("text").BlockCodeLanguage("go"), want: "```go\ntext\n```"},
|
||||||
{name: "quote", got: EscapeMarkdownV2("a\nb").Quote(), want: ">a\n>b"},
|
{name: "quote", got: EscapeMarkdownV2("a\nb").Quote(), want: ">a\n>b"},
|
||||||
{name: "expandable quote", got: EscapeMarkdownV2("text").QuoteExpandable(), want: "**>text"},
|
{name: "expandable quote", got: EscapeMarkdownV2("a\nb").QuoteExpandable(), want: "**>a\n>b||"},
|
||||||
|
{name: "inline code escaping", got: EscapeMarkdownV2("a-b`c\\d").InlineCode(), want: "`a-b\\`c\\\\d`"},
|
||||||
|
{name: "block code language sanitizing", got: EscapeMarkdownV2("text").BlockCodeLanguage("go`\nboom"), want: "```goboom\ntext\n```"},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
@@ -63,7 +65,7 @@ func TestMarkdownV2SpecialLinks(t *testing.T) {
|
|||||||
want MarkdownV2
|
want MarkdownV2
|
||||||
}{
|
}{
|
||||||
{name: "mention", got: EscapeMarkdownV2("User").Mention(123), want: "[User](tg://user?id=123)"},
|
{name: "mention", got: EscapeMarkdownV2("User").Mention(123), want: "[User](tg://user?id=123)"},
|
||||||
{name: "emoji", got: EscapeMarkdownV2("emoji").Emoji(`12)3`), want: `[emoji](tg://emoji?id=12\)3)`},
|
{name: "emoji", got: EscapeMarkdownV2("👍").Emoji(`12)3`), want: `3)`},
|
||||||
{name: "time", got: EscapeMarkdownV2("date").Time(1772323200), want: ""},
|
{name: "time", got: EscapeMarkdownV2("date").Time(1772323200), want: ""},
|
||||||
{name: "time format", got: EscapeMarkdownV2("date").TimeFormat(1772323200, `MMM ) yyyy`), want: ` yyyy)`},
|
{name: "time format", got: EscapeMarkdownV2("date").TimeFormat(1772323200, `MMM ) yyyy`), want: ` yyyy)`},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -216,6 +216,13 @@ func TestBuildHTMLLimits(t *testing.T) {
|
|||||||
{"combined nesting too deep", func() []tgapi.InputRichBlock {
|
{"combined nesting too deep", func() []tgapi.InputRichBlock {
|
||||||
return []tgapi.InputRichBlock{P(wrapBold(Text("text"), maxRichDepth))}
|
return []tgapi.InputRichBlock{P(wrapBold(Text("text"), maxRichDepth))}
|
||||||
}, ErrRichNestingTooDeep},
|
}, ErrRichNestingTooDeep},
|
||||||
|
{"rich text arrays too deep", func() []tgapi.InputRichBlock {
|
||||||
|
text := tgapi.RichText(Text("text"))
|
||||||
|
for range maxRichDepth {
|
||||||
|
text = tgapi.RichTextArray{text}
|
||||||
|
}
|
||||||
|
return []tgapi.InputRichBlock{P(text)}
|
||||||
|
}, ErrRichNestingTooDeep},
|
||||||
{"maximum block nesting", func() []tgapi.InputRichBlock {
|
{"maximum block nesting", func() []tgapi.InputRichBlock {
|
||||||
return []tgapi.InputRichBlock{wrapDetails(P(Text("text")), maxRichDepth-1)}
|
return []tgapi.InputRichBlock{wrapDetails(P(Text("text")), maxRichDepth-1)}
|
||||||
}, nil},
|
}, nil},
|
||||||
|
|||||||
@@ -80,9 +80,12 @@ func renderText(t tgapi.RichText, step int) (string, error) {
|
|||||||
case tgapi.RichTextPlain:
|
case tgapi.RichTextPlain:
|
||||||
return escapeHTML(string(el)), nil
|
return escapeHTML(string(el)), nil
|
||||||
case tgapi.RichTextArray:
|
case tgapi.RichTextArray:
|
||||||
|
if step >= maxRichDepth {
|
||||||
|
return "", ErrRichNestingTooDeep
|
||||||
|
}
|
||||||
var b strings.Builder
|
var b strings.Builder
|
||||||
for _, item := range el {
|
for _, item := range el {
|
||||||
part, err := renderText(item, step)
|
part, err := renderText(item, step+1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|||||||
+27
-18
@@ -119,8 +119,11 @@ func (v *richValidator) text(text tgapi.RichText, depth int) error {
|
|||||||
case tgapi.RichTextPlain:
|
case tgapi.RichTextPlain:
|
||||||
return v.addChars(string(el))
|
return v.addChars(string(el))
|
||||||
case tgapi.RichTextArray:
|
case tgapi.RichTextArray:
|
||||||
|
if depth >= maxRichDepth {
|
||||||
|
return ErrRichNestingTooDeep
|
||||||
|
}
|
||||||
for _, item := range el {
|
for _, item := range el {
|
||||||
if err := v.text(item, depth); err != nil {
|
if err := v.text(item, depth+1); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -176,7 +179,7 @@ func (v *richValidator) text(text tgapi.RichText, depth int) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func validateAutomaticEntity(text tgapi.RichText, semantic string) error {
|
func validateAutomaticEntity(text tgapi.RichText, semantic string) error {
|
||||||
visible, err := visibleRichText(text)
|
visible, err := visibleRichText(text, 0)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -186,16 +189,22 @@ func validateAutomaticEntity(text tgapi.RichText, semantic string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func visibleRichText(text tgapi.RichText) (string, error) {
|
func visibleRichText(text tgapi.RichText, depth int) (string, error) {
|
||||||
|
if depth > maxRichDepth {
|
||||||
|
return "", ErrRichNestingTooDeep
|
||||||
|
}
|
||||||
switch el := text.(type) {
|
switch el := text.(type) {
|
||||||
case nil:
|
case nil:
|
||||||
return "", nil
|
return "", nil
|
||||||
case tgapi.RichTextPlain:
|
case tgapi.RichTextPlain:
|
||||||
return string(el), nil
|
return string(el), nil
|
||||||
case tgapi.RichTextArray:
|
case tgapi.RichTextArray:
|
||||||
|
if depth >= maxRichDepth {
|
||||||
|
return "", ErrRichNestingTooDeep
|
||||||
|
}
|
||||||
var result strings.Builder
|
var result strings.Builder
|
||||||
for _, item := range el {
|
for _, item := range el {
|
||||||
part, err := visibleRichText(item)
|
part, err := visibleRichText(item, depth+1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
@@ -209,33 +218,33 @@ func visibleRichText(text tgapi.RichText) (string, error) {
|
|||||||
case tgapi.RichTextAnchor:
|
case tgapi.RichTextAnchor:
|
||||||
return "", nil
|
return "", nil
|
||||||
case tgapi.RichTextWrap:
|
case tgapi.RichTextWrap:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextURL:
|
case tgapi.RichTextURL:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextEmailAddress:
|
case tgapi.RichTextEmailAddress:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextPhoneNumber:
|
case tgapi.RichTextPhoneNumber:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextBankCardNumber:
|
case tgapi.RichTextBankCardNumber:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextMention:
|
case tgapi.RichTextMention:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextHashtag:
|
case tgapi.RichTextHashtag:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextCashtag:
|
case tgapi.RichTextCashtag:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextBotCommand:
|
case tgapi.RichTextBotCommand:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextAnchorLink:
|
case tgapi.RichTextAnchorLink:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextReference:
|
case tgapi.RichTextReference:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextReferenceLink:
|
case tgapi.RichTextReferenceLink:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextDateTime:
|
case tgapi.RichTextDateTime:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
case tgapi.RichTextTextMention:
|
case tgapi.RichTextTextMention:
|
||||||
return visibleRichText(el.Text)
|
return visibleRichText(el.Text, depth+1)
|
||||||
default:
|
default:
|
||||||
return "", ErrRichUnknownTag
|
return "", ErrRichUnknownTag
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-5
@@ -31,7 +31,7 @@ func (bot *Bot[T]) handleUpdate(u *tgapi.Update, ctx *MessageContext) bool {
|
|||||||
FromID: pluginCtx.FromID,
|
FromID: pluginCtx.FromID,
|
||||||
ChatID: pluginCtx.ChatID,
|
ChatID: pluginCtx.ChatID,
|
||||||
})
|
})
|
||||||
err := handler(pluginCtx, bot.appData)
|
err := callCommandExecutor(handler, pluginCtx, bot.appData)
|
||||||
endEvent := HandlerFinishedEvent{
|
endEvent := HandlerFinishedEvent{
|
||||||
UpdateID: u.UpdateID,
|
UpdateID: u.UpdateID,
|
||||||
UpdateType: u.Type,
|
UpdateType: u.Type,
|
||||||
@@ -201,10 +201,10 @@ func (bot *Bot[T]) prepareUpdateCtx(u *tgapi.Update, ctx *MessageContext) {
|
|||||||
}
|
}
|
||||||
case tgapi.UpdateTypePollAnswer:
|
case tgapi.UpdateTypePollAnswer:
|
||||||
if u.PollAnswer != nil {
|
if u.PollAnswer != nil {
|
||||||
if u.PollAnswer.User.ID != 0 {
|
if voter, ok := u.PollAnswer.VoterUser(); ok {
|
||||||
from = &u.PollAnswer.User
|
from = voter
|
||||||
} else if u.PollAnswer.VoterChat.ID != 0 {
|
} else if voterChat, ok := u.PollAnswer.VoterChatInfo(); ok {
|
||||||
chat = &u.PollAnswer.VoterChat
|
chat = voterChat
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
case tgapi.UpdateTypeMessageReaction:
|
case tgapi.UpdateTypeMessageReaction:
|
||||||
|
|||||||
+71
-27
@@ -28,7 +28,8 @@ type RateLimiter struct {
|
|||||||
chatLocks map[int64]time.Time // per-chat cooldown timestamps
|
chatLocks map[int64]time.Time // per-chat cooldown timestamps
|
||||||
chatLimiters map[int64]*rate.Limiter // per-chat token buckets (1 req/sec)
|
chatLimiters map[int64]*rate.Limiter // per-chat token buckets (1 req/sec)
|
||||||
chatLastSeen map[int64]time.Time // last access timestamp per chat, for Cleanup eviction
|
chatLastSeen map[int64]time.Time // last access timestamp per chat, for Cleanup eviction
|
||||||
chatMu sync.RWMutex // protects chatLocks, chatLimiters, and chatLastSeen
|
chatActive map[int64]int // in-flight users of each per-chat limiter
|
||||||
|
chatMu sync.RWMutex // protects all per-chat maps
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewRateLimiter creates a new RateLimiter with default limits.
|
// NewRateLimiter creates a new RateLimiter with default limits.
|
||||||
@@ -40,6 +41,7 @@ func NewRateLimiter() *RateLimiter {
|
|||||||
chatLimiters: make(map[int64]*rate.Limiter),
|
chatLimiters: make(map[int64]*rate.Limiter),
|
||||||
chatLocks: make(map[int64]time.Time),
|
chatLocks: make(map[int64]time.Time),
|
||||||
chatLastSeen: make(map[int64]time.Time),
|
chatLastSeen: make(map[int64]time.Time),
|
||||||
|
chatActive: make(map[int64]int),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -50,16 +52,20 @@ func NewRateLimiter() *RateLimiter {
|
|||||||
// from a background runner (e.g. once a minute) to bound memory in long-running
|
// from a background runner (e.g. once a minute) to bound memory in long-running
|
||||||
// bots that serve many distinct chats.
|
// bots that serve many distinct chats.
|
||||||
func (rl *RateLimiter) Cleanup(idleThreshold time.Duration) {
|
func (rl *RateLimiter) Cleanup(idleThreshold time.Duration) {
|
||||||
|
if idleThreshold <= 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
now := time.Now()
|
now := time.Now()
|
||||||
rl.chatMu.Lock()
|
rl.chatMu.Lock()
|
||||||
defer rl.chatMu.Unlock()
|
defer rl.chatMu.Unlock()
|
||||||
|
|
||||||
for chatID, lastSeen := range rl.chatLastSeen {
|
for chatID, lastSeen := range rl.chatLastSeen {
|
||||||
if now.Sub(lastSeen) <= idleThreshold {
|
if now.Sub(lastSeen) <= idleThreshold || rl.chatActive[chatID] > 0 {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
delete(rl.chatLimiters, chatID)
|
delete(rl.chatLimiters, chatID)
|
||||||
delete(rl.chatLastSeen, chatID)
|
delete(rl.chatLastSeen, chatID)
|
||||||
|
delete(rl.chatActive, chatID)
|
||||||
}
|
}
|
||||||
for chatID, until := range rl.chatLocks {
|
for chatID, until := range rl.chatLocks {
|
||||||
if !until.After(now) {
|
if !until.After(now) {
|
||||||
@@ -87,7 +93,10 @@ func (rl *RateLimiter) SetGlobalLock(retryAfter int) {
|
|||||||
}
|
}
|
||||||
rl.globalMu.Lock()
|
rl.globalMu.Lock()
|
||||||
defer rl.globalMu.Unlock()
|
defer rl.globalMu.Unlock()
|
||||||
rl.globalLockUntil = time.Now().Add(time.Duration(retryAfter) * time.Second)
|
until := time.Now().Add(time.Duration(retryAfter) * time.Second)
|
||||||
|
if until.After(rl.globalLockUntil) {
|
||||||
|
rl.globalLockUntil = until
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetChatLock sets a cooldown for a specific chat (e.g., after 429 for that chat).
|
// SetChatLock sets a cooldown for a specific chat (e.g., after 429 for that chat).
|
||||||
@@ -98,7 +107,10 @@ func (rl *RateLimiter) SetChatLock(chatID int64, retryAfter int) {
|
|||||||
}
|
}
|
||||||
rl.chatMu.Lock()
|
rl.chatMu.Lock()
|
||||||
defer rl.chatMu.Unlock()
|
defer rl.chatMu.Unlock()
|
||||||
rl.chatLocks[chatID] = time.Now().Add(time.Duration(retryAfter) * time.Second)
|
until := time.Now().Add(time.Duration(retryAfter) * time.Second)
|
||||||
|
if until.After(rl.chatLocks[chatID]) {
|
||||||
|
rl.chatLocks[chatID] = until
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GlobalWait blocks until a global request can be made.
|
// GlobalWait blocks until a global request can be made.
|
||||||
@@ -115,12 +127,18 @@ func (rl *RateLimiter) GlobalWait(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Wait blocks until a request for the given chat can be made.
|
// Wait blocks until a request for the given chat can be made.
|
||||||
// Waits for: chat cooldown → global cooldown → chat token bucket.
|
// Waits for: chat cooldown → chat token bucket → global cooldown → global token bucket.
|
||||||
// Note: Global limit is checked *before* chat limit to avoid overloading upstream.
|
// Waiting for chat capacity first prevents one busy chat from reserving global
|
||||||
|
// capacity while it is still unable to send a request.
|
||||||
func (rl *RateLimiter) Wait(ctx context.Context, chatID int64) error {
|
func (rl *RateLimiter) Wait(ctx context.Context, chatID int64) error {
|
||||||
if err := rl.waitForChatUnlock(ctx, chatID); err != nil {
|
if err := rl.waitForChatUnlock(ctx, chatID); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
chatLimiter, release := rl.acquireChatLimiter(chatID)
|
||||||
|
defer release()
|
||||||
|
if err := chatLimiter.Wait(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if err := rl.waitForGlobalUnlock(ctx); err != nil {
|
if err := rl.waitForGlobalUnlock(ctx); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -130,8 +148,7 @@ func (rl *RateLimiter) Wait(ctx context.Context, chatID int64) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
chatLimiter := rl.getChatLimiter(chatID)
|
return nil
|
||||||
return chatLimiter.Wait(ctx)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (rl *RateLimiter) getGlobalLimiter() *rate.Limiter {
|
func (rl *RateLimiter) getGlobalLimiter() *rate.Limiter {
|
||||||
@@ -187,7 +204,8 @@ func (rl *RateLimiter) Allow(chatID int64) bool {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
chatLimiter := rl.getChatLimiter(chatID)
|
chatLimiter, release := rl.acquireChatLimiter(chatID)
|
||||||
|
defer release()
|
||||||
chatReservation := chatLimiter.ReserveN(now, 1)
|
chatReservation := chatLimiter.ReserveN(now, 1)
|
||||||
if !chatReservation.OK() || chatReservation.DelayFrom(now) > 0 {
|
if !chatReservation.OK() || chatReservation.DelayFrom(now) > 0 {
|
||||||
chatReservation.CancelAt(now)
|
chatReservation.CancelAt(now)
|
||||||
@@ -233,61 +251,87 @@ func (rl *RateLimiter) Check(ctx context.Context, dropOverflow bool, chatID int6
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (rl *RateLimiter) waitForGlobalUnlock(ctx context.Context) error {
|
func (rl *RateLimiter) waitForGlobalUnlock(ctx context.Context) error {
|
||||||
|
for {
|
||||||
rl.globalMu.RLock()
|
rl.globalMu.RLock()
|
||||||
until := rl.globalLockUntil
|
until := rl.globalLockUntil
|
||||||
rl.globalMu.RUnlock()
|
rl.globalMu.RUnlock()
|
||||||
|
|
||||||
if until.IsZero() || time.Now().After(until) {
|
if until.IsZero() || !time.Now().Before(until) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
timer := time.NewTimer(time.Until(until))
|
||||||
select {
|
select {
|
||||||
case <-time.After(time.Until(until)):
|
case <-timer.C:
|
||||||
return nil
|
// A concurrent 429 may have extended the cooldown. Re-read it.
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
|
if !timer.Stop() {
|
||||||
|
select {
|
||||||
|
case <-timer.C:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
return ctx.Err()
|
return ctx.Err()
|
||||||
}
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (rl *RateLimiter) waitForChatUnlock(ctx context.Context, chatID int64) error {
|
func (rl *RateLimiter) waitForChatUnlock(ctx context.Context, chatID int64) error {
|
||||||
|
for {
|
||||||
rl.chatMu.RLock()
|
rl.chatMu.RLock()
|
||||||
until, ok := rl.chatLocks[chatID]
|
until, ok := rl.chatLocks[chatID]
|
||||||
rl.chatMu.RUnlock()
|
rl.chatMu.RUnlock()
|
||||||
|
|
||||||
if !ok || until.IsZero() || time.Now().After(until) {
|
if !ok || until.IsZero() || !time.Now().Before(until) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
timer := time.NewTimer(time.Until(until))
|
||||||
select {
|
select {
|
||||||
case <-time.After(time.Until(until)):
|
case <-timer.C:
|
||||||
return nil
|
// A concurrent 429 may have extended the cooldown. Re-read it.
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
|
if !timer.Stop() {
|
||||||
|
select {
|
||||||
|
case <-timer.C:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
return ctx.Err()
|
return ctx.Err()
|
||||||
}
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Updates chatLastSeen so Cleanup can evict idle entries.
|
// Updates chatLastSeen so Cleanup can evict idle entries.
|
||||||
func (rl *RateLimiter) getChatLimiter(chatID int64) *rate.Limiter {
|
func (rl *RateLimiter) getChatLimiter(chatID int64) *rate.Limiter {
|
||||||
now := time.Now()
|
now := time.Now()
|
||||||
|
|
||||||
rl.chatMu.RLock()
|
|
||||||
lim, ok := rl.chatLimiters[chatID]
|
|
||||||
rl.chatMu.RUnlock()
|
|
||||||
if ok {
|
|
||||||
rl.chatMu.Lock()
|
|
||||||
rl.chatLastSeen[chatID] = now
|
|
||||||
rl.chatMu.Unlock()
|
|
||||||
return lim
|
|
||||||
}
|
|
||||||
|
|
||||||
rl.chatMu.Lock()
|
rl.chatMu.Lock()
|
||||||
defer rl.chatMu.Unlock()
|
defer rl.chatMu.Unlock()
|
||||||
if lim, ok := rl.chatLimiters[chatID]; ok {
|
if lim, ok := rl.chatLimiters[chatID]; ok {
|
||||||
rl.chatLastSeen[chatID] = now
|
rl.chatLastSeen[chatID] = now
|
||||||
return lim
|
return lim
|
||||||
}
|
}
|
||||||
lim = rate.NewLimiter(1, 1)
|
lim := rate.NewLimiter(1, 1)
|
||||||
rl.chatLimiters[chatID] = lim
|
rl.chatLimiters[chatID] = lim
|
||||||
rl.chatLastSeen[chatID] = now
|
rl.chatLastSeen[chatID] = now
|
||||||
return lim
|
return lim
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (rl *RateLimiter) acquireChatLimiter(chatID int64) (*rate.Limiter, func()) {
|
||||||
|
rl.chatMu.Lock()
|
||||||
|
limiter, ok := rl.chatLimiters[chatID]
|
||||||
|
if !ok {
|
||||||
|
limiter = rate.NewLimiter(1, 1)
|
||||||
|
rl.chatLimiters[chatID] = limiter
|
||||||
|
}
|
||||||
|
rl.chatLastSeen[chatID] = time.Now()
|
||||||
|
rl.chatActive[chatID]++
|
||||||
|
rl.chatMu.Unlock()
|
||||||
|
|
||||||
|
return limiter, func() {
|
||||||
|
rl.chatMu.Lock()
|
||||||
|
rl.chatActive[chatID]--
|
||||||
|
rl.chatLastSeen[chatID] = time.Now()
|
||||||
|
rl.chatMu.Unlock()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -61,6 +61,86 @@ func TestRateLimiterGlobalWaitRespectsContextCancellation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRateLimiterWaitDoesNotConsumeGlobalCapacityWhileChatIsBlocked(t *testing.T) {
|
||||||
|
rl := NewRateLimiter()
|
||||||
|
rl.SetGlobalRate(1)
|
||||||
|
|
||||||
|
if !rl.Allow(42) {
|
||||||
|
t.Fatal("expected initial request for chat 42 to succeed")
|
||||||
|
}
|
||||||
|
rl.globalMu.Lock()
|
||||||
|
rl.globalLimiter = rate.NewLimiter(1, 1)
|
||||||
|
rl.globalMu.Unlock()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
|
||||||
|
defer cancel()
|
||||||
|
if err := rl.Wait(ctx, 42); err == nil {
|
||||||
|
t.Fatal("expected blocked chat wait to fail")
|
||||||
|
}
|
||||||
|
if !rl.GlobalAllow() {
|
||||||
|
t.Fatal("blocked chat wait consumed global capacity")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRateLimiterWaitObservesExtendedCooldowns(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
wait func(*RateLimiter, context.Context) error
|
||||||
|
set func(*RateLimiter, time.Time)
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "global",
|
||||||
|
wait: func(rl *RateLimiter, ctx context.Context) error {
|
||||||
|
return rl.waitForGlobalUnlock(ctx)
|
||||||
|
},
|
||||||
|
set: func(rl *RateLimiter, until time.Time) {
|
||||||
|
rl.globalMu.Lock()
|
||||||
|
rl.globalLockUntil = until
|
||||||
|
rl.globalMu.Unlock()
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "chat",
|
||||||
|
wait: func(rl *RateLimiter, ctx context.Context) error {
|
||||||
|
return rl.waitForChatUnlock(ctx, 42)
|
||||||
|
},
|
||||||
|
set: func(rl *RateLimiter, until time.Time) {
|
||||||
|
rl.chatMu.Lock()
|
||||||
|
rl.chatLocks[42] = until
|
||||||
|
rl.chatMu.Unlock()
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
rl := NewRateLimiter()
|
||||||
|
tt.set(rl, time.Now().Add(20*time.Millisecond))
|
||||||
|
started := time.Now()
|
||||||
|
done := make(chan error, 1)
|
||||||
|
go func() { done <- tt.wait(rl, context.Background()) }()
|
||||||
|
|
||||||
|
time.Sleep(5 * time.Millisecond)
|
||||||
|
tt.set(rl, time.Now().Add(70*time.Millisecond))
|
||||||
|
if err := <-done; err != nil {
|
||||||
|
t.Fatalf("wait returned error: %v", err)
|
||||||
|
}
|
||||||
|
if elapsed := time.Since(started); elapsed < 60*time.Millisecond {
|
||||||
|
t.Fatalf("wait ignored extended cooldown: %v", elapsed)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRateLimiterCleanupIgnoresNonPositiveThreshold(t *testing.T) {
|
||||||
|
rl := NewRateLimiter()
|
||||||
|
want := rl.getChatLimiter(42)
|
||||||
|
rl.Cleanup(0)
|
||||||
|
if got := rl.getChatLimiter(42); got != want {
|
||||||
|
t.Fatal("Cleanup(0) replaced an active limiter")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestRateLimiterCleanupEvictsIdleChats guards the memory-leak fix: per-chat
|
// TestRateLimiterCleanupEvictsIdleChats guards the memory-leak fix: per-chat
|
||||||
// limiter and lastSeen state must be reclaimed by Cleanup once the entry has
|
// limiter and lastSeen state must be reclaimed by Cleanup once the entry has
|
||||||
// been idle for longer than the threshold, while still-active chats and
|
// been idle for longer than the threshold, while still-active chats and
|
||||||
@@ -109,3 +189,18 @@ func TestRateLimiterCleanupEvictsIdleChats(t *testing.T) {
|
|||||||
t.Fatal("expected future chat 11 lock to remain")
|
t.Fatal("expected future chat 11 lock to remain")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRateLimiterCleanupPreservesAcquiredLimiter(t *testing.T) {
|
||||||
|
rl := NewRateLimiter()
|
||||||
|
limiter, release := rl.acquireChatLimiter(42)
|
||||||
|
|
||||||
|
rl.chatMu.Lock()
|
||||||
|
rl.chatLastSeen[42] = time.Now().Add(-time.Hour)
|
||||||
|
rl.chatMu.Unlock()
|
||||||
|
rl.Cleanup(time.Minute)
|
||||||
|
|
||||||
|
if got := rl.getChatLimiter(42); got != limiter {
|
||||||
|
t.Fatal("Cleanup replaced a limiter while it was acquired")
|
||||||
|
}
|
||||||
|
release()
|
||||||
|
}
|
||||||
|
|||||||
+2
-2
@@ -2,11 +2,11 @@ package utils
|
|||||||
|
|
||||||
const (
|
const (
|
||||||
// VersionString is the module version string.
|
// VersionString is the module version string.
|
||||||
VersionString = "1.1.0"
|
VersionString = "1.2.0"
|
||||||
// VersionMajor is the module major version.
|
// VersionMajor is the module major version.
|
||||||
VersionMajor = 1
|
VersionMajor = 1
|
||||||
// VersionMinor is the module minor version.
|
// VersionMinor is the module minor version.
|
||||||
VersionMinor = 1
|
VersionMinor = 2
|
||||||
// VersionPatch is the module patch version.
|
// VersionPatch is the module patch version.
|
||||||
VersionPatch = 0
|
VersionPatch = 0
|
||||||
// VersionBeta is the prerelease counter for the current version.
|
// VersionBeta is the prerelease counter for the current version.
|
||||||
|
|||||||
Reference in New Issue
Block a user