REPOSITORY / ScuroNeko/Laniakea
Compare commits
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 ScuroNeko
|
d78526242b
|
||
|
ScuroNeko
|
24040fe164
|
||
|
ScuroNeko
|
29b208eeec
|
||
|
ScuroNeko
|
f03a081ed6
|
||
 ScuroNekoandClaude Fable 5
|
48ddf66540
|
||
|
ScuroNeko
|
b563e695df
|
||
|
ScuroNekoandClaude Sonnet 4.6
|
38309e74f6
|
||
|
ScuroNeko
|
c2f6406819
|
||
|
ScuroNekoandClaude Sonnet 4.6
|
9e3450df31
|
@@ -9,6 +9,15 @@ jobs:
|
||||
- name: Checkout repository code
|
||||
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
|
||||
run: |
|
||||
files="$(gofmt -l .)"
|
||||
@@ -25,4 +34,6 @@ jobs:
|
||||
run: go vet ./...
|
||||
|
||||
- name: Run golangci-lint
|
||||
run: golangci-lint run
|
||||
uses: golangci/golangci-lint-action@v9.0.0
|
||||
with:
|
||||
version: v2.12.2
|
||||
|
||||
@@ -6,3 +6,4 @@ test/
|
||||
.codex
|
||||
.agents/
|
||||
.claude/
|
||||
review.md
|
||||
+1
-1
@@ -2,7 +2,7 @@ version: "2"
|
||||
run:
|
||||
timeout: 5m
|
||||
linters:
|
||||
disable-all: true
|
||||
default: none
|
||||
enable:
|
||||
- errcheck
|
||||
- ineffassign
|
||||
|
||||
@@ -60,6 +60,11 @@ Each exported godoc comment must:
|
||||
- avoid repeating the signature mechanically;
|
||||
- stay high-signal and informative.
|
||||
|
||||
### Telegram API documentation and versions
|
||||
- When writing or updating godoc for Telegram Bot API types, fields, methods, or helpers, verify the description against the official [Telegram Bot API documentation](https://core.telegram.org/bots/api). Preserve relevant API semantics such as HTML equivalents, accepted ranges, formats, and optionality.
|
||||
- Add a `Since: Bot API X.Y` paragraph to each exported type, function, and method introduced in a specific Bot API version, using the established `tgapi` format.
|
||||
- Add an inline `// Since: Bot API X.Y` comment to an exported struct field only when its Bot API version differs from that of the containing struct. For example, if `InputRichMessage` was introduced in Bot API 10.1 and its `Media` field in Bot API 10.2, annotate only the `Media` field; do not repeat the struct's version on its original fields.
|
||||
|
||||
### Unexported declarations
|
||||
Unexported types, funcs, methods, vars, and consts should generally not have godoc-style comments unless there is a strong reason.
|
||||
|
||||
@@ -115,8 +120,8 @@ Prefer the repository’s documented commands. If multiple choices exist, use th
|
||||
|
||||
## Breaking changes policy
|
||||
- The agent must detect potential breaking changes before editing public APIs.
|
||||
- Breaking changes are forbidden unless the selected target version is a new major version.
|
||||
- If the requested change is breaking and the user did not bump the major version, the agent must stop and warn that the change is not allowed under the current version.
|
||||
- Breaking changes are forbidden unless the selected target version is a new major version, or it's necessary(i.e. fixing not working feature).
|
||||
- If the requested change is breaking, not necessary to fix a non-working feature, and the user did not bump the major version, the agent must stop and warn that the change is not allowed under the current version.
|
||||
- In that case, the agent must offer only these options:
|
||||
1. do not make the breaking change;
|
||||
2. introduce a backward-compatible alternative such as a new method, function, type, or struct, but only if that keeps the codebase reasonably small and clear;
|
||||
|
||||
+175
@@ -1,5 +1,180 @@
|
||||
# Changelog
|
||||
|
||||
## v2.0.0-rc.1 (Unreleased)
|
||||
|
||||
### Added
|
||||
- Added Bot API 10.3 rich buttons: `RichMessageButton`, `RichTextButton`, `RichBlockButtons`, and `InputRichBlockButtons`, including inline-query chat selection, login, clipboard, and disabled actions. Empty inline queries are preserved through pointer fields; `RichMessageButtonStyleLink` supports borderless callback buttons.
|
||||
- Added incoming and outgoing expandable block quotations and document blocks, with `tgrich.Button`, `Buttons`, `ButtonsWithAlign`, `ExpandableBlockquote`, `ExpandableBlockquoteWithCredit`, `Document`, and `DocumentWithCaption` helpers.
|
||||
- Added compact rich tables through `IsCompact` and `RichTable.SetCompact`, including JSON decoding and HTML rendering.
|
||||
- Added rich-button validation for a single action, permitted label entities and styles, callback byte limits, copy-text length, row size, and alignment. Invalid values return `ErrRichInvalidButton` from `tgrich` builders.
|
||||
- Added HTML rendering for rich buttons, expandable quotations, and documents. Document media is collected into `InputRichMessage.Media` with `tg://document?id=` references and supports multipart attachments through the existing rich-message uploader.
|
||||
- Added `EphemeralMessageParameters`, including `ReplaceCallbackQueryMessage`, to JSON and multipart send parameters for text, rich messages, animation, audio, documents, live photos, photos, stickers, video, video notes, voice, contacts, locations, and venues. Ephemeral media editing now supports multipart attachments through `Uploader.EditEphemeralMessageMedia`.
|
||||
- Added `RichMessage` to `EditEphemeralMessageText` and `ShowCaptionAboveMedia` to `EditEphemeralMessageCaption`.
|
||||
- Added `CanStop` and `KeepOnStop` to message and rich-message draft parameters. Stopped-generation updates are decoded as `UpdateTypeMessageGenerationStopped` and expose their chat through normalized message context.
|
||||
- Added disabled inline buttons and `SetDisabled`, plus `ForceReply` support on specialized inline and reply keyboard markup.
|
||||
- Added `CommunityChatJoined` service messages; `UniqueGiftInfo.Text`, `Entities`, and `IsPrivate`; and `CanSendWelcomeMessages` to administrator members, rights, and promotion parameters.
|
||||
- Added `RichTextUnknown` and `RichBlockUnknown` to preserve unrecognized Telegram rich objects without losing fields.
|
||||
- Added explicit `InlineKeyboard.SetUnlimitedRows` configuration.
|
||||
|
||||
### Breaking changes
|
||||
- Changed the Go module and import path to `git.scuroneko.dev/scuroneko/laniakea/v2`, raised the minimum Go version to 1.27, and removed the v1-only retraction directive.
|
||||
- `PollAnswer.User` and `VoterChat` are now pointers; removed `VoterUser` and `VoterChatInfo`. Update-context normalization and tests use the pointer fields.
|
||||
- `RunnerFn` and `NewRunner` now require callbacks with `context.Context`; removed `ContextRunnerFn` and `NewContextRunner`.
|
||||
- `InlineKeyboard.Get` now validates and returns `(*tgapi.ReplyMarkup, error)`; removed `GetValidated` and keyboard-level `Validate`. Message-context helpers reject invalid keyboards before sending or editing. Previously built rows exceeding a subsequently lowered row limit now fail final validation.
|
||||
- `CallbackData.Encode` now returns `(string, error)` and validates encoding and payload length; removed `EncodeValidated`.
|
||||
- Moved custom request execution from `TelegramRequest.Do` / `DoWithContext` to `API.Do` / `DoWithContext`, and from `UploaderRequest` methods to the corresponding `Uploader` methods.
|
||||
- Renamed `ChatFullInfo.AvailableReaction` to `AvailableReactions`, `ReplyParameters.QuoteParsingMode` to `QuoteParseMode`, and `InputChecklist.OtherCanAddTasks` / `OtherCanMarkTasksAsDone` to `OthersCanAddTasks` / `OthersCanMarkTasksAsDone`; JSON keys remain unchanged.
|
||||
- Removed `DeleteAllMessageReactionWithContext`; use `DeleteAllMessageReactionsWithContext`.
|
||||
- The JSON and multipart send parameter structs listed above replace top-level `ReceiverUserID` and `CallbackQueryID` with `EphemeralMessageParameters`.
|
||||
- `UnmarshalRichMessage` now requires a non-null `blocks` array. Unknown rich objects use lossless raw wrappers instead of lossy text wrappers or errors.
|
||||
- Removed the unbounded `API.GetFileByLink` and `GetFileByLinkWithContext`; use `GetFileByLinkLimit*` with an explicit byte limit or `OpenFileByLink*` for streaming.
|
||||
- Non-positive inline-keyboard row limits are invalid by default; call `SetUnlimitedRows` to disable automatic wrapping explicitly.
|
||||
|
||||
### Changed
|
||||
- Prepared the declared version and user-agent metadata for `v2.0.0-rc.1`.
|
||||
- Updated English and Russian README runner and keyboard examples for the final v2 contracts, and generalized the prerelease policy for the v2 RC cycle.
|
||||
|
||||
### Fixed
|
||||
- Fixed nested rich-text validation skipping children of formatting and link entities, which could bypass text-size and nesting limits.
|
||||
|
||||
### Tests
|
||||
- Migrated runner, poll-voter, keyboard, message-context, and wire-format tests to the new contracts.
|
||||
- Added rich-button action round trips, malformed-input and nesting cases, row and callback boundaries, HTML escaping, compact tables, expandable quotations, document media, multipart attachments, draft-upload coverage, Bot API 10.3 wire fields, stopped-generation routing, strict root parsing, lossless unknown objects, bounded downloads, explicit unlimited rows, and compile-focused v1-to-v2 migration coverage.
|
||||
|
||||
## 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
|
||||
|
||||
### Breaking Changes
|
||||
- Fixed `Uploader.SendLivePhoto` and `Uploader.SendLivePhotoWithContext` to require both the live-photo video and its static image. The previous one-file signatures could not produce a valid `sendLivePhoto` request.
|
||||
|
||||
### Bot API 10.1
|
||||
- Added rich message receiving support: `tgapi.RichMessage` on `Message.RichMessage` (`rich_message`), the full set of `RichText*`/`RichBlock*` wire types with official API names, and `UnmarshalRichText`/`UnmarshalRichBlock`/`UnmarshalRichMessage` parsers. Unknown text-bearing types retain their nested text through fallback wrappers while unmodeled fields are discarded.
|
||||
- Added rich message sending support: `tgapi.InputRichMessage`, `tgapi.SendRichMessage` params, and `API.SendRichMessage`/`API.SendRichMessageWithContext`.
|
||||
- Added rich message draft streaming: `API.SendRichMessageDraft`/`API.SendRichMessageDraftWithContext` for ephemeral ~30-second previews of partially generated messages.
|
||||
- Added rich message editing: `EditMessageText.RichMessage` (`InputRichMessage`); `Text` is now omitted from the request when empty so rich-only edits are valid.
|
||||
- Added `tgapi.InputRichMessageContent` for rich content in inline query results.
|
||||
- Added join request query support: `User.SupportsJoinRequestQueries`, `ChatFullInfo.GuardBot`, `ChatJoinRequest.QueryID`, `API.AnswerChatJoinRequestQuery` with `ChatJoinRequestQueryResult` constants (`JoinRequestApprove`/`JoinRequestDecline`/`JoinRequestQueue`), and `API.SendChatJoinRequestWebApp` (plus `WithContext` variants).
|
||||
- Added poll link media: the `tgapi.Link` type, `PollMedia.Link`, and the "link" type with `URL` on `InputPollOptionMedia`.
|
||||
|
||||
### Bot API 10.2
|
||||
- Added block-based rich-message sending with `InputRichMessage.Blocks`, including animation, audio, photo, video, and voice-note input blocks. The `tgrich` package provides matching media constructors with optional block captions.
|
||||
- Added `InputRichMessage.Media` for media embedded in rich-message HTML or Markdown, with multipart `attach://` upload support.
|
||||
- Added multipart rich-message uploads through `Uploader.SendRichMessage`. Use `UploaderFile.SetAttachName` to match an `attach://` media reference; rich-message draft helpers reject direct uploads as required by Telegram.
|
||||
- Added ephemeral-message support: outgoing receiver and callback parameters, reply targets, message fields, edit and delete methods, and ephemeral bot commands. Added community service-message types and subscription update handling.
|
||||
|
||||
### Added
|
||||
- Added documented `tgrich` constructors and block types for building input rich messages.
|
||||
- Added `tgrich.BuildHTML` and `tgrich.ToHTML` to validate input block trees, convert them to HTML rich messages, and collect URL, `file_id`, or multipart media references.
|
||||
- Added `MessageContext.RichAnswer(...)` and `MessageContext.RichAnswerKeyboard(...)` for validating and sending `tgrich` input blocks.
|
||||
- Added `UpdateTypeSubscription` routing and normalized message, user, and chat context for guest messages, deleted business messages, anonymous poll answers, reaction counts, managed bots, chat boosts, and subscription updates.
|
||||
- Added webhook secret-format validation and the exported `ErrBotWebhookOptsSecretTokenInvalid` sentinel.
|
||||
|
||||
### Changed
|
||||
- `AutoGenerateCommandsForScope(nil)` now atomically replaces commands in Telegram's default scope without deleting the previous list first.
|
||||
- API debug logging now records redacted request JSON and response metadata instead of complete response bodies.
|
||||
- Scene updates sharing a user or chat session key are serialized, and duplicate scene names from later plugins are skipped with a warning.
|
||||
- Inline keyboard button builders now keep URL and callback actions mutually exclusive, and `InlineKeyboard.Get` returns independent markup data.
|
||||
- `NewBot` no longer aliases `BotOpts.Prefixes` or mutates `BotOpts.LoggerBasePath`.
|
||||
- README requirements now match the module's Go 1.26 directive.
|
||||
- Migrated the golangci-lint configuration to its v2 schema so the repository lint workflow runs again.
|
||||
- Added missing Godoc for exported error methods, enum constants, and all public Bot API 10.1/10.2 fields introduced in this release.
|
||||
|
||||
### Fixed
|
||||
- Fixed JSON BotOpts environment placeholders corrupting or injecting JSON when values contain quotes, backslashes, or control characters.
|
||||
- Preserved checkbox state when converting list items to ordered lists and made generated HTML attribute ordering deterministic.
|
||||
- Added validation for rich-block type discriminators, heading sizes, list fields, table cells, map parameters, and media values.
|
||||
- Fixed generated webhook secrets using padded Base64 characters that Telegram rejects, stopped logging generated secrets, and added HTTP read and idle timeouts to the webhook server.
|
||||
- Fixed negative group and channel IDs receiving global rather than per-chat `retry_after` cooldowns.
|
||||
- Fixed rejected per-chat requests consuming global rate-limit capacity and draft construction consuming an extra rate-limit token before the API request.
|
||||
- Fixed subscription updates being decoded as `UpdateTypeUnknown`.
|
||||
- Fixed rich-text and rich-block decoding silently accepting malformed typed fields or a top-level `null` rich-text value.
|
||||
- Fixed `tgrich.BuildHTML` disabling Telegram entity detection and accepting the draft-only thinking block; `BuildDraftHTML` now provides the explicit draft path.
|
||||
- Fixed `tgrich.BuildHTML` silently losing explicit bank-card, mention, hashtag, cashtag, and bot-command values when their visible text differs.
|
||||
- Fixed API debug logs exposing webhook, payment, callback, passport, and managed-bot secrets.
|
||||
- Fixed panics and nil callbacks in asynchronous middleware terminating the process; failures now reach the logger and observer error stream.
|
||||
- Fixed multipart helpers attempting direct file uploads for rich-message drafts, which Telegram does not support; they now return `ErrRichMessageDraftUploadUnsupported`.
|
||||
- Fixed draft ID zero values and collisions overwriting tracked drafts, nil draft APIs panicking, and draft entity slices aliasing caller memory.
|
||||
- Fixed scene session payloads and returned inline keyboard markup aliasing mutable internal slices.
|
||||
- Recovered panics from runner callbacks so they are reported through normal runner and error observer events instead of terminating the process.
|
||||
|
||||
### Tests
|
||||
- Added JSON regression coverage for rich-message embedded media and ephemeral send, edit, and delete parameters.
|
||||
- Added regression coverage for escaped environment placeholders and both required `sendLivePhoto` multipart fields.
|
||||
- Added regression coverage for API log redaction, same-session scene serialization, duplicate scene registration, async middleware failures, and rich entity preservation.
|
||||
- Added rich HTML renderer coverage for all input block and media types, multipart references, field validation, and Telegram's text, block, nesting, media, and table-width limits.
|
||||
- Added regression coverage for webhook token syntax, update context normalization, subscription routing, rate-limit capacity, draft ID collisions, runner panics, scene and keyboard aliasing, command replacement, and malformed rich JSON.
|
||||
|
||||
## v1.0.2
|
||||
|
||||
### Fixed
|
||||
- Fixed long-polling stopping permanently when the HTTP client's internal timeout fired. The polling loop was checking `errors.Is(err, context.DeadlineExceeded)`, which matched HTTP client timeout errors (`*url.Error` wraps `context.DeadlineExceeded`), causing the goroutine to exit as if the bot context was canceled. The check is now `ctx.Err() != nil` so only a real context cancellation stops polling.
|
||||
- Fixed the HTTP client timeout (45 s) being too close to the long-poll `getUpdates` timeout (30 s default), leaving insufficient margin for connection setup and response transfer. The client timeout is now derived from the configured `PollTimeout` plus a 60-second buffer.
|
||||
|
||||
## v1.0.1
|
||||
|
||||
### Fixed
|
||||
- Fixed webhook always accepting unauthenticated requests when `SecretToken` is not configured. A cryptographically random 32-byte token is now generated automatically when `SecretToken` is empty, so the webhook endpoint is always authenticated. The generated token is logged as a warning so the operator can record it.
|
||||
- Fixed `tgapi.NewAPI` and `tgapi.NewUploader` not installing token redaction on their managed loggers. The bot token is now masked as `<TOKEN>` in debug output even when the `tgapi` package is used standalone without the `laniakea.Bot` wrapper.
|
||||
|
||||
## v1.0.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
|
||||
|
||||
[](https://go.dev/)
|
||||
[](https://go.dev/)
|
||||
[](LICENSE)
|
||||
|
||||
|
||||
@@ -30,13 +30,7 @@ A lightweight, easy-to-use, and performant Telegram Bot API wrapper for Go. It s
|
||||
## 📦 Installation
|
||||
|
||||
```bash
|
||||
go get git.scuroneko.dev/scuroneko/laniakea
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
go get github.com/scuroneko/laniakea
|
||||
go get git.scuroneko.dev/scuroneko/laniakea/v2@v2.0.0-rc.1
|
||||
```
|
||||
|
||||
## 🚀 Quick Start (with step-by-step explanation)
|
||||
@@ -48,7 +42,7 @@ package main
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea" // Import the Laniakea library
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2" // Import the Laniakea library
|
||||
)
|
||||
|
||||
// echo is a command handler function.
|
||||
@@ -120,6 +114,8 @@ func main() {
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
`BotOpts` can also be loaded from or saved to config files through the file codec API.
|
||||
@@ -217,6 +213,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.
|
||||
|
||||
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
|
||||
|
||||
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,33 +275,39 @@ 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.
|
||||
|
||||
```go
|
||||
import "time"
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// One-shot runner — fires once in a goroutine when the bot starts (default).
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("seed-cache", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache()
|
||||
}),
|
||||
laniakea.NewRunner("seed-cache", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache(ctx)
|
||||
}),
|
||||
)
|
||||
|
||||
// Periodic runner — fires every 10 minutes in a goroutine.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("refresh-stats", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats()
|
||||
}).Every(10 * time.Minute),
|
||||
laniakea.NewRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats(ctx)
|
||||
}).Every(10 * time.Minute),
|
||||
)
|
||||
|
||||
// Synchronous one-shot — blocks runtime startup until it completes.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("migrate", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate()
|
||||
}).Async(false),
|
||||
laniakea.NewRunner("migrate", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate(ctx)
|
||||
}).Async(false),
|
||||
)
|
||||
```
|
||||
|
||||
Builder methods:
|
||||
- `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)`.
|
||||
- `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 runner receives a context that is canceled when polling or webhook
|
||||
execution stops. I/O and blocking work should pass it to downstream calls.
|
||||
|
||||
## 🧩 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.
|
||||
@@ -350,7 +358,9 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
|
||||
## ⚙️ 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.
|
||||
- **Keyboard Validation**: `InlineKeyboard.Get()` validates every button and row before returning markup; Telegram limits `callback_data` to 1–64 bytes. Use `SetUnlimitedRows()` when automatic wrapping must be disabled explicitly.
|
||||
- **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.
|
||||
- **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.
|
||||
@@ -366,7 +376,7 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
This project is licensed under the GNU General Public License v3.0 — see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 📚 Learn More
|
||||
[GoDoc](https://pkg.go.dev/git.scuroneko.dev/scuroneko/laniakea)
|
||||
[GoDoc](https://pkg.go.dev/git.scuroneko.dev/scuroneko/laniakea/v2)
|
||||
|
||||
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||
|
||||
|
||||
+33
-22
@@ -2,7 +2,7 @@
|
||||
|
||||
|
||||
|
||||
[](https://go.dev/)
|
||||
[](https://go.dev/)
|
||||
[](LICENSE)
|
||||
|
||||
|
||||
@@ -31,13 +31,7 @@
|
||||
## 📦 Установка
|
||||
|
||||
```bash
|
||||
go get git.scuroneko.dev/scuroneko/laniakea
|
||||
```
|
||||
|
||||
или
|
||||
|
||||
```bash
|
||||
go get github.com/scuroneko/laniakea
|
||||
go get git.scuroneko.dev/scuroneko/laniakea/v2@v2.0.0-rc.1
|
||||
```
|
||||
|
||||
## 🚀 Быстрый старт (с пошаговыми комментариями)
|
||||
@@ -49,7 +43,7 @@ package main
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea" // Импортируем библиотеку Laniakea
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2" // Импортируем библиотеку Laniakea
|
||||
)
|
||||
|
||||
// echo — это функция-обработчик команды.
|
||||
@@ -121,6 +115,8 @@ func main() {
|
||||
9. `RunWebhookWithContext(...)`: Запускает bot-owned webhook runtime, когда Telegram должен доставлять update по HTTP вместо long polling.
|
||||
10. Экземпляр `Bot` одноразовый. После завершения `Run()`, `RunWithContext()` или `RunWebhookWithContext()` для следующего запуска создавайте новый бот.
|
||||
|
||||
Для тестов или собственного transport используй `NewBotWithAPI[T](opts, api)` с заранее настроенным `*tgapi.API`. Бот становится владельцем этого клиента и закрывает его в `Bot.Close`; настройки transport, retry и rate limit из `BotOpts` не переопределяют переданный клиент.
|
||||
|
||||
## Конфиг из файла
|
||||
|
||||
`BotOpts` можно не только собирать вручную или из environment, но и загружать и сохранять через file codec API.
|
||||
@@ -261,33 +257,39 @@ plugin.Scene("signup").
|
||||
Раннеры — фоновые задачи, которые выполняются вместе с bot runtime. Они регистрируются до запуска бота и автоматически запускаются при старте.
|
||||
|
||||
```go
|
||||
import "time"
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Одноразовый раннер — запускается один раз в горутине при старте (по умолчанию).
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("seed-cache", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache()
|
||||
}),
|
||||
laniakea.NewRunner("seed-cache", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache(ctx)
|
||||
}),
|
||||
)
|
||||
|
||||
// Периодический раннер — запускается каждые 10 минут в горутине.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("refresh-stats", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats()
|
||||
}).Every(10 * time.Minute),
|
||||
laniakea.NewRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats(ctx)
|
||||
}).Every(10 * time.Minute),
|
||||
)
|
||||
|
||||
// Синхронный одноразовый — блокирует запуск runtime до завершения.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("migrate", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate()
|
||||
}).Async(false),
|
||||
laniakea.NewRunner("migrate", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate(ctx)
|
||||
}).Async(false),
|
||||
)
|
||||
```
|
||||
|
||||
Методы builder:
|
||||
- `Async(bool) *Runner[T]` — если `true` (по умолчанию), запускается в горутине; если `false`, блокирует запуск runtime.
|
||||
- `Every(time.Duration) *Runner[T]` — задаёт интервал повторного запуска. Ноль (по умолчанию) означает одноразовый запуск; положительное значение — периодический. Периодические раннеры требуют `Async(true)`.
|
||||
- `Async(bool) Runner[T]` — если `true` (по умолчанию), запускается в горутине; если `false`, блокирует запуск runtime.
|
||||
- `Every(time.Duration) Runner[T]` — задаёт интервал повторного запуска. Ноль (по умолчанию) означает одноразовый запуск; положительное значение — периодический. Периодические раннеры требуют `Async(true)`.
|
||||
|
||||
Каждый runner получает context, который отменяется при остановке polling или
|
||||
webhook runtime. I/O и блокирующие операции должны передавать его во вложенные вызовы.
|
||||
|
||||
### tgapi: API и Uploader
|
||||
|
||||
@@ -298,6 +300,13 @@ bot.AddRunner(
|
||||
|
||||
Для продвинутых сценариев `tgapi.NewRequest(...)` и `tgapi.NewUploaderRequest(...)` остаются публичными low-level escape hatch API. Они менее безопасны, чем типизированные helper-методы: вызывающая сторона сама отвечает за корректное имя Telegram-метода и совместимые типы параметров/ответа.
|
||||
|
||||
Автоматические повторы после ответа Telegram `429` по умолчанию ограничены
|
||||
тремя; предел настраивается через `NewAPIOpts(...).SetMaxRetries(...)`.
|
||||
Multipart upload кодируется потоком без второй полной копии request body в
|
||||
памяти. Для download неизвестного размера используйте
|
||||
`OpenFileByLinkWithContext` либо задайте явный предел через
|
||||
`GetFileByLinkLimitWithContext`.
|
||||
|
||||
## 🧩 Промежуточные слои (Middleware)
|
||||
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
||||
|
||||
@@ -347,7 +356,9 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
|
||||
## ⚙️ Расширенная настройка
|
||||
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
||||
- **Валидация клавиатур**: `InlineKeyboard.Get()` проверяет все кнопки и строки перед возвратом markup; Telegram ограничивает `callback_data` диапазоном 1–64 байта. Для явного отключения автоматического переноса используйте `SetUnlimitedRows()`.
|
||||
- **Ограничение запросов**: Передайте настроенный `utils.RateLimiter` через `BotOpts` для корректной обработки лимитов Telegram.
|
||||
- **Observer**: Во время runtime callbacks observer выполняются асинхронно и по порядку через ограниченную очередь. Медленный observer не блокирует handlers; при переполнении события отбрасываются с редкими предупреждениями, а shutdown обрабатывает уже поставленные в очередь события.
|
||||
- **Локализация**: `L10n` безопасен для конкурентного использования после подключения к боту.
|
||||
- **Пользовательские update handlers**: Используйте `plugin.AddUpdateHandler(...)` для Telegram update types вне command/payload flow.
|
||||
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebhookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
||||
@@ -362,7 +373,7 @@ func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
Этот проект лицензирован под GNU General Public License v3.0 - подробности см. в файле [LICENSE](LICENSE).
|
||||
|
||||
## 📚 Дополнительная информация
|
||||
[GoDoc Laniakea](https://pkg.go.dev/git.scuroneko.dev/scuroneko/laniakea)
|
||||
[GoDoc Laniakea](https://pkg.go.dev/git.scuroneko.dev/scuroneko/laniakea/v2)
|
||||
|
||||
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||
|
||||
|
||||
@@ -41,5 +41,5 @@ A release uses a patch version bump for backward-compatible fixes:
|
||||
|
||||
## Pre-Releases
|
||||
|
||||
`-rc.N` builds may still adjust API details before `v1.0.0`.
|
||||
Once `v1.0.0` is released, breaking changes require a new major version.
|
||||
`-rc.N` builds may still correct release-blocking API defects before the corresponding stable release.
|
||||
After a stable release, breaking changes require a new major version.
|
||||
|
||||
@@ -4,12 +4,13 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -96,13 +97,17 @@ type Bot[T AppData] struct {
|
||||
maxWorkers int
|
||||
pollTimeout int // Long-polling timeout in seconds for getUpdates
|
||||
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
logger *sneklog.Logger // Main bot logger (JSON stdout + optional file)
|
||||
requestLogger *sneklog.Logger // Optional request-level API logging
|
||||
useReqLogger bool
|
||||
webhookLogger *sneklog.Logger // Webhook logger. Available only after Bot.RunWebhookWithContext.
|
||||
extraLoggers extypes.Slice[*sneklog.Logger] // API, Uploader, and custom loggers
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
logger *sneklog.Logger // Main bot logger (JSON stdout + optional file)
|
||||
requestLogger *sneklog.Logger // Optional request-level API logging
|
||||
useReqLogger bool
|
||||
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
|
||||
|
||||
plugins []Plugin[T] // Command/event handlers
|
||||
middlewares []Middleware[T] // Pre-processing filters (sorted by order)
|
||||
@@ -114,6 +119,7 @@ type Bot[T AppData] struct {
|
||||
l10n *L10n // Localization manager
|
||||
draftProvider *DraftProvider // Draft message builder
|
||||
observer Observer // Optional event observer for instrumentation
|
||||
observerAsync *observerDispatcher
|
||||
|
||||
appData T // Injected application data
|
||||
hasAppData bool
|
||||
@@ -121,6 +127,7 @@ type Bot[T AppData] struct {
|
||||
|
||||
sessionStore SessionStore // Session store for scene management
|
||||
sceneScopePriority []SceneScope
|
||||
sceneLocks sceneKeyLocker
|
||||
|
||||
updateOffsetMu sync.Mutex
|
||||
updateOffset int // Last processed update ID
|
||||
@@ -128,6 +135,7 @@ type Bot[T AppData] struct {
|
||||
updateQueue chan *tgapi.Update // Internal queue for processing updates
|
||||
runnerOnceWG sync.WaitGroup // Tracks one-time async runners
|
||||
runnerBgWG sync.WaitGroup // Tracks background async runners
|
||||
middlewareWG sync.WaitGroup // Tracks asynchronous middleware callbacks
|
||||
runStateMu sync.Mutex
|
||||
running bool
|
||||
ran bool
|
||||
@@ -154,6 +162,20 @@ func (bot *Bot[T]) configMutable(method string) bool {
|
||||
// - Sets up DraftProvider with random IDs
|
||||
// - Adds API and Uploader loggers to extraLoggers
|
||||
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 {
|
||||
return nil, ErrOptsIsNil
|
||||
}
|
||||
@@ -166,21 +188,6 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
limiter := utils.NewRateLimiter()
|
||||
limiter.SetGlobalRate(opts.RateLimit)
|
||||
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||
SetAPIURL(opts.APIURL).
|
||||
UseTestServer(opts.UseTestServer).
|
||||
SetLimiter(limiter).
|
||||
SetDropRateLimitOverflow(opts.DropRateLimitOverflow).
|
||||
SetLogFormat(opts.LogFormat).
|
||||
SetLogFormatter(opts.LogFormatter)
|
||||
api := tgapi.NewAPI(apiOpts)
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
prefixes := opts.Prefixes
|
||||
if len(prefixes) == 0 {
|
||||
prefixes = []string{"/"}
|
||||
}
|
||||
|
||||
workers := 32
|
||||
if opts.MaxWorkers > 0 {
|
||||
workers = opts.MaxWorkers
|
||||
@@ -191,6 +198,27 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
pollTimeout = opts.PollTimeout
|
||||
}
|
||||
|
||||
// HTTP client timeout must exceed pollTimeout to avoid spurious deadline
|
||||
// errors that the polling loop would misinterpret as context cancellation.
|
||||
httpTimeout := time.Duration(pollTimeout)*time.Second + 60*time.Second
|
||||
if api == nil {
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||
SetAPIURL(opts.APIURL).
|
||||
UseTestServer(opts.UseTestServer).
|
||||
SetLimiter(limiter).
|
||||
SetDropRateLimitOverflow(opts.DropRateLimitOverflow).
|
||||
SetLogFormat(opts.LogFormat).
|
||||
SetLogFormatter(opts.LogFormatter).
|
||||
SetHTTPClient(&http.Client{Timeout: httpTimeout})
|
||||
api = tgapi.NewAPI(apiOpts)
|
||||
}
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
prefixes := append([]string(nil), opts.Prefixes...)
|
||||
if len(prefixes) == 0 {
|
||||
prefixes = []string{"/"}
|
||||
}
|
||||
|
||||
bot := &Bot[T]{
|
||||
updateOffset: 0,
|
||||
errorTemplate: "%s",
|
||||
@@ -225,10 +253,11 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
if len(opts.ErrorTemplate) > 0 {
|
||||
bot.errorTemplate = opts.ErrorTemplate
|
||||
}
|
||||
if len(opts.LoggerBasePath) == 0 {
|
||||
opts.LoggerBasePath = "./"
|
||||
loggerOpts := *opts
|
||||
if len(loggerOpts.LoggerBasePath) == 0 {
|
||||
loggerOpts.LoggerBasePath = "./"
|
||||
}
|
||||
bot.initLoggers(opts)
|
||||
bot.initLoggers(&loggerOpts)
|
||||
|
||||
if opts.FileConfigVersion > 0 && opts.FileConfigVersion < ConfigVersion {
|
||||
bot.logger.Warnln(
|
||||
@@ -257,21 +286,66 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
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] {
|
||||
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.loggerOwned = false
|
||||
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] {
|
||||
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.requestLoggerOwned = false
|
||||
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] {
|
||||
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.webhookLoggerOwned = false
|
||||
return bot
|
||||
}
|
||||
|
||||
@@ -284,10 +358,11 @@ func (bot *Bot[T]) GetUploader() *tgapi.Uploader { return bot.uploader }
|
||||
// Close gracefully shuts down bot-owned resources.
|
||||
//
|
||||
// Close shuts down, in order:
|
||||
// - The asynchronous observer dispatcher, after draining queued events
|
||||
// - Registered plugins via Plugin.Close
|
||||
// - Webhook logger (if initialized)
|
||||
// - Uploader (waits for pending uploads)
|
||||
// - API client internals
|
||||
// - Uploader logger resources
|
||||
// - API client internals, after pending API and upload requests complete
|
||||
// - RequestLogger (if enabled)
|
||||
// - Main logger
|
||||
//
|
||||
@@ -307,17 +382,34 @@ func (bot *Bot[T]) Close() error {
|
||||
}
|
||||
e = append(e, err)
|
||||
}
|
||||
observerCtx, observerCancel := context.WithTimeout(context.Background(), observerShutdownTimeout)
|
||||
logCloseErr(bot.stopObserverDispatcher(observerCtx))
|
||||
observerCancel()
|
||||
|
||||
for _, p := range bot.plugins {
|
||||
if err := p.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
}
|
||||
if bot.webhookLogger != nil {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
logCloseErr(err)
|
||||
closedLoggers := make(map[*sneklog.Logger]struct{}, 3)
|
||||
closeOwnedLogger := func(logger *sneklog.Logger, owned bool) {
|
||||
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.webhookLoggerOwned = false
|
||||
}
|
||||
if bot.uploader != nil {
|
||||
if err := bot.uploader.Close(); err != nil {
|
||||
@@ -330,14 +422,14 @@ func (bot *Bot[T]) Close() error {
|
||||
}
|
||||
}
|
||||
if bot.requestLogger != nil {
|
||||
if err := bot.requestLogger.Close(); err != nil {
|
||||
logCloseErr(err)
|
||||
}
|
||||
closeOwnedLogger(bot.requestLogger, bot.requestLoggerOwned)
|
||||
bot.requestLogger = nil
|
||||
bot.requestLoggerOwned = false
|
||||
}
|
||||
if bot.logger != nil {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
closeOwnedLogger(bot.logger, bot.loggerOwned)
|
||||
bot.logger = nil
|
||||
bot.loggerOwned = false
|
||||
}
|
||||
return errors.Join(e...)
|
||||
}
|
||||
@@ -427,25 +519,31 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
defer bot.finishRun()
|
||||
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!")
|
||||
err := bot.requestLogger.Close()
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
if bot.requestLoggerOwned {
|
||||
if err := bot.requestLogger.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
bot.requestLogger = nil
|
||||
bot.requestLoggerOwned = false
|
||||
}
|
||||
if bot.webhookLogger != nil {
|
||||
bot.logger.Warnln("Bot#webhookLogger present. You shouldn't set this, if ran in Long Polling mode!")
|
||||
err := bot.webhookLogger.Close()
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
if bot.webhookLoggerOwned {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
bot.webhookLogger = nil
|
||||
bot.webhookLoggerOwned = false
|
||||
}
|
||||
|
||||
bot.ExecRunners(ctx)
|
||||
|
||||
// Start update polling in a goroutine
|
||||
pollDone := make(chan error, 1)
|
||||
go func() {
|
||||
var terminalErr error
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in update polling: %v", r))
|
||||
@@ -453,6 +551,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
if !ok {
|
||||
err = fmt.Errorf("%v", r)
|
||||
}
|
||||
terminalErr = fmt.Errorf("update polling: %w: %v", ErrHandlerPanic, err)
|
||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerPollingKind,
|
||||
@@ -462,6 +561,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
})
|
||||
}
|
||||
close(bot.updateQueue)
|
||||
pollDone <- terminalErr
|
||||
}()
|
||||
backoffDelay := time.Duration(0)
|
||||
retryCount := 0
|
||||
@@ -472,7 +572,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
default:
|
||||
updates, err := bot.Updates(ctx)
|
||||
if err != nil {
|
||||
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
|
||||
if ctx.Err() != nil {
|
||||
return
|
||||
}
|
||||
retryDelay, ok := pollRetryAfterDelay(err)
|
||||
@@ -526,7 +626,8 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
|
||||
bot.runnerOnceWG.Wait()
|
||||
bot.runnerBgWG.Wait()
|
||||
return nil
|
||||
bot.middlewareWG.Wait()
|
||||
return <-pollDone
|
||||
}
|
||||
|
||||
// Run starts the bot using a background context.
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"fmt"
|
||||
"slices"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
|
||||
+7
-7
@@ -5,8 +5,8 @@ import (
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -54,8 +54,8 @@ type BotOpts struct {
|
||||
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
||||
RateLimit int
|
||||
|
||||
// DropRateLimitOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
||||
// Use this to prioritize responsiveness over reliability.
|
||||
// DropRateLimitOverflow rejects outgoing Telegram API requests immediately when
|
||||
// rate-limit capacity is unavailable instead of waiting for capacity.
|
||||
DropRateLimitOverflow bool
|
||||
|
||||
// StrictPayloadType disables callback payload fallback decoding.
|
||||
@@ -96,7 +96,7 @@ type BotOpts struct {
|
||||
// - USE_TEST_SERVER: "true" to use Telegram test server
|
||||
// - API_URL: custom API endpoint
|
||||
// - 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
|
||||
// - MAX_WORKERS: maximum number of concurrent update handlers (default: 32)
|
||||
// - POLL_TIMEOUT: long-polling timeout in seconds for getUpdates (default: 30)
|
||||
@@ -237,8 +237,8 @@ func (opts *BotOpts) SetRateLimit(limit int) *BotOpts {
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetDropRateLimitOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
||||
// Use this to prioritize responsiveness over reliability. Default is false.
|
||||
// SetDropRateLimitOverflow configures outgoing Telegram API requests to fail
|
||||
// immediately when rate-limit capacity is unavailable. Default is false.
|
||||
func (opts *BotOpts) SetDropRateLimitOverflow(drop bool) *BotOpts {
|
||||
opts.DropRateLimitOverflow = drop
|
||||
return opts
|
||||
|
||||
+50
-15
@@ -7,8 +7,8 @@ import (
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
)
|
||||
|
||||
// ConfigVersion is the current version of the built-in JSON BotOpts file format.
|
||||
@@ -34,16 +34,26 @@ type botOptsFileJSONAPI struct {
|
||||
|
||||
// BotOptsFileJSON is the JSON file representation of BotOpts.
|
||||
type BotOptsFileJSON struct {
|
||||
Version int `json:"version"`
|
||||
Token string `json:"token"`
|
||||
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||
Debug bool `json:"debug"`
|
||||
ErrorTemplate string `json:"error_template"`
|
||||
Prefixes []string `json:"prefixes"`
|
||||
Logger botOptsFileJSONLogger `json:"logger"`
|
||||
API botOptsFileJSONAPI `json:"api"`
|
||||
StrictPayloadType bool `json:"strict_payload_type"`
|
||||
MaxWorkers int `json:"max_workers"`
|
||||
// Version identifies the JSON configuration format version.
|
||||
Version int `json:"version"`
|
||||
// Token is the Telegram bot token.
|
||||
Token string `json:"token"`
|
||||
// UpdateTypes limits the update kinds requested from Telegram.
|
||||
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||
// Debug enables debug logging.
|
||||
Debug bool `json:"debug"`
|
||||
// ErrorTemplate formats user-facing handler errors.
|
||||
ErrorTemplate string `json:"error_template"`
|
||||
// Prefixes contains accepted command prefixes.
|
||||
Prefixes []string `json:"prefixes"`
|
||||
// Logger contains file logging options.
|
||||
Logger botOptsFileJSONLogger `json:"logger"`
|
||||
// API contains Telegram client and rate-limit options.
|
||||
API botOptsFileJSONAPI `json:"api"`
|
||||
// StrictPayloadType requires callback payloads to use the configured encoding.
|
||||
StrictPayloadType bool `json:"strict_payload_type"`
|
||||
// MaxWorkers limits concurrent update handlers.
|
||||
MaxWorkers int `json:"max_workers"`
|
||||
}
|
||||
|
||||
// BotOptsFileJSONCodec encodes and decodes BotOpts using BotOptsFileJSON.
|
||||
@@ -87,6 +97,9 @@ func (codec BotOptsFileJSONCodec) FromBytes(data []byte) (*BotOpts, error) {
|
||||
|
||||
// ToBytes encodes BotOpts into JSON file bytes.
|
||||
func (codec BotOptsFileJSONCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
||||
if opts == nil {
|
||||
return nil, ErrOptsIsNil
|
||||
}
|
||||
fileOpts := &BotOptsFileJSON{
|
||||
Version: ConfigVersion,
|
||||
Token: opts.Token,
|
||||
@@ -127,7 +140,17 @@ func (codec BotOptsFileJSONCodec) Save(filename string, opts *BotOpts) error {
|
||||
return SaveBotOptsFile(codec, filename, opts)
|
||||
}
|
||||
|
||||
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*\}\}`)
|
||||
// EscapeEnv escapes an environment value for use inside a JSON string.
|
||||
func (codec BotOptsFileJSONCodec) EscapeEnv(s string) string {
|
||||
data, _ := json.Marshal(s)
|
||||
return string(data[1 : len(data)-1])
|
||||
}
|
||||
|
||||
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*}}`)
|
||||
|
||||
type botOptsFileEnvEscaper interface {
|
||||
EscapeEnv(string) string
|
||||
}
|
||||
|
||||
// BotOptsFileCodec decodes and encodes BotOpts file formats.
|
||||
type BotOptsFileCodec interface {
|
||||
@@ -139,6 +162,9 @@ type BotOptsFileCodec interface {
|
||||
|
||||
// LoadBotOptsFile reads a config file, expands env placeholders, and decodes BotOpts.
|
||||
func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error) {
|
||||
if isNilValue(codec) {
|
||||
return nil, ErrCodecIsNil
|
||||
}
|
||||
f, err := os.Open(filename)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -148,12 +174,18 @@ func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
data = expandEnvPlaceholdersInFile(data)
|
||||
data = expandEnvPlaceholdersInFile(codec, data)
|
||||
return codec.FromBytes(data)
|
||||
}
|
||||
|
||||
// SaveBotOptsFile encodes BotOpts with codec and writes the result to filename.
|
||||
func SaveBotOptsFile(codec BotOptsFileCodec, filename string, opts *BotOpts) error {
|
||||
if isNilValue(codec) {
|
||||
return ErrCodecIsNil
|
||||
}
|
||||
if opts == nil {
|
||||
return ErrOptsIsNil
|
||||
}
|
||||
data, err := codec.ToBytes(opts)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -165,7 +197,7 @@ func SaveBotOptsFile(codec BotOptsFileCodec, filename string, opts *BotOpts) err
|
||||
return nil
|
||||
}
|
||||
|
||||
func expandEnvPlaceholdersInFile(data []byte) []byte {
|
||||
func expandEnvPlaceholdersInFile(codec BotOptsFileCodec, data []byte) []byte {
|
||||
return envParameterRegex.ReplaceAllFunc(data, func(match []byte) []byte {
|
||||
group := envParameterRegex.FindSubmatch(match)
|
||||
if len(group) != 2 {
|
||||
@@ -173,6 +205,9 @@ func expandEnvPlaceholdersInFile(data []byte) []byte {
|
||||
}
|
||||
key := group[1]
|
||||
value := os.Getenv(string(key))
|
||||
if escaper, ok := codec.(botOptsFileEnvEscaper); ok {
|
||||
value = escaper.EscapeEnv(value)
|
||||
}
|
||||
return []byte(value)
|
||||
})
|
||||
}
|
||||
|
||||
+35
-1
@@ -7,7 +7,7 @@ import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
func TestBotOptsFileJSONCodecRoundTrip(t *testing.T) {
|
||||
@@ -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) {
|
||||
t.Setenv("TG_TOKEN", "TOKEN_FROM_ENV")
|
||||
t.Setenv("BOT_API_URL", "https://api.example.invalid")
|
||||
@@ -82,6 +97,25 @@ func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadBotOptsFileEscapesEnvironmentValuesForJSON(t *testing.T) {
|
||||
want := "quote: \"; slash: \\; newline:\n; tab:\t; control:\x01"
|
||||
t.Setenv("TG_TOKEN", want)
|
||||
|
||||
dir := t.TempDir()
|
||||
filename := filepath.Join(dir, "config.json")
|
||||
if err := os.WriteFile(filename, []byte(`{"token":"{{TG_TOKEN}}"}`), 0o644); err != nil {
|
||||
t.Fatalf("WriteFile returned error: %v", err)
|
||||
}
|
||||
|
||||
got, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadBotOptsFile returned error: %v", err)
|
||||
}
|
||||
if got.Token != want {
|
||||
t.Fatalf("unexpected token: got %q want %q", got.Token, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadBotOptsFileReturnsDecodeError(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
filename := filepath.Join(dir, "config.json")
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
func TestLoadOptsFromEnvIgnoresEmptyUpdateTypes(t *testing.T) {
|
||||
|
||||
+32
-1
@@ -4,7 +4,7 @@ import (
|
||||
"fmt"
|
||||
"sort"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
)
|
||||
|
||||
// AddPlugins registers one or more plugins.
|
||||
@@ -19,6 +19,12 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
level := bot.GetLoggerLevel()
|
||||
sceneOwners := make(map[string]string)
|
||||
for _, registered := range bot.plugins {
|
||||
for name := range registered.scenes {
|
||||
sceneOwners[name] = registered.name
|
||||
}
|
||||
}
|
||||
for _, p := range plugin {
|
||||
if p == nil {
|
||||
if bot.logger != nil {
|
||||
@@ -27,6 +33,16 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
continue
|
||||
}
|
||||
cloned := clonePlugin(p)
|
||||
for name := range cloned.scenes {
|
||||
if owner, duplicate := sceneOwners[name]; duplicate {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnf("scene %q from plugin %q duplicates plugin %q; skipping", name, cloned.name, owner)
|
||||
}
|
||||
delete(cloned.scenes, name)
|
||||
continue
|
||||
}
|
||||
sceneOwners[name] = cloned.name
|
||||
}
|
||||
if cloned.logger == nil {
|
||||
cloned.logger = utils.CreateLogger(cloned.name, level, bot.logFormat, bot.logFormatter)
|
||||
cloned.loggerOwned = true
|
||||
@@ -134,6 +150,15 @@ func (bot *Bot[T]) AddRunner(runner Runner[T]) *Bot[T] {
|
||||
// return data.QueryLogger()
|
||||
// })
|
||||
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 {
|
||||
bot.logger.Warnln("app data is not set; skipping app-data logger writer")
|
||||
return bot
|
||||
@@ -143,6 +168,12 @@ func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
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)
|
||||
if bot.requestLogger != nil {
|
||||
bot.requestLogger.AddWriters(w)
|
||||
|
||||
+159
-5
@@ -12,7 +12,7 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -22,6 +22,14 @@ func (f pollingRoundTripFunc) RoundTrip(req *http.Request) (*http.Response, erro
|
||||
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 {
|
||||
recordingObserver
|
||||
cancel context.CancelFunc
|
||||
@@ -48,6 +56,17 @@ func (testObserver) OnRunnerFinished(context.Context, RunnerFinishedEvent) {}
|
||||
func (testObserver) OnPollingRetry(context.Context, PollingRetryEvent) {}
|
||||
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) {
|
||||
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) {
|
||||
type testDB struct{}
|
||||
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) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
cancel()
|
||||
@@ -812,8 +966,8 @@ func TestAddPluginsAndRuntimeRegistrationsNoOpAfterRunStarts(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
middlewares: []Middleware[NoData]{NewMiddleware("base", func(ctx *MessageContext, db NoData) bool { return true })},
|
||||
runners: []Runner[NoData]{NewRunner("base", func(bot *Bot[NoData]) error { return nil })},
|
||||
middlewares: []Middleware[NoData]{NewMiddleware("base", func(*MessageContext, NoData) bool { return true })},
|
||||
runners: []Runner[NoData]{NewRunner("base", func(context.Context, *Bot[NoData]) error { return nil })},
|
||||
}
|
||||
plugin := NewPlugin[NoData]("late")
|
||||
|
||||
@@ -823,8 +977,8 @@ func TestAddPluginsAndRuntimeRegistrationsNoOpAfterRunStarts(t *testing.T) {
|
||||
defer bot.finishRun()
|
||||
|
||||
bot.AddPlugins(plugin)
|
||||
bot.AddMiddleware(NewMiddleware("late", func(ctx *MessageContext, db NoData) bool { return true }))
|
||||
bot.AddRunner(NewRunner("late", func(bot *Bot[NoData]) error { return nil }))
|
||||
bot.AddMiddleware(NewMiddleware("late", func(*MessageContext, NoData) bool { return true }))
|
||||
bot.AddRunner(NewRunner("late", func(context.Context, *Bot[NoData]) error { return nil }))
|
||||
|
||||
if len(bot.plugins) != 0 {
|
||||
t.Fatalf("expected AddPlugins to be ignored after configuration freeze, got %d plugins", len(bot.plugins))
|
||||
|
||||
+48
-3
@@ -11,13 +11,15 @@ import (
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
"github.com/alitto/pond/v2"
|
||||
)
|
||||
|
||||
const observerShutdownTimeout = 5 * time.Second
|
||||
|
||||
func (bot *Bot[T]) addTokenReplacer(loggers ...*sneklog.Logger) {
|
||||
if bot.token == "" {
|
||||
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 {
|
||||
if logger == nil {
|
||||
return loggers
|
||||
@@ -80,26 +95,32 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||
format, formatter := opts.LogFormat, opts.LogFormatter
|
||||
if bot.logger == nil {
|
||||
bot.logger = utils.CreateLogger("BOT", level, format, formatter)
|
||||
bot.loggerOwned = true
|
||||
if opts.WriteToFile {
|
||||
path := fmt.Sprintf("%s/main.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||
logger, err := utils.CreateFileLogger("BOT", level, path, format, formatter)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
} else {
|
||||
_ = bot.logger.Close()
|
||||
bot.logger = logger
|
||||
bot.loggerOwned = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if opts.UseRequestLogger && bot.requestLogger == nil {
|
||||
bot.requestLogger = utils.CreateLogger("REQUESTS", level, format, formatter)
|
||||
bot.requestLoggerOwned = true
|
||||
if opts.WriteToFile {
|
||||
path := fmt.Sprintf("%s/requests.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||
logger, err := utils.CreateFileLogger("REQUESTS", level, path, format, formatter)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
} else {
|
||||
_ = bot.requestLogger.Close()
|
||||
bot.requestLogger = logger
|
||||
bot.requestLoggerOwned = true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -110,21 +131,45 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||
|
||||
func (bot *Bot[T]) beginRun() error {
|
||||
bot.runStateMu.Lock()
|
||||
defer bot.runStateMu.Unlock()
|
||||
if bot.running || bot.ran {
|
||||
bot.runStateMu.Unlock()
|
||||
return ErrBotAlreadyRun
|
||||
}
|
||||
bot.running = true
|
||||
bot.ran = true
|
||||
bot.runStateMu.Unlock()
|
||||
if bot.observer != nil {
|
||||
bot.observerAsync = newObserverDispatcher(bot.observer, bot.logger)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
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.running = false
|
||||
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 {
|
||||
if prev <= 0 {
|
||||
return time.Second
|
||||
|
||||
+61
-20
@@ -12,23 +12,33 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
)
|
||||
|
||||
// BotWebhookOpts configures Telegram webhook registration and the local HTTP server.
|
||||
type BotWebhookOpts struct {
|
||||
Path string
|
||||
LocalPort int
|
||||
// Path is the local HTTP route that receives Telegram updates.
|
||||
Path string
|
||||
// LocalPort is the TCP port used by the webhook server.
|
||||
LocalPort int
|
||||
// UseStatusPath enables the authenticated /status endpoint.
|
||||
UseStatusPath bool
|
||||
|
||||
URL string
|
||||
Certificate []byte
|
||||
IPAddress string
|
||||
MaxConnections int8
|
||||
AllowedUpdates []tgapi.UpdateType
|
||||
// URL is the public base URL Telegram uses for delivery.
|
||||
URL string
|
||||
// Certificate contains a self-signed public certificate to upload.
|
||||
Certificate []byte
|
||||
// IPAddress fixes the destination IP used by Telegram.
|
||||
IPAddress string
|
||||
// MaxConnections limits simultaneous Telegram webhook connections to 1–100.
|
||||
MaxConnections int8
|
||||
// AllowedUpdates limits the update kinds delivered to the webhook.
|
||||
AllowedUpdates []tgapi.UpdateType
|
||||
// DropPendingUpdates requests deletion of queued updates during registration.
|
||||
DropPendingUpdates bool
|
||||
SecretToken string
|
||||
// SecretToken authenticates Telegram requests and the optional status endpoint.
|
||||
SecretToken string
|
||||
}
|
||||
|
||||
// NewBotWebhookOpts returns webhook options with the default path, local port, and max connections.
|
||||
@@ -137,17 +147,26 @@ func (bot *Bot[T]) RunWebhookWithContext(ctx context.Context, opts *BotWebhookOp
|
||||
if len(bot.plugins) == 0 {
|
||||
return ErrNoPlugins
|
||||
}
|
||||
autoSecret := ""
|
||||
if opts.SecretToken == "" {
|
||||
rndSecret, err := generateToken(32)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
opts.SecretToken = rndSecret
|
||||
autoSecret = rndSecret
|
||||
}
|
||||
if opts.URL == "" {
|
||||
return ErrNoBotWebhookOptsURL
|
||||
}
|
||||
if opts.MaxConnections > 100 || opts.MaxConnections <= 0 {
|
||||
return ErrBotWebhookOptsMaxConnectionsRange
|
||||
}
|
||||
if err := validateWebhookPath(opts.Path, opts.UseStatusPath); err != nil {
|
||||
if err := validateWebhookSecretToken(opts.SecretToken); err != nil {
|
||||
return err
|
||||
}
|
||||
if opts.UseStatusPath && opts.SecretToken == "" {
|
||||
return ErrStatusPathSecretRequired
|
||||
if err := validateWebhookPath(opts.Path, opts.UseStatusPath); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := validateWebhookTLSFiles(tlsFiles); err != nil {
|
||||
return err
|
||||
@@ -158,10 +177,9 @@ func (bot *Bot[T]) RunWebhookWithContext(ctx context.Context, opts *BotWebhookOp
|
||||
}
|
||||
|
||||
return bot.runWebhookRuntime(ctx, func(runCtx context.Context) error {
|
||||
if opts.SecretToken == "" {
|
||||
bot.webhookLogger.Warnln("Using webhook without secret is very dangerous. Anyone can simulate Telegram requests.")
|
||||
if autoSecret != "" {
|
||||
bot.webhookLogger.Warnln("No webhook secret was configured; generated a random secret token")
|
||||
}
|
||||
|
||||
i, err := bot.api.GetWebhookInfoWithContext(runCtx)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -239,10 +257,13 @@ func (bot *Bot[T]) CloseWebhook() error {
|
||||
}
|
||||
}
|
||||
if bot.webhookLogger != nil {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
if bot.webhookLoggerOwned {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
}
|
||||
bot.webhookLogger = nil
|
||||
bot.webhookLoggerOwned = false
|
||||
}
|
||||
return errors.Join(e...)
|
||||
}
|
||||
@@ -265,6 +286,7 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
||||
|
||||
if bot.webhookLogger == nil {
|
||||
bot.webhookLogger = utils.CreateLogger("WEBHOOK", bot.GetLoggerLevel(), bot.logFormat, bot.logFormatter)
|
||||
bot.webhookLoggerOwned = true
|
||||
}
|
||||
bot.addTokenReplacer(bot.webhookLogger)
|
||||
bot.ExecRunners(runCtx)
|
||||
@@ -279,6 +301,7 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
||||
cancel()
|
||||
close(bot.updateQueue)
|
||||
<-workersDone
|
||||
bot.middlewareWG.Wait()
|
||||
bot.runnerOnceWG.Wait()
|
||||
bot.runnerBgWG.Wait()
|
||||
|
||||
@@ -376,8 +399,11 @@ func (bot *Bot[T]) newWebhookMux(ctx context.Context, opts *BotWebhookOpts) *htt
|
||||
}
|
||||
func (bot *Bot[T]) baseRunWebhook(ctx context.Context, opts *BotWebhookOpts, runFunc func(*http.Server, chan error)) error {
|
||||
srv := &http.Server{
|
||||
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||
Handler: bot.newWebhookMux(ctx, opts),
|
||||
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||
Handler: bot.newWebhookMux(ctx, opts),
|
||||
ReadHeaderTimeout: 5 * time.Second,
|
||||
ReadTimeout: 10 * time.Second,
|
||||
IdleTimeout: 60 * time.Second,
|
||||
}
|
||||
errCh := make(chan error, 1)
|
||||
|
||||
@@ -437,6 +463,21 @@ func validateWebhookPath(path string, useStatusPath bool) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateWebhookSecretToken(token string) error {
|
||||
if len(token) < 1 || len(token) > 256 {
|
||||
return ErrBotWebhookOptsSecretTokenInvalid
|
||||
}
|
||||
for _, r := range token {
|
||||
if (r < 'A' || r > 'Z') &&
|
||||
(r < 'a' || r > 'z') &&
|
||||
(r < '0' || r > '9') &&
|
||||
r != '_' && r != '-' {
|
||||
return ErrBotWebhookOptsSecretTokenInvalid
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateWebhookTLSFiles(tlsFiles []string) error {
|
||||
switch len(tlsFiles) {
|
||||
case 0, 2:
|
||||
|
||||
+37
-10
@@ -11,7 +11,7 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -91,7 +91,7 @@ func TestRunWebhookRuntimeExecutesRunners(t *testing.T) {
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
maxWorkers: 1,
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("runner", func(bot *Bot[NoData]) error {
|
||||
NewRunner("runner", func(context.Context, *Bot[NoData]) error {
|
||||
calls.Add(1)
|
||||
return nil
|
||||
}).Async(false),
|
||||
@@ -255,6 +255,33 @@ func TestValidateWebhookTLSFiles(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateWebhookSecretToken(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
token string
|
||||
wantErr bool
|
||||
}{
|
||||
{name: "minimum", token: "a"},
|
||||
{name: "allowed alphabet", token: "AZaz09_-"},
|
||||
{name: "maximum", token: strings.Repeat("a", 256)},
|
||||
{name: "empty", token: "", wantErr: true},
|
||||
{name: "too long", token: strings.Repeat("a", 257), wantErr: true},
|
||||
{name: "padding", token: "abc=", wantErr: true},
|
||||
{name: "non ASCII", token: "секрет", wantErr: true},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := validateWebhookSecretToken(tt.token)
|
||||
if tt.wantErr && !errors.Is(err, ErrBotWebhookOptsSecretTokenInvalid) {
|
||||
t.Fatalf("expected ErrBotWebhookOptsSecretTokenInvalid, got %v", err)
|
||||
}
|
||||
if !tt.wantErr && err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpdateHandlerRejectsOversizedBody(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
@@ -350,20 +377,20 @@ func TestRunWebhookWithContextRejectsInvalidTLSFilesBeforeRemoteSetup(t *testing
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWebhookWithContextRequiresSecretWhenStatusPathEnabled(t *testing.T) {
|
||||
func TestRunWebhookWithContextAutoGeneratesSecretWhenEmpty(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||
}
|
||||
opts := NewBotWebhookOpts().
|
||||
SetURL("https://bot.example.com").
|
||||
SetUseStatusPath(true)
|
||||
// No SecretToken, no URL — function should auto-generate the token
|
||||
// and then fail with ErrNoBotWebhookOptsURL before any network call.
|
||||
opts := NewBotWebhookOpts().SetUseStatusPath(true)
|
||||
|
||||
err := bot.RunWebhookWithContext(context.Background(), opts)
|
||||
if err == nil {
|
||||
t.Fatal("expected status-path secret validation error, got nil")
|
||||
if !errors.Is(err, ErrNoBotWebhookOptsURL) {
|
||||
t.Fatalf("expected ErrNoBotWebhookOptsURL after auto-generation, got: %v", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "SecretToken required") {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
if opts.SecretToken == "" {
|
||||
t.Fatal("expected SecretToken to be auto-generated, got empty string")
|
||||
}
|
||||
}
|
||||
|
||||
+123
-49
@@ -1,16 +1,17 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
"unicode/utf8"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
// cmdRegexp matches command names allowed for Telegram command registration.
|
||||
var cmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
||||
|
||||
// ErrTooManyCommands is returned when the total number of registered commands
|
||||
@@ -21,6 +22,39 @@ var cmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
||||
// bot initialization.
|
||||
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 {
|
||||
desc := ""
|
||||
if len(cmd.description) > 0 {
|
||||
@@ -36,17 +70,20 @@ 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 != "" {
|
||||
desc = fmt.Sprintf("%s. %s", desc, usage)
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: desc}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: desc, IsEphemeral: cmd.isEphemeral}
|
||||
}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: usage}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: usage, IsEphemeral: cmd.isEphemeral}
|
||||
}
|
||||
|
||||
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)
|
||||
names := make([]string, 0, len(pl.commands))
|
||||
for name := range pl.commands {
|
||||
@@ -60,34 +97,55 @@ func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
||||
continue
|
||||
}
|
||||
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,
|
||||
)
|
||||
}
|
||||
commands = append(commands, generated)
|
||||
}
|
||||
return commands
|
||||
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)
|
||||
owners := make(map[string]string)
|
||||
for _, pl := range bot.plugins {
|
||||
if pl.skipAutoCmd {
|
||||
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))
|
||||
}
|
||||
return commands
|
||||
return commands, nil
|
||||
}
|
||||
|
||||
// AutoGenerateCommands registers all plugin-defined commands with Telegram's Bot API
|
||||
// across three scopes:
|
||||
// - Private chats (users)
|
||||
// - Group chats
|
||||
// - Group administrators
|
||||
//
|
||||
// It first deletes existing commands to ensure a clean state, then sets the new
|
||||
// set of commands for all scopes. This ensures consistency even if commands were
|
||||
// previously modified manually via @BotFather.
|
||||
// AutoGenerateCommands replaces plugin-defined commands in the private-chat,
|
||||
// group-chat, and all-chat-administrators scopes.
|
||||
//
|
||||
// Returns ErrTooManyCommands if the total number of commands exceeds 100.
|
||||
// Returns any API error from Telegram (e.g., network issues, invalid scope).
|
||||
@@ -102,40 +160,45 @@ func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||
commands := gatherCommands(bot)
|
||||
return bot.AutoGenerateCommandsWithContext(context.Background())
|
||||
}
|
||||
|
||||
// AutoGenerateCommandsWithContext is the context-aware variant of AutoGenerateCommands.
|
||||
func (bot *Bot[T]) AutoGenerateCommandsWithContext(ctx context.Context) error {
|
||||
commands, err := gatherCommands(bot)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
|
||||
// Clear existing commands to avoid duplication or stale entries
|
||||
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommands{})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||
}
|
||||
|
||||
// Register commands for each scope
|
||||
scopes := []*tgapi.BotCommandScope{
|
||||
scopes := []tgapi.BotCommandScope{
|
||||
{Type: tgapi.BotCommandScopePrivateType},
|
||||
{Type: tgapi.BotCommandScopeGroupType},
|
||||
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
||||
}
|
||||
|
||||
for _, scope := range scopes {
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommands{
|
||||
Commands: commands,
|
||||
Scope: scope,
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||
updatedScopes := make([]tgapi.BotCommandScopeType, 0, len(scopes))
|
||||
for i := range scopes {
|
||||
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
|
||||
}
|
||||
updatedScopes = append(updatedScopes, scopes[i].Type)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// AutoGenerateCommandsForScope registers all plugin-defined commands with Telegram's Bot API
|
||||
// for the specified command scope. It first deletes any existing commands in that scope
|
||||
// to ensure a clean state, then sets the new set of commands.
|
||||
// for the specified command scope. A nil scope selects Telegram's default scope.
|
||||
//
|
||||
// The scope parameter defines where the commands should be available (e.g., private chats,
|
||||
// group chats, chat administrators). See tgapi.BotCommandScope and its predefined types.
|
||||
@@ -150,22 +213,33 @@ func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func (bot *Bot[T]) AutoGenerateCommandsForScope(scope *tgapi.BotCommandScope) error {
|
||||
commands := gatherCommands(bot)
|
||||
return bot.AutoGenerateCommandsForScopeWithContext(context.Background(), scope)
|
||||
}
|
||||
|
||||
// AutoGenerateCommandsForScopeWithContext is the context-aware variant of
|
||||
// AutoGenerateCommandsForScope.
|
||||
func (bot *Bot[T]) AutoGenerateCommandsForScopeWithContext(ctx context.Context, scope *tgapi.BotCommandScope) error {
|
||||
commands, err := gatherCommands(bot)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
return bot.setCommandsForScope(ctx, scope, commands)
|
||||
}
|
||||
|
||||
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommands{Scope: scope})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||
func (bot *Bot[T]) setCommandsForScope(ctx context.Context, scope *tgapi.BotCommandScope, commands []tgapi.BotCommand) error {
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommands{
|
||||
Commands: commands,
|
||||
Scope: scope,
|
||||
})
|
||||
_, err := bot.api.SetMyCommandsWithContext(ctx, tgapi.SetMyCommands{Scope: scope, Commands: commands})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||
scopeType := tgapi.BotCommandScopeDefaultType
|
||||
if scope != nil {
|
||||
scopeType = scope.Type
|
||||
}
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scopeType, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
+179
-2
@@ -10,7 +10,7 @@ import (
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -72,7 +72,10 @@ func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
||||
plugin.Command("alpha", 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))
|
||||
for _, cmd := range commands {
|
||||
got = append(got, cmd.Command)
|
||||
@@ -83,3 +86,177 @@ func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
||||
t.Fatalf("unexpected command order: got %v want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
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) {
|
||||
var methods []string
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
methods = append(methods, req.URL.Path)
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||
}, nil
|
||||
}),
|
||||
}
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
if err := api.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
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() {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
t.Fatalf("Close logger returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
if err := bot.AutoGenerateCommandsForScope(nil); err != nil {
|
||||
t.Fatalf("AutoGenerateCommandsForScope returned error: %v", err)
|
||||
}
|
||||
if len(methods) != 1 {
|
||||
t.Fatalf("expected one request, got %d", len(methods))
|
||||
}
|
||||
if !strings.HasSuffix(methods[0], "/setMyCommands") {
|
||||
t.Fatalf("expected setMyCommands request, got %v", methods[0])
|
||||
}
|
||||
}
|
||||
|
||||
+12
-1
@@ -93,6 +93,7 @@ type Command[T AppData] struct {
|
||||
args extypes.Slice[CommandArg] // List of expected arguments
|
||||
middlewares extypes.Slice[Middleware[T]] // Optional middleware chain
|
||||
skipAutoCmd bool // If true, this command won't be auto-added to help menus
|
||||
isEphemeral bool
|
||||
}
|
||||
|
||||
// NewCommand creates a new Command with the given identifier, executor, and arguments.
|
||||
@@ -108,7 +109,9 @@ type Command[T AppData] struct {
|
||||
// that fit Telegram's callback_data limit, though the configured payload
|
||||
// encoding may impose its own restrictions.
|
||||
func NewCommand[T any](command string, exec CommandExecutor[T], args ...CommandArg) *Command[T] {
|
||||
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
|
||||
return &Command[T]{
|
||||
command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false, false,
|
||||
}
|
||||
}
|
||||
|
||||
// Use adds a middleware to the command's execution chain.
|
||||
@@ -130,6 +133,14 @@ func (c *Command[T]) SkipCommandAutoGen() *Command[T] {
|
||||
return c
|
||||
}
|
||||
|
||||
// SetEphemeral controls whether Telegram treats the command as ephemeral.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (c *Command[T]) SetEphemeral(b bool) *Command[T] {
|
||||
c.isEphemeral = b
|
||||
return c
|
||||
}
|
||||
|
||||
func (c *Command[T]) validateArgs(args []string) error {
|
||||
for i := range c.args.Len() {
|
||||
if i >= len(args) && c.args.Get(i).required {
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
type draftIDGenerator interface {
|
||||
@@ -45,10 +45,8 @@ type DraftProvider struct {
|
||||
generator draftIDGenerator
|
||||
}
|
||||
|
||||
// NewRandomDraftProvider creates a new DraftProvider using random draft IDs.
|
||||
//
|
||||
// The provider will use random numbers for draft IDs.
|
||||
// All drafts created via this provider will have unpredictable, unique IDs.
|
||||
// NewRandomDraftProvider creates a DraftProvider using non-cryptographic random IDs.
|
||||
// Zero values and collisions with active drafts are retried.
|
||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||
return &DraftProvider{
|
||||
api: api, generator: &RandomDraftIDGenerator{},
|
||||
@@ -121,7 +119,9 @@ type Draft struct {
|
||||
parseMode tgapi.ParseMode
|
||||
entities []tgapi.MessageEntity
|
||||
|
||||
ID uint64
|
||||
// ID uniquely identifies the draft within its provider.
|
||||
ID uint64
|
||||
// Message contains the current draft text.
|
||||
Message string
|
||||
}
|
||||
|
||||
@@ -129,7 +129,19 @@ type Draft struct {
|
||||
//
|
||||
// The caller must set a chat with SetChat before Push or Flush.
|
||||
func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
id := p.generator.Next()
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
|
||||
var id uint64
|
||||
for {
|
||||
id = p.generator.Next()
|
||||
if id == 0 {
|
||||
continue
|
||||
}
|
||||
if _, exists := p.drafts[id]; !exists {
|
||||
break
|
||||
}
|
||||
}
|
||||
draft := &Draft{
|
||||
api: p.api,
|
||||
provider: p,
|
||||
@@ -137,9 +149,7 @@ func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
ID: id,
|
||||
Message: "",
|
||||
}
|
||||
p.mu.Lock()
|
||||
p.drafts[id] = draft
|
||||
p.mu.Unlock()
|
||||
return draft
|
||||
}
|
||||
|
||||
@@ -154,10 +164,9 @@ func (d *Draft) SetChat(chatID int64, messageThreadID int) *Draft {
|
||||
|
||||
// SetEntities replaces the draft's message entities.
|
||||
//
|
||||
// Entities are stored by reference. If you plan to mutate the slice later,
|
||||
// pass a copy: `SetEntities(append([]tgapi.MessageEntity{}, myEntities...))`.
|
||||
// The entities slice is copied.
|
||||
func (d *Draft) SetEntities(entities []tgapi.MessageEntity) *Draft {
|
||||
d.entities = entities
|
||||
d.entities = append([]tgapi.MessageEntity(nil), entities...)
|
||||
return d
|
||||
}
|
||||
|
||||
@@ -212,6 +221,7 @@ func (d *Draft) Delete() {
|
||||
// If the draft is empty, Flush() returns nil without calling the API.
|
||||
func (d *Draft) Flush() error {
|
||||
if d.Message == "" {
|
||||
d.Delete()
|
||||
return nil
|
||||
}
|
||||
if d.chatID == 0 {
|
||||
@@ -220,6 +230,9 @@ func (d *Draft) Flush() error {
|
||||
if err := validateMessageText(d.Message); err != nil {
|
||||
return err
|
||||
}
|
||||
if d.api == nil {
|
||||
return ErrAPIIsNil
|
||||
}
|
||||
|
||||
params := tgapi.SendMessage{
|
||||
ChatID: d.chatID,
|
||||
@@ -252,6 +265,9 @@ func (d *Draft) push(text string) error {
|
||||
return err
|
||||
}
|
||||
d.Message = candidate
|
||||
if d.api == nil {
|
||||
return ErrAPIIsNil
|
||||
}
|
||||
params := tgapi.SendMessageDraft{
|
||||
ChatID: d.chatID,
|
||||
DraftID: d.ID,
|
||||
|
||||
+66
-1
@@ -5,10 +5,21 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type sequenceDraftIDGenerator struct {
|
||||
ids []uint64
|
||||
pos int
|
||||
}
|
||||
|
||||
func (g *sequenceDraftIDGenerator) Next() uint64 {
|
||||
id := g.ids[g.pos]
|
||||
g.pos++
|
||||
return id
|
||||
}
|
||||
|
||||
func TestDraftFlushRequiresChatID(t *testing.T) {
|
||||
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone)
|
||||
draft.Message = "hello"
|
||||
@@ -18,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) {
|
||||
ctx := &MessageContext{
|
||||
API: &tgapi.API{},
|
||||
@@ -38,6 +75,34 @@ func TestMsgContextNewDraftWorksWithoutLimiter(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftProviderSkipsZeroAndCollidingIDs(t *testing.T) {
|
||||
provider := &DraftProvider{
|
||||
api: &tgapi.API{},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
generator: &sequenceDraftIDGenerator{ids: []uint64{0, 7, 7, 8}},
|
||||
}
|
||||
|
||||
first := provider.NewDraft(tgapi.ParseNone)
|
||||
second := provider.NewDraft(tgapi.ParseNone)
|
||||
if first.ID != 7 || second.ID != 8 {
|
||||
t.Fatalf("unexpected draft IDs: first=%d second=%d", first.ID, second.ID)
|
||||
}
|
||||
if got := len(provider.drafts); got != 2 {
|
||||
t.Fatalf("collision overwrote a draft: got %d drafts", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftReturnsErrorWhenAPIIsNil(t *testing.T) {
|
||||
draft := NewLinearDraftProvider(nil, 0).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||
if err := draft.Push("hello"); !errors.Is(err, ErrAPIIsNil) {
|
||||
t.Fatalf("expected ErrAPIIsNil from Push, got %v", err)
|
||||
}
|
||||
draft.Message = "hello"
|
||||
if err := draft.Flush(); !errors.Is(err, ErrAPIIsNil) {
|
||||
t.Fatalf("expected ErrAPIIsNil from Flush, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftFlushRejectsLongMessage(t *testing.T) {
|
||||
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||
draft.Message = strings.Repeat("a", maxMessageTextLen+1)
|
||||
|
||||
@@ -8,6 +8,7 @@ type classifiedError struct {
|
||||
internalOnly bool
|
||||
}
|
||||
|
||||
// Error returns the underlying error message.
|
||||
func (e *classifiedError) Error() string {
|
||||
if e == nil || e.err == nil {
|
||||
return ""
|
||||
@@ -15,6 +16,7 @@ func (e *classifiedError) Error() string {
|
||||
return e.err.Error()
|
||||
}
|
||||
|
||||
// Unwrap returns the underlying error.
|
||||
func (e *classifiedError) Unwrap() error {
|
||||
if e == nil {
|
||||
return nil
|
||||
|
||||
@@ -38,6 +38,8 @@ var (
|
||||
ErrAPIIsNil = errors.New("api is nil")
|
||||
// ErrMessageIDZero reports that an operation requires a non-zero message ID.
|
||||
ErrMessageIDZero = errors.New("message ID is zero")
|
||||
// ErrCodecIsNil reports that a config operation received a nil codec.
|
||||
ErrCodecIsNil = errors.New("codec is nil")
|
||||
)
|
||||
var (
|
||||
// ErrBindArgsTargetNotPointer reports that BindArgs received a nil or non-pointer destination.
|
||||
@@ -60,6 +62,22 @@ var (
|
||||
ErrSceneEntryNotSet = errors.New("scene entry step not set")
|
||||
// ErrSceneRuntimeNil reports that scene APIs were used without an attached runtime.
|
||||
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")
|
||||
// ErrInlineKeyboardMaxRow reports a non-positive row limit without explicit unlimited mode.
|
||||
ErrInlineKeyboardMaxRow = errors.New("inline keyboard maximum row size must be positive")
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -69,6 +87,8 @@ var (
|
||||
ErrNoBotWebhookOptsURL = errors.New("empty BotWebhookOpts.URL")
|
||||
// ErrBotWebhookOptsMaxConnectionsRange reports that BotWebhookOpts.MaxConnections is out of range.
|
||||
ErrBotWebhookOptsMaxConnectionsRange = errors.New("BotWebhookOpts.MaxConnections must be between 1 and 100")
|
||||
// ErrBotWebhookOptsSecretTokenInvalid reports that SecretToken violates Telegram's format.
|
||||
ErrBotWebhookOptsSecretTokenInvalid = errors.New("BotWebhookOpts.SecretToken must be 1-256 characters from A-Z, a-z, 0-9, _ and -")
|
||||
// ErrBotUploaderWhenCertificate reports that a certificate was set without an uploader.
|
||||
ErrBotUploaderWhenCertificate = errors.New("bot uploader nil, but certificate set")
|
||||
// ErrStatusPathSecretRequired reports that UseStatusPath requires SecretToken to be set.
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
module git.scuroneko.dev/scuroneko/laniakea
|
||||
module git.scuroneko.dev/scuroneko/laniakea/v2
|
||||
|
||||
go 1.26
|
||||
|
||||
retract v1.0.0-rc.5
|
||||
go 1.27
|
||||
|
||||
require (
|
||||
git.scuroneko.dev/scuroneko/extypes v1.2.3
|
||||
|
||||
+18
-13
@@ -9,7 +9,7 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
// ErrInvalidPayloadType is returned when callback payload encoding type is unknown.
|
||||
@@ -51,6 +51,8 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
draftProvider: bot.draftProvider,
|
||||
sceneRuntime: bot,
|
||||
observer: bot.observer,
|
||||
eventEmitter: bot.safeEmitEvent,
|
||||
asyncTask: bot.startAsyncTask,
|
||||
payloadType: bot.payloadType,
|
||||
botID: bot.userID,
|
||||
ctx: ctx,
|
||||
@@ -79,7 +81,7 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
|
||||
sceneHandled, err := bot.tryHandleScene(msgCtx)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
msgCtx.error(err)
|
||||
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
@@ -88,17 +90,20 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
Duration: time.Since(startTime),
|
||||
Handled: false,
|
||||
})
|
||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerSceneKind,
|
||||
HandlerName: "tryHandleScene",
|
||||
FromID: msgCtx.FromID,
|
||||
ChatID: msgCtx.ChatID,
|
||||
Err: err,
|
||||
UserFacing: false,
|
||||
})
|
||||
var reported *reportedSceneError
|
||||
if !errors.As(err, &reported) {
|
||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerSceneKind,
|
||||
HandlerName: "tryHandleScene",
|
||||
FromID: msgCtx.FromID,
|
||||
ChatID: msgCtx.ChatID,
|
||||
Err: err,
|
||||
UserFacing: IsUserError(err),
|
||||
})
|
||||
}
|
||||
return
|
||||
}
|
||||
if sceneHandled {
|
||||
|
||||
+297
-6
@@ -3,9 +3,13 @@ package laniakea
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -313,11 +317,20 @@ func TestPrepareUpdateCtxContract(t *testing.T) {
|
||||
name: "poll answer",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypePollAnswer,
|
||||
PollAnswer: &tgapi.PollAnswer{User: tgapi.User{ID: 115}},
|
||||
PollAnswer: &tgapi.PollAnswer{User: &tgapi.User{ID: 115}},
|
||||
},
|
||||
wantFrom: true,
|
||||
wantFromID: 115,
|
||||
},
|
||||
{
|
||||
name: "anonymous poll answer",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypePollAnswer,
|
||||
PollAnswer: &tgapi.PollAnswer{VoterChat: &tgapi.Chat{ID: -2007}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2007,
|
||||
},
|
||||
{
|
||||
name: "message reaction",
|
||||
update: &tgapi.Update{
|
||||
@@ -368,8 +381,76 @@ func TestPrepareUpdateCtxContract(t *testing.T) {
|
||||
name: "message reaction count",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeMessageReactionCount,
|
||||
MessageReactionCount: &tgapi.MessageReactionCountUpdated{},
|
||||
MessageReactionCount: &tgapi.MessageReactionCountUpdated{Chat: &tgapi.Chat{ID: -2008}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2008,
|
||||
},
|
||||
{
|
||||
name: "guest message",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeGuestMessage,
|
||||
GuestMessage: &tgapi.Message{
|
||||
From: &tgapi.User{ID: 119},
|
||||
Chat: &tgapi.Chat{ID: -2009},
|
||||
},
|
||||
},
|
||||
wantMsg: true,
|
||||
wantFrom: true,
|
||||
wantFromID: 119,
|
||||
wantChat: true,
|
||||
wantChatID: -2009,
|
||||
},
|
||||
{
|
||||
name: "deleted business messages",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeDeletedBusinessMessages,
|
||||
DeletedBusinessMessages: &tgapi.BusinessMessagesDeleted{Chat: tgapi.Chat{ID: -2010}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2010,
|
||||
},
|
||||
{
|
||||
name: "managed bot",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeManagedBot,
|
||||
ManagedBot: &tgapi.ManagedBotUpdated{User: tgapi.User{ID: 120}},
|
||||
},
|
||||
wantFrom: true,
|
||||
wantFromID: 120,
|
||||
},
|
||||
{
|
||||
name: "subscription",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeSubscription,
|
||||
Subscription: &tgapi.BotSubscriptionUpdated{User: tgapi.User{ID: 121}},
|
||||
},
|
||||
wantFrom: true,
|
||||
wantFromID: 121,
|
||||
},
|
||||
{
|
||||
name: "stopped message generation",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeMessageGenerationStopped,
|
||||
StoppedMessageGeneration: &tgapi.MessageGenerationStopped{
|
||||
Chat: tgapi.Chat{ID: -2012},
|
||||
DraftID: 7,
|
||||
},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2012,
|
||||
},
|
||||
{
|
||||
name: "giveaway chat boost has no user",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeChatBoost,
|
||||
ChatBoost: &tgapi.ChatBoostUpdated{
|
||||
Chat: tgapi.Chat{ID: -2011},
|
||||
Boost: tgapi.ChatBoost{Source: tgapi.ChatBoostSource{Source: "giveaway"}},
|
||||
},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2011,
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1233,6 +1314,8 @@ func TestParseCommandTable(t *testing.T) {
|
||||
{name: "plain text", text: "hello", wantPrefix: "", wantCmd: "", 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: "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: "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"},
|
||||
@@ -1264,6 +1347,7 @@ func TestHandleMessageStripsBotUsernameSuffix(t *testing.T) {
|
||||
}{
|
||||
{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 ignores case", botUsername: "MyBot", text: "/start@mybot", wantCalled: true},
|
||||
{name: "other botname", botUsername: "mybot", text: "/start@otherbot hello", wantCalled: false},
|
||||
{name: "no botname", botUsername: "mybot", text: "/start hello", wantCalled: true},
|
||||
{name: "bot has no username", botUsername: "", text: "/start@mybot hello", wantCalled: false},
|
||||
@@ -1313,14 +1397,14 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
||||
name: "error value",
|
||||
panicWith: errors.New("boom"),
|
||||
matchErr: func(err error) bool {
|
||||
return err != nil && err.Error() == "boom"
|
||||
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "boom")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "string value",
|
||||
panicWith: "kaboom",
|
||||
matchErr: func(err error) bool {
|
||||
return err != nil && err.Error() == "kaboom"
|
||||
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "kaboom")
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -1354,7 +1438,7 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
||||
panicEvent := (*ErrorEvent)(nil)
|
||||
for i := range observer.errors {
|
||||
ev := observer.errors[i]
|
||||
if ev.Plugin == "" && ev.HandlerKind == "" && ev.UpdateID == 100 {
|
||||
if ev.Plugin == "test" && ev.HandlerKind == HandlerCommandKind && ev.UpdateID == 100 {
|
||||
panicEvent = &ev
|
||||
break
|
||||
}
|
||||
@@ -1371,10 +1455,217 @@ func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
||||
if !tt.matchErr(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) {
|
||||
observer := &recordingObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
|
||||
+152
-33
@@ -4,7 +4,7 @@ import (
|
||||
"fmt"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
const (
|
||||
@@ -24,15 +24,16 @@ const (
|
||||
// - SetURL() — makes button open a URL
|
||||
// - 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.
|
||||
type InlineKeyboardButtonBuilder struct {
|
||||
text string
|
||||
emojiID string
|
||||
style tgapi.KeyboardButtonStyle
|
||||
|
||||
url string
|
||||
data string
|
||||
url string
|
||||
data string
|
||||
disabled bool
|
||||
|
||||
payloadType BotPayloadType
|
||||
}
|
||||
@@ -59,9 +60,23 @@ func (b InlineKeyboardButtonBuilder) SetStyle(style tgapi.KeyboardButtonStyle) I
|
||||
}
|
||||
|
||||
// SetURL sets a URL that will be opened when the button is pressed.
|
||||
// If both URL and CallbackData are set, Telegram will prioritize URL.
|
||||
// It clears callback data because Telegram requires exactly one button action.
|
||||
func (b InlineKeyboardButtonBuilder) SetURL(url string) InlineKeyboardButtonBuilder {
|
||||
b.url = url
|
||||
if url != "" {
|
||||
b.data = ""
|
||||
b.disabled = false
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
// SetDisabled makes the button inert and clears URL and callback actions.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (b InlineKeyboardButtonBuilder) SetDisabled() InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.data = ""
|
||||
b.disabled = true
|
||||
return b
|
||||
}
|
||||
|
||||
@@ -79,26 +94,33 @@ func (b InlineKeyboardButtonBuilder) SetPayloadType(t BotPayloadType) InlineKeyb
|
||||
//
|
||||
// Example: SetCallbackDataJSON("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataJSON(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.disabled = false
|
||||
b.data = NewCallbackData(cmd, args...).ToJSON()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataBase64 sets a structured callback payload encoded as Base64.
|
||||
// This can be useful when the JSON payload exceeds Telegram's callback data length limit.
|
||||
// Args are converted to strings using fmt.Sprint.
|
||||
// SetCallbackDataBase64 sets a Base64-encoded structured callback payload.
|
||||
// Base64 does not bypass Telegram's 64-byte callback-data limit.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataBase64(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.disabled = false
|
||||
b.data = NewCallbackData(cmd, args...).ToBase64()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataCompact sets a structured callback payload encoded as compact text.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataCompact(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.disabled = false
|
||||
b.data = NewCallbackData(cmd, args...).ToCompact()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataCompactBase64 sets a compact callback payload encoded as Base64.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataCompactBase64(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.disabled = false
|
||||
b.data = NewCallbackData(cmd, args...).ToCompactBase64()
|
||||
return b
|
||||
}
|
||||
@@ -106,6 +128,8 @@ func (b InlineKeyboardButtonBuilder) SetCallbackDataCompactBase64(cmd string, ar
|
||||
// SetCallbackData sets a structured callback payload using the configured payload type.
|
||||
// The default payload type is JSON.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.disabled = false
|
||||
switch b.payloadType {
|
||||
case BotPayloadJSON:
|
||||
b.data = NewCallbackData(cmd, args...).ToJSON()
|
||||
@@ -121,16 +145,35 @@ func (b InlineKeyboardButtonBuilder) SetCallbackData(cmd string, args ...any) In
|
||||
return b
|
||||
}
|
||||
|
||||
func (b InlineKeyboardButtonBuilder) validate() error { return validateButton(b.build()) }
|
||||
|
||||
func (b InlineKeyboardButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
var disabled *tgapi.DisabledButton
|
||||
if b.disabled {
|
||||
disabled = &tgapi.DisabledButton{}
|
||||
}
|
||||
return tgapi.InlineKeyboardButton{
|
||||
Text: b.text,
|
||||
URL: b.url,
|
||||
Style: b.style,
|
||||
IconCustomEmojiID: b.emojiID,
|
||||
CallbackData: b.data,
|
||||
Disabled: disabled,
|
||||
}
|
||||
}
|
||||
|
||||
// Validate checks that the button has exactly one action and valid callback data.
|
||||
func (b InlineKeyboardButtonBuilder) Validate() error { return b.validate() }
|
||||
|
||||
// Build validates and returns the configured inline keyboard button.
|
||||
func (b InlineKeyboardButtonBuilder) Build() (tgapi.InlineKeyboardButton, error) {
|
||||
if err := b.validate(); err != nil {
|
||||
return tgapi.InlineKeyboardButton{}, err
|
||||
}
|
||||
button := b.build()
|
||||
return button, nil
|
||||
}
|
||||
|
||||
// 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.
|
||||
@@ -138,14 +181,17 @@ func (b InlineKeyboardButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
//
|
||||
// The keyboard is not thread-safe. Build it in a single goroutine.
|
||||
type InlineKeyboard struct {
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
||||
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||
// CurrentLine is the row currently being built.
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton]
|
||||
// Lines contains completed keyboard rows.
|
||||
Lines [][]tgapi.InlineKeyboardButton
|
||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||
unlimitedRows bool
|
||||
|
||||
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardJSON creates a new keyboard builder with the specified maximum
|
||||
// NewInlineKeyboardJSON creates a keyboard builder with a positive maximum
|
||||
// number of buttons per row.
|
||||
//
|
||||
// Example: NewInlineKeyboardJSON(3) creates a keyboard with at most 3 buttons per line.
|
||||
@@ -153,7 +199,7 @@ func NewInlineKeyboardJSON(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(BotPayloadJSON, maxRow)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardBase64 creates a new keyboard builder with the specified maximum
|
||||
// NewInlineKeyboardBase64 creates a keyboard builder with a positive maximum
|
||||
// number of buttons per row, using Base64 encoding for button payloads.
|
||||
//
|
||||
// Example: NewInlineKeyboardBase64(3) creates a keyboard with at most 3 buttons per line.
|
||||
@@ -171,8 +217,8 @@ func NewInlineKeyboardCompactBase64(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(BotPayloadCompactBase64, maxRow)
|
||||
}
|
||||
|
||||
// NewInlineKeyboard creates a new keyboard builder with the specified payload encoding
|
||||
// type and maximum number of buttons per row.
|
||||
// NewInlineKeyboard creates a keyboard builder with the specified payload encoding
|
||||
// and a positive maximum number of buttons per row.
|
||||
//
|
||||
// Use NewInlineKeyboardJSON or NewInlineKeyboardBase64 for the common cases.
|
||||
func NewInlineKeyboard(payloadType BotPayloadType, maxRow int) *InlineKeyboard {
|
||||
@@ -195,18 +241,27 @@ func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
|
||||
// GetPayloadType returns the keyboard-local callback payload encoding type.
|
||||
func (in *InlineKeyboard) GetPayloadType() BotPayloadType { return in.payloadType }
|
||||
|
||||
// SetMaxRow sets the maximum number of buttons appended to a row before the
|
||||
// keyboard automatically starts a new line.
|
||||
// SetMaxRow sets the positive number of buttons appended to a row before the
|
||||
// keyboard automatically starts a new line. Get returns ErrInlineKeyboardMaxRow
|
||||
// when maxRow is not positive.
|
||||
func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
||||
in.maxRow = maxRow
|
||||
in.unlimitedRows = false
|
||||
return in
|
||||
}
|
||||
|
||||
// GetMaxRow returns the maximum number of buttons per row.
|
||||
// SetUnlimitedRows disables automatic row wrapping explicitly.
|
||||
func (in *InlineKeyboard) SetUnlimitedRows() *InlineKeyboard {
|
||||
in.maxRow = 0
|
||||
in.unlimitedRows = true
|
||||
return in
|
||||
}
|
||||
|
||||
// GetMaxRow returns the maximum number of buttons per row, or zero in explicit unlimited mode.
|
||||
func (in *InlineKeyboard) GetMaxRow() int { return in.maxRow }
|
||||
|
||||
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||
if in.CurrentLine.Len() == in.maxRow {
|
||||
if !in.unlimitedRows && in.maxRow > 0 && in.CurrentLine.Len() >= in.maxRow {
|
||||
in.AddLine()
|
||||
}
|
||||
in.CurrentLine = in.CurrentLine.Push(button)
|
||||
@@ -230,7 +285,7 @@ func (in *InlineKeyboard) AddURLButtonStyle(text string, style tgapi.KeyboardBut
|
||||
func (in *InlineKeyboard) AddCallbackButton(text, cmd string, args ...any) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{
|
||||
Text: text,
|
||||
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||
CallbackData: NewCallbackData(cmd, args...).encode(in.payloadType),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -240,7 +295,7 @@ func (in *InlineKeyboard) AddCallbackButtonStyle(text string, style tgapi.Keyboa
|
||||
return in.append(tgapi.InlineKeyboardButton{
|
||||
Text: text,
|
||||
Style: style,
|
||||
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||
CallbackData: NewCallbackData(cmd, args...).encode(in.payloadType),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -265,11 +320,62 @@ func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
||||
// Automatically flushes the current line if not empty.
|
||||
//
|
||||
// Returns a pointer to a ReplyMarkup suitable for use with tgapi.SendMessage.
|
||||
func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
func (in *InlineKeyboard) Get() (*tgapi.ReplyMarkup, error) {
|
||||
if in.CurrentLine.Len() > 0 {
|
||||
in.AddLine()
|
||||
}
|
||||
return &tgapi.ReplyMarkup{InlineKeyboard: in.Lines}
|
||||
lines := make([][]tgapi.InlineKeyboardButton, len(in.Lines))
|
||||
for i := range in.Lines {
|
||||
lines[i] = append([]tgapi.InlineKeyboardButton(nil), in.Lines[i]...)
|
||||
}
|
||||
markup := &tgapi.ReplyMarkup{InlineKeyboard: lines}
|
||||
if err := in.validate(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return markup, nil
|
||||
}
|
||||
|
||||
func (in *InlineKeyboard) validate() error {
|
||||
if !in.unlimitedRows && in.maxRow <= 0 {
|
||||
return fmt.Errorf("%w: got %d", ErrInlineKeyboardMaxRow, in.maxRow)
|
||||
}
|
||||
for rowIndex, row := range in.Lines {
|
||||
if !in.unlimitedRows && 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 := validateButton(button); err != nil {
|
||||
return fmt.Errorf("row %d button %d: %w", rowIndex, columnIndex, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateButton(b tgapi.InlineKeyboardButton) error {
|
||||
actions := 0
|
||||
if b.URL != "" {
|
||||
actions++
|
||||
}
|
||||
if b.CallbackData != "" {
|
||||
actions++
|
||||
}
|
||||
if b.Disabled != nil {
|
||||
actions++
|
||||
}
|
||||
if actions != 1 {
|
||||
return ErrInlineKeyboardButtonAction
|
||||
}
|
||||
if b.CallbackData != "" {
|
||||
length := len([]byte(b.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
|
||||
@@ -282,8 +388,10 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
//
|
||||
// {"cmd":"delete_user","args":["123","confirm"]}
|
||||
type CallbackData struct {
|
||||
Command string `json:"cmd"` // The command name to route to
|
||||
Args []string `json:"args"` // Arguments passed as strings
|
||||
// Command is the command name used for payload routing.
|
||||
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.
|
||||
@@ -297,10 +405,7 @@ func NewCallbackData(command string, args ...any) CallbackData {
|
||||
for i, arg := range args {
|
||||
stringArgs[i] = fmt.Sprint(arg)
|
||||
}
|
||||
return CallbackData{
|
||||
Command: command,
|
||||
Args: stringArgs,
|
||||
}
|
||||
return CallbackData{Command: command, Args: stringArgs}
|
||||
}
|
||||
|
||||
// All To* encoders return an empty string when serialization fails. Telegram
|
||||
@@ -353,10 +458,7 @@ func (d CallbackData) ToCompactBase64() string {
|
||||
return data
|
||||
}
|
||||
|
||||
// Encode serializes the CallbackData according to the specified payload type.
|
||||
// Supported types: BotPayloadJSON, BotPayloadBase64, BotPayloadCompact, and BotPayloadCompactBase64.
|
||||
// For unknown types, returns an empty string.
|
||||
func (d CallbackData) Encode(t BotPayloadType) string {
|
||||
func (d CallbackData) encode(t BotPayloadType) string {
|
||||
switch t {
|
||||
case BotPayloadBase64:
|
||||
return d.ToBase64()
|
||||
@@ -369,3 +471,20 @@ func (d CallbackData) Encode(t BotPayloadType) string {
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// Encode serializes the CallbackData according to the specified payload type.
|
||||
// Supported types: BotPayloadJSON, BotPayloadBase64, BotPayloadCompact, and BotPayloadCompactBase64.
|
||||
// For unknown types, returns an empty string.
|
||||
func (d CallbackData) Encode(t BotPayloadType) (string, error) {
|
||||
if t != BotPayloadBase64 && t != BotPayloadJSON && t != BotPayloadCompact && t != BotPayloadCompactBase64 {
|
||||
return "", ErrInvalidPayloadType
|
||||
}
|
||||
encoded := d.encode(t)
|
||||
if encoded == "" {
|
||||
return "", ErrCallbackDataLength
|
||||
}
|
||||
if length := len([]byte(encoded)); length > 64 {
|
||||
return "", fmt.Errorf("%w: got %d", ErrCallbackDataLength, length)
|
||||
}
|
||||
return encoded, nil
|
||||
}
|
||||
|
||||
+184
-10
@@ -13,7 +13,10 @@ func TestInlineKeyboardWrapsRowsAndEncodesJSONPayloads(t *testing.T) {
|
||||
AddCallbackButton("B", "cmd", 2).
|
||||
AddCallbackButton("C", "cmd", 3)
|
||||
|
||||
markup := kb.Get()
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("keyboard encoding error: %s", err)
|
||||
}
|
||||
if got := len(markup.InlineKeyboard); got != 2 {
|
||||
t.Fatalf("unexpected row count: %d", got)
|
||||
}
|
||||
@@ -36,7 +39,11 @@ func TestInlineKeyboardBuilderPreservesConfiguredButtonFields(t *testing.T) {
|
||||
SetURL("https://example.test"),
|
||||
)
|
||||
|
||||
button := kb.Get().InlineKeyboard[0][0]
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
button := markup.InlineKeyboard[0][0]
|
||||
if button.Style != ButtonStylePrimary {
|
||||
t.Fatalf("unexpected style: %q", button.Style)
|
||||
}
|
||||
@@ -49,7 +56,11 @@ func TestInlineKeyboardButtonBuilderSetCallbackDataDefaultsToJSON(t *testing.T)
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
AddButton(NewInlineKeyboardButton("A").SetCallbackData("cmd", 1, "two"))
|
||||
|
||||
button := kb.Get().InlineKeyboard[0][0]
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
button := markup.InlineKeyboard[0][0]
|
||||
if !strings.Contains(button.CallbackData, `"cmd":"cmd"`) {
|
||||
t.Fatalf("expected JSON callback payload, got %q", button.CallbackData)
|
||||
}
|
||||
@@ -62,7 +73,12 @@ func TestInlineKeyboardButtonBuilderSetCallbackDataUsesConfiguredPayloadType(t *
|
||||
SetCallbackData("cmd", 1, "two"),
|
||||
)
|
||||
|
||||
got, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
button := markup.InlineKeyboard[0][0]
|
||||
got, _, err := decodePayload(BotPayloadJSON, button.CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -73,6 +89,41 @@ func TestInlineKeyboardButtonBuilderSetCallbackDataUsesConfiguredPayloadType(t *
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardButtonBuilderKeepsExactlyOneAction(t *testing.T) {
|
||||
callback := NewInlineKeyboardButton("Action").
|
||||
SetURL("https://example.test").
|
||||
SetCallbackDataJSON("confirm").
|
||||
build()
|
||||
if callback.URL != "" || callback.CallbackData == "" {
|
||||
t.Fatalf("callback action was not exclusive: %#v", callback)
|
||||
}
|
||||
|
||||
link := NewInlineKeyboardButton("Action").
|
||||
SetCallbackDataJSON("confirm").
|
||||
SetURL("https://example.test").
|
||||
build()
|
||||
if link.URL == "" || link.CallbackData != "" {
|
||||
t.Fatalf("URL action was not exclusive: %#v", link)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardGetReturnsIndependentMarkup(t *testing.T) {
|
||||
keyboard := NewInlineKeyboardJSON(1).AddURLButton("Docs", "https://example.test")
|
||||
first, err := keyboard.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
first.InlineKeyboard[0][0].Text = "mutated"
|
||||
|
||||
second, err := keyboard.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
if got := second.InlineKeyboard[0][0].Text; got != "Docs" {
|
||||
t.Fatalf("Get exposed builder state for mutation: got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardGetPayloadTypeReturnsLocalOverride(t *testing.T) {
|
||||
kb := NewInlineKeyboardJSON(2)
|
||||
if got := kb.GetPayloadType(); got != BotPayloadJSON {
|
||||
@@ -88,7 +139,11 @@ func TestDecodePayloadAcceptsBase64KeyboardPayloadWhenBotPrefersJSON(t *testing.
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
got, _, err := decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -103,7 +158,11 @@ func TestDecodePayloadAcceptsJSONKeyboardPayloadWhenBotPrefersBase64(t *testing.
|
||||
kb := NewInlineKeyboardJSON(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, _, err := decodePayload(BotPayloadBase64, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
got, _, err := decodePayload(BotPayloadBase64, markup.InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -118,7 +177,11 @@ func TestDecodePayloadAcceptsCompactKeyboardPayloadWhenBotPrefersJSON(t *testing
|
||||
kb := NewInlineKeyboardCompact(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -136,7 +199,11 @@ func TestDecodePayloadAcceptsCompactBase64KeyboardPayloadWhenBotPrefersJSON(t *t
|
||||
kb := NewInlineKeyboardCompactBase64(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -208,7 +275,11 @@ func TestDecodePayloadStrictRejectsCompactMismatchedType(t *testing.T) {
|
||||
kb := NewInlineKeyboardCompact(1).
|
||||
AddCallbackButton("A", "cmd", 1)
|
||||
|
||||
_, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, true)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
_, _, err = decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, true)
|
||||
if !errors.Is(err, ErrPayloadTypeMismatch) {
|
||||
t.Fatalf("expected ErrPayloadTypeMismatch, got %v", err)
|
||||
}
|
||||
@@ -218,8 +289,111 @@ func TestDecodePayloadStrictRejectsMismatchedType(t *testing.T) {
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
AddCallbackButton("A", "cmd", 1)
|
||||
|
||||
_, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, true)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
_, _, err = decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, true)
|
||||
if !errors.Is(err, ErrPayloadTypeMismatch) {
|
||||
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.Get(); !errors.Is(err, ErrCallbackDataLength) {
|
||||
t.Fatalf("expected validated keyboard to reject callback data, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCallbackDataEncodeBoundaries(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}).Encode(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"}).Encode(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, err := keyboard.Get()
|
||||
if !errors.Is(err, ErrInlineKeyboardRowTooLong) || markup != nil {
|
||||
t.Fatalf("expected strict validation failure for the existing oversized row: %v", err)
|
||||
}
|
||||
if len(keyboard.Lines) != 2 || len(keyboard.Lines[0]) != 2 || len(keyboard.Lines[1]) != 1 {
|
||||
t.Fatalf("lowered maxRow stopped automatic wrapping: %#v", keyboard.Lines)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardUnlimitedRowsMustBeExplicit(t *testing.T) {
|
||||
for _, maxRow := range []int{0, -1} {
|
||||
keyboard := NewInlineKeyboardJSON(maxRow).AddURLButton("A", "https://example.test/a")
|
||||
if markup, err := keyboard.Get(); !errors.Is(err, ErrInlineKeyboardMaxRow) || markup != nil {
|
||||
t.Fatalf("expected invalid row limit %d, markup=%#v err=%v", maxRow, markup, err)
|
||||
}
|
||||
}
|
||||
|
||||
keyboard := NewInlineKeyboardJSON(1).
|
||||
SetUnlimitedRows().
|
||||
AddURLButton("A", "https://example.test/a").
|
||||
AddURLButton("B", "https://example.test/b")
|
||||
markup, err := keyboard.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("explicit unlimited rows failed: %v", err)
|
||||
}
|
||||
if len(markup.InlineKeyboard) != 1 || len(markup.InlineKeyboard[0]) != 2 {
|
||||
t.Fatalf("unexpected unlimited keyboard: %#v", markup.InlineKeyboard)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardDisabledButton(t *testing.T) {
|
||||
button, err := NewInlineKeyboardButton("Unavailable").SetDisabled().Build()
|
||||
if err != nil {
|
||||
t.Fatalf("Build returned error: %v", err)
|
||||
}
|
||||
if button.Disabled == nil || button.URL != "" || button.CallbackData != "" {
|
||||
t.Fatalf("unexpected disabled button: %#v", button)
|
||||
}
|
||||
|
||||
button, err = NewInlineKeyboardButton("Open").SetDisabled().SetURL("https://example.test").Build()
|
||||
if err != nil {
|
||||
t.Fatalf("SetURL didn't replace disabled action: %v", err)
|
||||
}
|
||||
if button.Disabled != nil || button.URL == "" {
|
||||
t.Fatalf("unexpected URL button: %#v", button)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
package laniakea
|
||||
|
||||
import "sync"
|
||||
import (
|
||||
"maps"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// DictEntry maps language codes to translated strings.
|
||||
type DictEntry map[string]string
|
||||
@@ -64,8 +67,6 @@ func cloneDictEntry(src DictEntry) DictEntry {
|
||||
return nil
|
||||
}
|
||||
cloned := make(DictEntry, len(src))
|
||||
for lang, text := range src {
|
||||
cloned[lang] = text
|
||||
}
|
||||
maps.Copy(cloned, src)
|
||||
return cloned
|
||||
}
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"iter"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
// Updates fetches new updates from Telegram API using long polling.
|
||||
|
||||
+1
-1
@@ -7,7 +7,7 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
func TestUpdatesIterYieldsFetchError(t *testing.T) {
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestV2MigrationSurfaceCompiles(t *testing.T) {
|
||||
runner := NewRunner[NoData]("sync", func(ctx context.Context, bot *Bot[NoData]) error {
|
||||
return ctx.Err()
|
||||
})
|
||||
if runner.name != "sync" {
|
||||
t.Fatalf("unexpected runner: %+v", runner)
|
||||
}
|
||||
|
||||
if _, err := NewCallbackData("open", 42).Encode(BotPayloadCompact); err != nil {
|
||||
t.Fatalf("Encode returned error: %v", err)
|
||||
}
|
||||
|
||||
keyboard := NewInlineKeyboardJSON(2).AddCallbackButton("Open", "open", 42)
|
||||
if _, err := keyboard.Get(); err != nil {
|
||||
t.Fatalf("Get returned error: %v", err)
|
||||
}
|
||||
|
||||
unlimited := NewInlineKeyboardJSON(1).
|
||||
SetUnlimitedRows().
|
||||
AddURLButton("A", "https://example.test/a").
|
||||
AddURLButton("B", "https://example.test/b")
|
||||
if _, err := unlimited.Get(); err != nil {
|
||||
t.Fatalf("explicit unlimited keyboard failed: %v", err)
|
||||
}
|
||||
}
|
||||
+243
-56
@@ -8,9 +8,9 @@ import (
|
||||
"reflect"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgrich"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -31,7 +31,9 @@ import (
|
||||
// reply helpers need Msg, while inline callback edit helpers can work through
|
||||
// InlineMsgID when there is no chat message.
|
||||
type MessageContext struct {
|
||||
API *tgapi.API
|
||||
// API is the Telegram API client used by context helpers.
|
||||
API *tgapi.API
|
||||
// Update is the Telegram update being handled.
|
||||
Update tgapi.Update
|
||||
|
||||
// Msg is the normalized Telegram message for message-backed update kinds.
|
||||
@@ -81,42 +83,64 @@ type MessageContext struct {
|
||||
payloadType BotPayloadType
|
||||
sceneRuntime sceneRuntime
|
||||
observer Observer
|
||||
eventEmitter func(context.Context, Event)
|
||||
asyncTask func(func())
|
||||
botID int64
|
||||
|
||||
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 {
|
||||
markup, err := keyboard.Get()
|
||||
if err != nil {
|
||||
return params, fmt.Errorf("keyboard get error: %w", err)
|
||||
}
|
||||
params.ReplyMarkup = markup
|
||||
}
|
||||
return params, nil
|
||||
}
|
||||
|
||||
// AnswerMessage represents a message sent or edited via MessageContext.
|
||||
// It holds metadata to allow further editing or deletion.
|
||||
type AnswerMessage struct {
|
||||
// MessageID identifies the sent Telegram message.
|
||||
MessageID int
|
||||
Text string
|
||||
IsMedia bool
|
||||
ctx *MessageContext // internal back-reference
|
||||
// Text contains the text or caption sent with the message.
|
||||
// For rich messages, it contains rendered HTML for v1 compatibility.
|
||||
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
|
||||
ctx *MessageContext // internal back-reference
|
||||
}
|
||||
|
||||
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 {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params := tgapi.EditMessageText{
|
||||
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()
|
||||
}
|
||||
params.Text = text
|
||||
msg, _, err := ctx.API.EditMessageTextWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
@@ -187,9 +211,10 @@ func (ctx *MessageContext) editPhotoText(messageID int, text string, kb *InlineK
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
switch {
|
||||
case messageID > 0 && ctx.Msg != nil:
|
||||
case messageID > 0 && ctx.Msg != nil && ctx.Msg.Chat != nil:
|
||||
params.ChatID = ctx.Msg.Chat.ID
|
||||
params.MessageID = messageID
|
||||
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||
case ctx.InlineMsgID != "":
|
||||
params.InlineMessageID = ctx.InlineMsgID
|
||||
default:
|
||||
@@ -197,7 +222,12 @@ func (ctx *MessageContext) editPhotoText(messageID int, text string, kb *InlineK
|
||||
return nil
|
||||
}
|
||||
if kb != nil {
|
||||
params.ReplyMarkup = kb.Get()
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.ReplyMarkup = markup
|
||||
}
|
||||
|
||||
msg, _, err := ctx.API.EditMessageCaptionWithContext(ctx.Context(), params)
|
||||
@@ -239,7 +269,7 @@ func (m *AnswerMessage) EditCaptionKeyboardMarkdown(text string, kb *InlineKeybo
|
||||
}
|
||||
|
||||
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)
|
||||
return nil
|
||||
}
|
||||
@@ -248,12 +278,18 @@ func (ctx *MessageContext) answer(text string, keyboard *InlineKeyboard, parseMo
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendMessage{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: parseMode,
|
||||
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
markup, err := keyboard.Get()
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.ReplyMarkup = markup
|
||||
}
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||
@@ -333,7 +369,7 @@ func (ctx *MessageContext) answerLong(text string, keyboard *InlineKeyboard, par
|
||||
ctx.Logger.Errorln(ErrMessageSplitImpossible)
|
||||
return nil
|
||||
}
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
@@ -368,7 +404,7 @@ func (ctx *MessageContext) answerLong(text string, keyboard *InlineKeyboard, par
|
||||
}
|
||||
|
||||
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)
|
||||
return nil
|
||||
}
|
||||
@@ -377,13 +413,19 @@ func (ctx *MessageContext) answerPhoto(photoID, text string, kb *InlineKeyboard,
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendPhoto{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Caption: text,
|
||||
ParseMode: parseMode,
|
||||
Photo: photoID,
|
||||
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Caption: text,
|
||||
ParseMode: parseMode,
|
||||
Photo: photoID,
|
||||
}
|
||||
if kb != nil {
|
||||
params.ReplyMarkup = kb.Get()
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.ReplyMarkup = markup
|
||||
}
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||
@@ -443,7 +485,7 @@ func (ctx *MessageContext) delete(messageID int) {
|
||||
ctx.Logger.Errorln(ErrMessageIDZero)
|
||||
return
|
||||
}
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return
|
||||
}
|
||||
@@ -495,12 +537,14 @@ func (ctx *MessageContext) AnswerCallbackURL(u string) { ctx.answerCallbackQuery
|
||||
|
||||
// SendAction sends a chat action (typing, uploading_photo, etc.) to indicate bot activity.
|
||||
func (ctx *MessageContext) SendAction(action tgapi.ChatActionType) {
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return
|
||||
}
|
||||
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 {
|
||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||
@@ -537,7 +581,7 @@ func (ctx *MessageContext) error(err error) {
|
||||
func (ctx *MessageContext) Error(err error) { ctx.error(err) }
|
||||
|
||||
func (ctx *MessageContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
@@ -550,28 +594,19 @@ func (ctx *MessageContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
return nil
|
||||
}
|
||||
|
||||
if ctx.API.Limiter != nil {
|
||||
c, cancel := context.WithTimeout(ctx.Context(), 5*time.Second)
|
||||
defer cancel()
|
||||
if err := ctx.API.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
draft := ctx.draftProvider.NewDraft(parseMode).SetChat(ctx.Msg.Chat.ID, ctx.Msg.MessageThreadID)
|
||||
return draft
|
||||
}
|
||||
|
||||
// NewDraft creates a new message draft associated with the current chat.
|
||||
// Uses the API limiter to avoid rate limiting.
|
||||
// Draft sends are rate-limited by the API client.
|
||||
func (ctx *MessageContext) NewDraft() *Draft {
|
||||
return ctx.newDraft(tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// NewDraftMarkdown creates a new message draft associated with the current chat,
|
||||
// with Markdown V2 parse mode enabled.
|
||||
// Uses the API limiter to avoid rate limiting.
|
||||
// Draft sends are rate-limited by the API client.
|
||||
func (ctx *MessageContext) NewDraftMarkdown() *Draft {
|
||||
return ctx.newDraft(tgapi.ParseMarkdownV2)
|
||||
}
|
||||
@@ -640,19 +675,19 @@ func bindPositional(args []string, dst any) error {
|
||||
case reflect.String:
|
||||
field.SetString(raw)
|
||||
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 {
|
||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||
}
|
||||
field.SetInt(n)
|
||||
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 {
|
||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||
}
|
||||
field.SetUint(n)
|
||||
case reflect.Float32, reflect.Float64:
|
||||
f, err := strconv.ParseFloat(raw, 64)
|
||||
f, err := strconv.ParseFloat(raw, field.Type().Bits())
|
||||
if err != nil {
|
||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||
}
|
||||
@@ -695,7 +730,14 @@ func (ctx *MessageContext) Context() context.Context {
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
defer func() {
|
||||
@@ -821,3 +863,148 @@ func (ctx *MessageContext) UpsertKeyboard(text string, keyboard *InlineKeyboard)
|
||||
func (ctx *MessageContext) UpsertKeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.upsertKeyboard(text, keyboard, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendRichMessage{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
RichMessage: rich,
|
||||
}
|
||||
if keyboard != nil {
|
||||
markup, err := keyboard.Get()
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.ReplyMarkup = markup
|
||||
}
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = int64(ctx.Msg.MessageThreadID)
|
||||
}
|
||||
if ctx.Msg.DirectMessageTopic != nil {
|
||||
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||
}
|
||||
if ctx.Msg.BusinessConnectionID != "" {
|
||||
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||
}
|
||||
|
||||
msg, err := ctx.API.SendRichMessageWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
return &AnswerMessage{
|
||||
MessageID: msg.MessageID,
|
||||
Text: rich.HTML,
|
||||
RichHTML: rich.HTML,
|
||||
IsMedia: false,
|
||||
ctx: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) richBlocksAnswer(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
rich, err := tgrich.BuildHTML(blocks...)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
return ctx.richAnswer(rich, keyboard)
|
||||
}
|
||||
|
||||
// RichAnswer builds and sends input rich-message blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) RichAnswer(blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return ctx.richBlocksAnswer(nil, blocks...)
|
||||
}
|
||||
|
||||
// RichAnswerKeyboard builds and sends input rich-message blocks with an inline keyboard.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) RichAnswerKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
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...)
|
||||
}
|
||||
|
||||
+373
-2
@@ -9,10 +9,354 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgrich"
|
||||
"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) {
|
||||
var gotBody map[string]any
|
||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
body, err := io.ReadAll(req.Body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":9,"date":1}}`)),
|
||||
}, nil
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{
|
||||
BusinessConnectionID: "business-1",
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
answer := ctx.RichAnswer(tgrich.P(tgrich.Bold(tgrich.Text("ready"))))
|
||||
if answer == nil {
|
||||
t.Fatal("RichAnswer() returned nil")
|
||||
}
|
||||
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||
if !ok || rich["html"] != "<p><b>ready</b></p>" {
|
||||
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||
}
|
||||
if _, exists := rich["skip_entity_detection"]; exists {
|
||||
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) {
|
||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
t.Fatal("unexpected HTTP request")
|
||||
return nil, nil
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if answer := ctx.RichAnswer(tgrich.H(tgrich.Text("invalid"), 0)); answer != nil {
|
||||
t.Fatal("RichAnswer() returned an answer for an invalid heading")
|
||||
}
|
||||
}
|
||||
|
||||
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) {
|
||||
var gotBody map[string]any
|
||||
|
||||
@@ -98,7 +442,11 @@ func TestNewInlineKeyboardButtonUsesContextPayloadType(t *testing.T) {
|
||||
kb := NewInlineKeyboardJSON(1).
|
||||
AddButton(ctx.NewInlineKeyboardButton("A").SetCallbackData("cmd", 1, "two"))
|
||||
|
||||
got, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
markup, err := kb.Get()
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected err: %v", err)
|
||||
}
|
||||
got, _, err := decodePayload(BotPayloadJSON, markup.InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -167,6 +515,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) {
|
||||
type input struct {
|
||||
Tags []string
|
||||
|
||||
+14
-5
@@ -1,10 +1,12 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MessageContext) bool {
|
||||
@@ -21,8 +23,9 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MessageContext) bool
|
||||
|
||||
if strings.Contains(cmd, "@") {
|
||||
botUsername := bot.username
|
||||
if botUsername != "" && strings.HasSuffix(cmd, "@"+botUsername) {
|
||||
cmd = cmd[:len(cmd)-len("@"+botUsername)] // remove @botname
|
||||
at := strings.LastIndexByte(cmd, '@')
|
||||
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)
|
||||
if errors.Is(err, errMiddlewareBlocked) {
|
||||
err = nil
|
||||
}
|
||||
handlerEndEvent := HandlerFinishedEvent{
|
||||
UpdateID: update.UpdateID,
|
||||
UpdateType: update.Type,
|
||||
@@ -125,7 +131,7 @@ func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MessageContext) boo
|
||||
FromID: pluginCtx.FromID,
|
||||
ChatID: pluginCtx.ChatID,
|
||||
})
|
||||
err := plugin.messageFallback(pluginCtx, bot.appData)
|
||||
err := callCommandExecutor(plugin.messageFallback, pluginCtx, bot.appData)
|
||||
endEvent := HandlerFinishedEvent{
|
||||
UpdateID: update.UpdateID,
|
||||
UpdateType: update.Type,
|
||||
@@ -227,6 +233,9 @@ func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MessageContext) boo
|
||||
ChatID: ctx.ChatID,
|
||||
})
|
||||
err := plugin.executePayload(data.Command, ctx, bot.appData)
|
||||
if errors.Is(err, errMiddlewareBlocked) {
|
||||
err = nil
|
||||
}
|
||||
|
||||
endEvent := HandlerFinishedEvent{
|
||||
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) {
|
||||
if prefix, hasPrefix := bot.checkPrefixes(text); hasPrefix {
|
||||
text = strings.TrimSpace(text[len(prefix):])
|
||||
spaceIndex := strings.Index(text, " ")
|
||||
spaceIndex := strings.IndexFunc(text, unicode.IsSpace)
|
||||
var cmd string
|
||||
var args string
|
||||
if spaceIndex == -1 {
|
||||
|
||||
+152
-52
@@ -5,7 +5,7 @@ import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
// HandlerEventKind identifies the kind of handler observed by runtime events.
|
||||
@@ -16,6 +16,8 @@ const (
|
||||
HandlerCommandKind HandlerEventKind = "command"
|
||||
// HandlerMessageKind identifies a message fallback handler.
|
||||
HandlerMessageKind HandlerEventKind = "message"
|
||||
// HandlerMiddlewareKind identifies middleware execution.
|
||||
HandlerMiddlewareKind HandlerEventKind = "middleware"
|
||||
// HandlerPayloadKind identifies a callback payload handler.
|
||||
HandlerPayloadKind HandlerEventKind = "payload"
|
||||
// HandlerUpdateKind identifies a generic update handler.
|
||||
@@ -41,96 +43,174 @@ type Event interface {
|
||||
isEvent()
|
||||
}
|
||||
|
||||
func emitContextError(ctx *MessageContext, event ErrorEvent) {
|
||||
if ctx == nil {
|
||||
return
|
||||
}
|
||||
if ctx.Logger != nil {
|
||||
ctx.Logger.Errorln(event.Err)
|
||||
}
|
||||
if ctx.eventEmitter != nil {
|
||||
ctx.eventEmitter(ctx.Context(), event)
|
||||
return
|
||||
}
|
||||
if ctx.observer == nil {
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil && ctx.Logger != nil {
|
||||
ctx.Logger.Errorln(fmt.Sprintf("panic in observer: %v", recovered))
|
||||
}
|
||||
}()
|
||||
ctx.observer.OnError(ctx.Context(), event)
|
||||
}
|
||||
|
||||
// UpdateReceivedEvent describes an update entering the bot runtime.
|
||||
type UpdateReceivedEvent struct {
|
||||
UpdateID int
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
FromID int64
|
||||
ChatID int64
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
}
|
||||
|
||||
// UpdateHandledEvent describes a completed update execution path.
|
||||
type UpdateHandledEvent struct {
|
||||
UpdateID int
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Duration time.Duration
|
||||
Handled bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Duration is the total framework handling time.
|
||||
Duration time.Duration
|
||||
// Handled reports whether a registered path handled the update.
|
||||
Handled bool
|
||||
}
|
||||
|
||||
// HandlerStartedEvent describes a handler about to execute.
|
||||
type HandlerStartedEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the plugin that owns the handler.
|
||||
Plugin string
|
||||
// HandlerKind classifies the handler.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the handler within its plugin and kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
}
|
||||
|
||||
// HandlerFinishedEvent describes a handler that has completed.
|
||||
type HandlerFinishedEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the plugin that owns the handler.
|
||||
Plugin string
|
||||
// HandlerKind classifies the handler.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the handler within its plugin and kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Duration time.Duration
|
||||
Err error
|
||||
UserFacing bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Duration is the handler execution time.
|
||||
Duration time.Duration
|
||||
// Err is the error returned or recovered from the handler.
|
||||
Err error
|
||||
// UserFacing reports whether Err is safe to show to the user.
|
||||
UserFacing bool
|
||||
}
|
||||
|
||||
// SceneTransitionEvent describes a scene state transition.
|
||||
type SceneTransitionEvent struct {
|
||||
// Plugin names the plugin that owns the scene.
|
||||
Plugin string
|
||||
Scene string
|
||||
From string
|
||||
To string
|
||||
// Scene names the transitioning scene.
|
||||
Scene string
|
||||
// From is the previous scene step.
|
||||
From string
|
||||
// To is the resulting scene step.
|
||||
To string
|
||||
// Action identifies the requested state transition.
|
||||
Action SceneAction
|
||||
// FromID identifies the session user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the session chat when available.
|
||||
ChatID int64
|
||||
}
|
||||
|
||||
// PolicyCheckedEvent describes the result of a policy evaluation.
|
||||
type PolicyCheckedEvent struct {
|
||||
Name string
|
||||
Plugin string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Passed bool
|
||||
Err error
|
||||
// Name identifies the evaluated policy.
|
||||
Name string
|
||||
// Plugin names the plugin that requested the policy check.
|
||||
Plugin string
|
||||
// FromID identifies the evaluated user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the evaluated chat when available.
|
||||
ChatID int64
|
||||
// Passed reports whether the policy accepted the context.
|
||||
Passed bool
|
||||
// Err is the policy evaluation error, if any.
|
||||
Err error
|
||||
// Internal reports whether evaluation failed internally rather than denying access.
|
||||
Internal bool
|
||||
}
|
||||
|
||||
// RunnerFinishedEvent describes a completed background runner execution.
|
||||
type RunnerFinishedEvent struct {
|
||||
Name string
|
||||
// Name identifies the runner.
|
||||
Name string
|
||||
// Duration is the callback execution time.
|
||||
Duration time.Duration
|
||||
Err error
|
||||
// Err is the callback error or recovered panic.
|
||||
Err error
|
||||
}
|
||||
|
||||
// PollingRetryEvent describes a polling retry after a failed getUpdates call.
|
||||
type PollingRetryEvent struct {
|
||||
// Attempt is the one-based retry number.
|
||||
Attempt int
|
||||
Delay time.Duration
|
||||
Err error
|
||||
// Delay is the time before the next polling attempt.
|
||||
Delay time.Duration
|
||||
// Err is the polling error that triggered the retry.
|
||||
Err error
|
||||
}
|
||||
|
||||
// ErrorEvent describes an error routed through framework error handling.
|
||||
type ErrorEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update when available.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind when available.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the component that reported the error.
|
||||
Plugin string
|
||||
// HandlerKind classifies the failing handler or runtime component.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the failing handler within its kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Err error
|
||||
UserFacing bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Err is the reported error.
|
||||
Err error
|
||||
// UserFacing reports whether Err is safe to show to the user.
|
||||
UserFacing bool
|
||||
}
|
||||
|
||||
func (UpdateReceivedEvent) isEvent() {}
|
||||
@@ -144,6 +224,12 @@ func (PollingRetryEvent) isEvent() {}
|
||||
func (ErrorEvent) isEvent() {}
|
||||
|
||||
// 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 {
|
||||
OnUpdateReceived(ctx context.Context, event UpdateReceivedEvent)
|
||||
OnUpdateHandled(ctx context.Context, event UpdateHandledEvent)
|
||||
@@ -160,29 +246,43 @@ func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) {
|
||||
if bot.observer == nil {
|
||||
return
|
||||
}
|
||||
if bot.observerAsync != nil {
|
||||
bot.observerAsync.enqueue(ctx, event)
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r))
|
||||
if bot.logger != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r))
|
||||
}
|
||||
}
|
||||
}()
|
||||
bot.emitEvent(ctx, 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) {
|
||||
case UpdateReceivedEvent:
|
||||
bot.observer.OnUpdateReceived(ctx, e)
|
||||
observer.OnUpdateReceived(ctx, e)
|
||||
case UpdateHandledEvent:
|
||||
bot.observer.OnUpdateHandled(ctx, e)
|
||||
observer.OnUpdateHandled(ctx, e)
|
||||
case HandlerStartedEvent:
|
||||
bot.observer.OnHandlerStarted(ctx, e)
|
||||
observer.OnHandlerStarted(ctx, e)
|
||||
case HandlerFinishedEvent:
|
||||
bot.observer.OnHandlerFinished(ctx, e)
|
||||
observer.OnHandlerFinished(ctx, e)
|
||||
case SceneTransitionEvent:
|
||||
bot.observer.OnSceneTransition(ctx, e)
|
||||
observer.OnSceneTransition(ctx, e)
|
||||
case PolicyCheckedEvent:
|
||||
bot.observer.OnPolicyChecked(ctx, e)
|
||||
observer.OnPolicyChecked(ctx, e)
|
||||
case RunnerFinishedEvent:
|
||||
bot.observer.OnRunnerFinished(ctx, e)
|
||||
observer.OnRunnerFinished(ctx, e)
|
||||
case PollingRetryEvent:
|
||||
bot.observer.OnPollingRetry(ctx, e)
|
||||
observer.OnPollingRetry(ctx, e)
|
||||
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)
|
||||
}
|
||||
}
|
||||
+88
-11
@@ -2,13 +2,16 @@ package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
"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),
|
||||
// with shared middleware and configuration.
|
||||
//
|
||||
@@ -53,6 +56,12 @@ func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||
}
|
||||
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 {
|
||||
p.logger.Warnf("command '%s' already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||
}
|
||||
@@ -77,6 +86,12 @@ func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
||||
}
|
||||
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 {
|
||||
p.logger.Warnf("payload '%s' is already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||
}
|
||||
@@ -152,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.
|
||||
// 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] {
|
||||
if handler == nil {
|
||||
if p.logger != nil {
|
||||
p.logger.Warnf("update handler '%s' has a nil executor; skipping", t)
|
||||
}
|
||||
return p
|
||||
}
|
||||
switch t {
|
||||
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost, tgapi.UpdateTypeCallbackQuery:
|
||||
if p.logger == nil {
|
||||
@@ -249,12 +270,12 @@ func (p *Plugin[T]) executeCmd(cmd string, ctx *MessageContext, db T) error {
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
return AsInternalError(errors.New("middleware blocked call"))
|
||||
return errMiddlewareBlocked
|
||||
}
|
||||
}
|
||||
|
||||
// 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 {
|
||||
@@ -270,12 +291,24 @@ func (p *Plugin[T]) executePayload(payload string, ctx *MessageContext, db T) er
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
return AsInternalError(errors.New("middleware blocked call"))
|
||||
return errMiddlewareBlocked
|
||||
}
|
||||
}
|
||||
|
||||
// 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 {
|
||||
@@ -292,6 +325,9 @@ func (p *Plugin[T]) executeMiddlewares(ctx *MessageContext, db T) bool {
|
||||
// If async, return value is ignored.
|
||||
type MiddlewareExecutor[T AppData] func(ctx *MessageContext, db T) bool
|
||||
|
||||
// ErrMiddlewareExecutorNil reports an attempt to execute middleware without a callback.
|
||||
var ErrMiddlewareExecutorNil = errors.New("middleware executor is nil")
|
||||
|
||||
// Middleware represents a reusable execution interceptor.
|
||||
// Can be synchronous (blocking) or asynchronous (non-blocking).
|
||||
type Middleware[T AppData] struct {
|
||||
@@ -306,7 +342,7 @@ func NewMiddleware[T AppData](name string, executor MiddlewareExecutor[T]) Middl
|
||||
return Middleware[T]{name, executor, 0, false}
|
||||
}
|
||||
|
||||
// SetOrder sets the execution order (currently ignored).
|
||||
// SetOrder sets the bot-level middleware execution order.
|
||||
func (m Middleware[T]) SetOrder(order int) Middleware[T] {
|
||||
m.order = order
|
||||
return m
|
||||
@@ -329,13 +365,54 @@ func (m Middleware[T]) SetAsync(async bool) Middleware[T] {
|
||||
// continue to share storage with the synchronous flow. Async middleware
|
||||
// must treat those fields as read-only — mutating them races the sync chain
|
||||
// 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 {
|
||||
if m.executor == nil {
|
||||
reportMiddlewareError(ctx, m.name, ErrMiddlewareExecutorNil)
|
||||
return false
|
||||
}
|
||||
if m.async {
|
||||
ctxCopy := *ctx
|
||||
go func(ctx MessageContext) {
|
||||
m.executor(&ctx, db)
|
||||
}(ctxCopy)
|
||||
task := func() {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
reportMiddlewareError(&ctxCopy, m.name, fmt.Errorf("%w in middleware %q: %v", ErrHandlerPanic, m.name, recovered))
|
||||
}
|
||||
}()
|
||||
m.executor(&ctxCopy, db)
|
||||
}
|
||||
if ctx.asyncTask != nil {
|
||||
ctx.asyncTask(task)
|
||||
} else {
|
||||
go task()
|
||||
}
|
||||
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) {
|
||||
event := ErrorEvent{
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerMiddlewareKind,
|
||||
HandlerName: name,
|
||||
Err: err,
|
||||
UserFacing: false,
|
||||
}
|
||||
if ctx != nil {
|
||||
event.UpdateID = ctx.Update.UpdateID
|
||||
event.UpdateType = ctx.Update.Type
|
||||
event.FromID = ctx.FromID
|
||||
event.ChatID = ctx.ChatID
|
||||
}
|
||||
emitContextError(ctx, event)
|
||||
}
|
||||
|
||||
+118
@@ -1,10 +1,117 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
type middlewareErrorObserver struct {
|
||||
testObserver
|
||||
errors chan ErrorEvent
|
||||
}
|
||||
|
||||
func (o *middlewareErrorObserver) OnError(_ context.Context, event ErrorEvent) {
|
||||
o.errors <- event
|
||||
}
|
||||
|
||||
func TestAsyncMiddlewareRecoversPanic(t *testing.T) {
|
||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||
ctx := &MessageContext{
|
||||
Update: tgapi.Update{UpdateID: 7, Type: tgapi.UpdateTypeMessage},
|
||||
FromID: 42,
|
||||
ChatID: 100,
|
||||
observer: observer,
|
||||
}
|
||||
middleware := NewMiddleware[NoData]("panic", func(ctx *MessageContext, db NoData) bool {
|
||||
panic("boom")
|
||||
}).SetAsync(true)
|
||||
|
||||
if !middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("async middleware blocked execution")
|
||||
}
|
||||
select {
|
||||
case event := <-observer.errors:
|
||||
if event.HandlerKind != HandlerMiddlewareKind || event.HandlerName != "panic" {
|
||||
t.Fatalf("unexpected error event: %#v", event)
|
||||
}
|
||||
if event.Err == nil {
|
||||
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):
|
||||
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) {
|
||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||
ctx := &MessageContext{observer: observer}
|
||||
middleware := NewMiddleware[NoData]("nil", nil)
|
||||
|
||||
if middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("nil middleware executor was accepted")
|
||||
}
|
||||
event := <-observer.errors
|
||||
if !errors.Is(event.Err, ErrMiddlewareExecutorNil) {
|
||||
t.Fatalf("error = %v, want ErrMiddlewareExecutorNil", event.Err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateArgsRequiresFullMatch(t *testing.T) {
|
||||
intCmd := NewCommand("int", func(ctx *MessageContext, db NoData) error { return nil }, NewCommandArg("n").SetValueType(CommandValueInt).SetRequired())
|
||||
if err := intCmd.validateArgs([]string{"123"}); err != nil {
|
||||
@@ -116,3 +223,14 @@ func TestPluginCommandGroupRegistersBuiltCommands(t *testing.T) {
|
||||
plugin.CommandGroup("ignored", 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))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
)
|
||||
|
||||
// Policy defines a reusable authorization rule for the current update context.
|
||||
@@ -143,7 +143,7 @@ func RequireChatAdmin[T AppData]() Policy[T] {
|
||||
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,
|
||||
UserID: ctx.FromID,
|
||||
})
|
||||
@@ -166,7 +166,7 @@ func RequireChatCreator[T AppData]() Policy[T] {
|
||||
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,
|
||||
UserID: ctx.FromID,
|
||||
})
|
||||
@@ -192,7 +192,7 @@ func RequireBotAdmin[T AppData]() Policy[T] {
|
||||
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,
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
+38
-1
@@ -9,7 +9,7 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -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) {
|
||||
want := AsUserError(errors.New("blocked"))
|
||||
policy := AllPolicies(
|
||||
|
||||
+21
-14
@@ -2,12 +2,12 @@ package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// RunnerFn is the function type for a runner. It receives a pointer to
|
||||
// the Bot and returns an error if execution fails.
|
||||
type RunnerFn[T AppData] func(*Bot[T]) error
|
||||
// RunnerFn is a cancelable task executed by a Bot runtime.
|
||||
type RunnerFn[T AppData] func(context.Context, *Bot[T]) error
|
||||
|
||||
// Runner represents a configurable background or one-time task to be
|
||||
// executed by a Bot.
|
||||
@@ -34,12 +34,7 @@ type Runner[T AppData] struct {
|
||||
// to customize this. Do not call builder methods concurrently or after the
|
||||
// bot runtime has begun executing runners.
|
||||
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}
|
||||
}
|
||||
|
||||
// Async sets whether the runner executes synchronously or asynchronously.
|
||||
@@ -66,7 +61,7 @@ func (r Runner[T]) Every(timeout time.Duration) Runner[T] {
|
||||
// ExecRunners executes all runners registered on the Bot with context-based lifecycle management.
|
||||
//
|
||||
// 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=true: Runs in a loop with the configured interval until ctx.Done().
|
||||
// - every>0, async=false: Skipped with a warning (invalid configuration).
|
||||
@@ -84,12 +79,12 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
}
|
||||
|
||||
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)
|
||||
go func(r Runner[T]) {
|
||||
defer bot.runnerOnceWG.Done()
|
||||
startedAt := time.Now()
|
||||
err := r.fn(bot)
|
||||
err := executeRunnerWithContext(ctx, r, bot)
|
||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||
Name: r.name,
|
||||
Duration: time.Since(startedAt),
|
||||
@@ -109,7 +104,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
} else if runner.every == 0 && !runner.async {
|
||||
// One-time sync: block until done
|
||||
t := time.Now()
|
||||
err := runner.fn(bot)
|
||||
err := executeRunnerWithContext(ctx, runner, bot)
|
||||
elapsed := time.Since(t)
|
||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||
Name: runner.name,
|
||||
@@ -150,7 +145,7 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
return
|
||||
}
|
||||
startedAt := time.Now()
|
||||
err := r.fn(bot)
|
||||
err := executeRunnerWithContext(ctx, r, bot)
|
||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||
Name: r.name,
|
||||
Duration: time.Since(startedAt),
|
||||
@@ -171,3 +166,15 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func executeRunnerWithContext[T AppData](ctx context.Context, runner Runner[T], bot *Bot[T]) (err error) {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
err = fmt.Errorf("runner %q panicked: %v", runner.name, recovered)
|
||||
}
|
||||
}()
|
||||
if runner.fn == nil {
|
||||
return fmt.Errorf("runner %q has no function", runner.name)
|
||||
}
|
||||
return runner.fn(ctx, bot)
|
||||
}
|
||||
|
||||
+61
-3
@@ -19,7 +19,7 @@ func TestExecRunnersRunsOnceSyncRunner(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||
NewRunner("sync-once", func(context.Context, *Bot[NoData]) error {
|
||||
calls.Add(1)
|
||||
return nil
|
||||
}).Async(false),
|
||||
@@ -41,7 +41,7 @@ func TestExecRunnersStopsBackgroundRunnerOnCancel(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("background", func(*Bot[NoData]) error {
|
||||
NewRunner("background", func(context.Context, *Bot[NoData]) error {
|
||||
if calls.Add(1) == 1 {
|
||||
triggered <- struct{}{}
|
||||
}
|
||||
@@ -74,7 +74,7 @@ func TestExecRunnersEmitObserverEvents(t *testing.T) {
|
||||
logger: sneklog.NewLogger(),
|
||||
observer: observer,
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||
NewRunner("sync-once", func(context.Context, *Bot[NoData]) error {
|
||||
return wantErr
|
||||
}).Async(false),
|
||||
},
|
||||
@@ -95,3 +95,61 @@ func TestExecRunnersEmitObserverEvents(t *testing.T) {
|
||||
t.Fatalf("unexpected runner error event: %#v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecRunnersRecoversRunnerPanic(t *testing.T) {
|
||||
observer := &runnerObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
observer: observer,
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("panic", func(context.Context, *Bot[NoData]) error {
|
||||
panic("boom")
|
||||
}).Async(false),
|
||||
},
|
||||
}
|
||||
defer func() {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
bot.ExecRunners(context.Background())
|
||||
|
||||
if len(observer.runners) != 1 || observer.runners[0].Err == nil {
|
||||
t.Fatalf("expected recovered panic in runner event, got %#v", observer.runners)
|
||||
}
|
||||
if len(observer.errors) != 1 || observer.errors[0].Err == nil {
|
||||
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]{
|
||||
NewRunner("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")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"maps"
|
||||
"sync"
|
||||
)
|
||||
@@ -54,18 +56,27 @@ func (s *Scene[T]) setPluginName(name string) *Scene[T] {
|
||||
|
||||
// OnStep registers a handler for a named scene step.
|
||||
func (s *Scene[T]) OnStep(step string, handler SceneHandler[T]) *Scene[T] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
s.steps[step] = handler
|
||||
return s
|
||||
}
|
||||
|
||||
// OnCommand registers a command handler active while the scene is running.
|
||||
func (s *Scene[T]) OnCommand(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
s.commands[cmd] = handler
|
||||
return s
|
||||
}
|
||||
|
||||
// OnPayload registers a callback payload handler active while the scene is running.
|
||||
func (s *Scene[T]) OnPayload(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
s.payloads[cmd] = handler
|
||||
return s
|
||||
}
|
||||
@@ -81,7 +92,7 @@ func (s *Scene[T]) executeCommand(cmd string, ctx *SceneContext, db T) (SceneRes
|
||||
if !ok {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := handler(ctx, db)
|
||||
result, err := callSceneHandler(handler, ctx, db)
|
||||
return result, true, err
|
||||
}
|
||||
func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||
@@ -89,7 +100,7 @@ func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneRes
|
||||
if !ok {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := handler(ctx, db)
|
||||
result, err := callSceneHandler(handler, ctx, db)
|
||||
return result, true, err
|
||||
}
|
||||
func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||
@@ -97,17 +108,30 @@ func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResul
|
||||
if !ok {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := handler(ctx, db)
|
||||
result, err := callSceneHandler(handler, ctx, db)
|
||||
return result, true, err
|
||||
}
|
||||
func (s *Scene[T]) executeMessage(ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||
if s.message == nil {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := s.message(ctx, db)
|
||||
result, err := callSceneHandler(s.message, ctx, db)
|
||||
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] {
|
||||
if s == nil {
|
||||
return nil
|
||||
@@ -131,18 +155,17 @@ type SceneSession struct {
|
||||
Scene string
|
||||
// Step is the current step name inside the active scene.
|
||||
Step string
|
||||
// data stores opaque session payload bytes, typically JSON.
|
||||
data []byte
|
||||
}
|
||||
|
||||
// SetData stores arbitrary opaque session data.
|
||||
func (s *SceneSession) SetData(data []byte) {
|
||||
s.data = data
|
||||
s.data = bytes.Clone(data)
|
||||
}
|
||||
|
||||
// GetData returns the raw session data payload.
|
||||
func (s *SceneSession) GetData() []byte {
|
||||
return s.data
|
||||
return bytes.Clone(s.data)
|
||||
}
|
||||
|
||||
// HasData reports whether the session has a non-empty data payload.
|
||||
@@ -198,6 +221,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
if session, ok := s.store[key]; ok {
|
||||
session.data = bytes.Clone(session.data)
|
||||
return session, nil
|
||||
}
|
||||
return SceneSession{}, nil
|
||||
@@ -205,6 +229,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) {
|
||||
|
||||
// Set stores session under key.
|
||||
func (s *MemorySessionStore) Set(key string, session SceneSession) error {
|
||||
session.data = bytes.Clone(session.data)
|
||||
s.mu.Lock()
|
||||
s.store[key] = session
|
||||
s.mu.Unlock()
|
||||
@@ -221,8 +246,10 @@ func (s *MemorySessionStore) Delete(key string) error {
|
||||
|
||||
// SceneResult describes how scene execution should proceed after a handler returns.
|
||||
type SceneResult struct {
|
||||
// Action controls the scene state transition.
|
||||
Action SceneAction
|
||||
Next string
|
||||
// Next names the destination step for SceneActionNext.
|
||||
Next string
|
||||
}
|
||||
|
||||
// SceneAction controls how the bot updates scene state after a handler returns.
|
||||
|
||||
+41
-24
@@ -1,24 +1,37 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
func (bot *Bot[T]) tryHandleScene(ctx *MessageContext) (bool, error) {
|
||||
key, session, err := bot.findSceneSession(ctx)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrCantFindSession) {
|
||||
return false, nil
|
||||
for _, scope := range bot.sceneScopePriority {
|
||||
key, ok := buildSceneKey(scope, ctx)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
return false, err
|
||||
}
|
||||
if session.Scene == "" {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
unlock := bot.sceneLocks.lock([]string{key})
|
||||
session, err := bot.sessionStore.Get(key)
|
||||
if err != nil {
|
||||
unlock()
|
||||
return false, err
|
||||
}
|
||||
if session.Scene == "" {
|
||||
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 {
|
||||
scene, ok := plugin.scenes[session.Scene]
|
||||
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)
|
||||
if err != nil {
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||
return false, err
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||
}
|
||||
from := ctx.sess.Step
|
||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||
if err != nil {
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||
}
|
||||
if ok {
|
||||
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)
|
||||
if err != nil {
|
||||
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||
return false, err
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||
}
|
||||
from := ctx.sess.Step
|
||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||
if err != nil {
|
||||
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||
}
|
||||
if ok {
|
||||
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)
|
||||
if err != nil {
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, err)
|
||||
return false, err
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, err)
|
||||
}
|
||||
from := step
|
||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||
if err != nil {
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
||||
}
|
||||
if ok {
|
||||
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)
|
||||
if err != nil {
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||
return false, err
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||
}
|
||||
from := ctx.sess.Step
|
||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||
if err != nil {
|
||||
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||
}
|
||||
if ok {
|
||||
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{
|
||||
UpdateID: ctx.Update.UpdateID,
|
||||
UpdateType: ctx.Update.Type,
|
||||
@@ -211,6 +227,7 @@ func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind Handl
|
||||
Err: err,
|
||||
UserFacing: IsUserError(err),
|
||||
})
|
||||
return &reportedSceneError{err: err}
|
||||
}
|
||||
|
||||
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:
|
||||
return false, nil
|
||||
default:
|
||||
return false, nil
|
||||
return false, fmt.Errorf("%w: %v", ErrInvalidSceneAction, result.Action)
|
||||
}
|
||||
}
|
||||
func buildSceneKey(scope SceneScope, ctx *MessageContext) (string, bool) {
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"sync"
|
||||
)
|
||||
|
||||
type sceneLockEntry struct {
|
||||
mu sync.Mutex
|
||||
refs int
|
||||
}
|
||||
|
||||
type sceneKeyLocker struct {
|
||||
mu sync.Mutex
|
||||
entries map[string]*sceneLockEntry
|
||||
}
|
||||
|
||||
func (l *sceneKeyLocker) lock(keys []string) func() {
|
||||
keys = uniqueSortedStrings(keys)
|
||||
if len(keys) == 0 {
|
||||
return func() {}
|
||||
}
|
||||
|
||||
l.mu.Lock()
|
||||
if l.entries == nil {
|
||||
l.entries = make(map[string]*sceneLockEntry)
|
||||
}
|
||||
entries := make([]*sceneLockEntry, len(keys))
|
||||
for i, key := range keys {
|
||||
entry := l.entries[key]
|
||||
if entry == nil {
|
||||
entry = new(sceneLockEntry)
|
||||
l.entries[key] = entry
|
||||
}
|
||||
entry.refs++
|
||||
entries[i] = entry
|
||||
}
|
||||
l.mu.Unlock()
|
||||
|
||||
for _, entry := range entries {
|
||||
entry.mu.Lock()
|
||||
}
|
||||
|
||||
return func() {
|
||||
for i := len(entries) - 1; i >= 0; i-- {
|
||||
entries[i].mu.Unlock()
|
||||
}
|
||||
|
||||
l.mu.Lock()
|
||||
for i, key := range keys {
|
||||
entries[i].refs--
|
||||
if entries[i].refs == 0 {
|
||||
delete(l.entries, key)
|
||||
}
|
||||
}
|
||||
l.mu.Unlock()
|
||||
}
|
||||
}
|
||||
|
||||
func uniqueSortedStrings(values []string) []string {
|
||||
sort.Strings(values)
|
||||
result := values[:0]
|
||||
for _, value := range values {
|
||||
if value == "" || len(result) > 0 && result[len(result)-1] == value {
|
||||
continue
|
||||
}
|
||||
result = append(result, value)
|
||||
}
|
||||
return result
|
||||
}
|
||||
+162
-1
@@ -3,9 +3,12 @@ package laniakea
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -41,6 +44,114 @@ func TestPluginAddSceneRegistersScene(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotAddPluginsSkipsDuplicateSceneNames(t *testing.T) {
|
||||
first := NewPlugin[NoData]("first")
|
||||
first.Scene("shared")
|
||||
second := NewPlugin[NoData]("second")
|
||||
second.Scene("shared")
|
||||
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
bot.AddPlugins(first, second)
|
||||
|
||||
if _, ok := bot.plugins[0].scenes["shared"]; !ok {
|
||||
t.Fatal("first registered scene was removed")
|
||||
}
|
||||
if _, ok := bot.plugins[1].scenes["shared"]; ok {
|
||||
t.Fatal("duplicate scene was registered")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSceneUpdatesForSameSessionAreSerialized(t *testing.T) {
|
||||
entered := make(chan int, 2)
|
||||
releaseFirst := make(chan struct{})
|
||||
var calls atomic.Int64
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.Scene("counter").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
var value int
|
||||
if err := ctx.BindData(&value); err != nil {
|
||||
return SceneResult{}, err
|
||||
}
|
||||
call := int(calls.Add(1))
|
||||
entered <- call
|
||||
if call == 1 {
|
||||
<-releaseFirst
|
||||
}
|
||||
value++
|
||||
if err := ctx.SaveData(value); err != nil {
|
||||
return SceneResult{}, err
|
||||
}
|
||||
return ctx.Stay(), nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
key := "user_id:42:chat_id:100"
|
||||
session := SceneSession{Scene: "counter", Step: "start"}
|
||||
if err := session.SaveData(0); err != nil {
|
||||
t.Fatalf("SaveData returned error: %v", err)
|
||||
}
|
||||
if err := bot.sessionStore.Set(key, session); err != nil {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
|
||||
update := func(id int) *tgapi.Update {
|
||||
return &tgapi.Update{
|
||||
UpdateID: id,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: id,
|
||||
Text: "increment",
|
||||
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||
From: &tgapi.User{ID: 42},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(2)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
bot.handle(context.Background(), update(1))
|
||||
}()
|
||||
if got := <-entered; got != 1 {
|
||||
t.Fatalf("first handler call = %d, want 1", got)
|
||||
}
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
bot.handle(context.Background(), update(2))
|
||||
}()
|
||||
select {
|
||||
case call := <-entered:
|
||||
t.Fatalf("second handler entered before first completed: call %d", call)
|
||||
case <-time.After(50 * time.Millisecond):
|
||||
}
|
||||
close(releaseFirst)
|
||||
if got := <-entered; got != 2 {
|
||||
t.Fatalf("second handler call = %d, want 2", got)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
got, err := bot.sessionStore.Get(key)
|
||||
if err != nil {
|
||||
t.Fatalf("Get returned error: %v", err)
|
||||
}
|
||||
var value int
|
||||
if err := got.BindData(&value); err != nil {
|
||||
t.Fatalf("BindData returned error: %v", err)
|
||||
}
|
||||
if value != 2 {
|
||||
t.Fatalf("session value = %d, want 2", value)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||
called := false
|
||||
|
||||
@@ -836,6 +947,36 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemorySessionStoreDoesNotAliasSessionData(t *testing.T) {
|
||||
store := NewMemorySessionStore()
|
||||
input := []byte("initial")
|
||||
session := SceneSession{Scene: "signup"}
|
||||
session.SetData(input)
|
||||
|
||||
input[0] = 'X'
|
||||
if got := string(session.GetData()); got != "initial" {
|
||||
t.Fatalf("SetData retained caller slice: got %q", got)
|
||||
}
|
||||
if err := store.Set("user:1", session); err != nil {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
|
||||
first, err := store.Get("user:1")
|
||||
if err != nil {
|
||||
t.Fatalf("Get returned error: %v", err)
|
||||
}
|
||||
data := first.GetData()
|
||||
data[0] = 'X'
|
||||
|
||||
second, err := store.Get("user:1")
|
||||
if err != nil {
|
||||
t.Fatalf("second Get returned error: %v", err)
|
||||
}
|
||||
if got := string(second.GetData()); got != "initial" {
|
||||
t.Fatalf("Get exposed stored data for mutation: got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFindSceneSessionSupportsUserScopeWithoutMessage(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
@@ -896,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)
|
||||
}
|
||||
}
|
||||
|
||||
+72
-20
@@ -9,10 +9,16 @@ import (
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
"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.
|
||||
// Use the provided setter methods to build options — do not construct directly.
|
||||
type APIOpts struct {
|
||||
@@ -26,6 +32,7 @@ type APIOpts struct {
|
||||
|
||||
limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
maxRetries int
|
||||
}
|
||||
|
||||
// NewAPIOpts creates a new APIOpts with default values.
|
||||
@@ -36,6 +43,7 @@ func NewAPIOpts(token string) *APIOpts {
|
||||
client: nil,
|
||||
useTestServer: false,
|
||||
apiURL: "https://api.telegram.org",
|
||||
maxRetries: defaultMaxRetries,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -91,6 +99,16 @@ func (opts *APIOpts) SetDropRateLimitOverflow(b bool) *APIOpts {
|
||||
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.
|
||||
//
|
||||
// Use API methods when sending JSON payloads (for example with file_id, URL, or other
|
||||
@@ -107,9 +125,11 @@ type API struct {
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
|
||||
pool *workerPool
|
||||
pool *workerPool
|
||||
// Limiter is the optional rate limiter applied before requests are sent.
|
||||
Limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
maxRetries int
|
||||
}
|
||||
|
||||
// NewAPI creates a new API client from options.
|
||||
@@ -122,6 +142,7 @@ func NewAPI(opts *APIOpts) *API {
|
||||
"API", utils.GetLoggerLevel(),
|
||||
opts.logFormat, opts.logFormatter,
|
||||
)
|
||||
logger.AddReplacer(opts.token, "<TOKEN>")
|
||||
|
||||
client := opts.client
|
||||
if client == nil {
|
||||
@@ -144,6 +165,7 @@ func NewAPI(opts *APIOpts) *API {
|
||||
pool: pool,
|
||||
Limiter: opts.limiter,
|
||||
dropOverflowLimit: opts.dropOverflowLimit,
|
||||
maxRetries: opts.maxRetries,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -166,18 +188,29 @@ func (api *API) GetLogger() *sneklog.Logger {
|
||||
|
||||
// ResponseParameters contains Telegram API response metadata (e.g., retry_after, migrate_to_chat_id).
|
||||
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"`
|
||||
RetryAfter *int `json:"retry_after,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"`
|
||||
}
|
||||
|
||||
// TelegramResponse is the standard Telegram Bot API response structure.
|
||||
// Generic over Result type R.
|
||||
type TelegramResponse[R any] struct {
|
||||
Ok bool `json:"ok"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Result R `json:"result,omitempty"`
|
||||
ErrorCode int `json:"error_code,omitempty"`
|
||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||
// Ok reports whether the request succeeded.
|
||||
Ok bool `json:"ok"`
|
||||
// Description contains a human-readable result description when supplied by Telegram.
|
||||
Description string `json:"description,omitempty"`
|
||||
// Result contains the method-specific result for a successful response.
|
||||
Result R `json:"result,omitempty"`
|
||||
// ErrorCode is the Telegram API error code for an unsuccessful response.
|
||||
ErrorCode int `json:"error_code,omitempty"`
|
||||
// Parameters contains additional recovery metadata for an unsuccessful response.
|
||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||
}
|
||||
|
||||
// TelegramRequest is a low-level Telegram API request wrapper.
|
||||
@@ -203,7 +236,7 @@ func NewRequestWithChatID[R, P any](method string, params P, chatID int64) Teleg
|
||||
return TelegramRequest[R, P]{method, params, chatID}
|
||||
}
|
||||
|
||||
func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, error) {
|
||||
func (api *API) doRequest[R, P any](ctx context.Context, r TelegramRequest[R, P]) (R, error) {
|
||||
var zero R
|
||||
reqData, err := json.Marshal(r.params)
|
||||
if err != nil {
|
||||
@@ -224,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("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||
|
||||
retries := 0
|
||||
for {
|
||||
// Apply rate limiting before making the request
|
||||
if api.Limiter != nil {
|
||||
@@ -235,10 +269,10 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
req.Body = io.NopCloser(buf)
|
||||
req.ContentLength = int64(len(reqData))
|
||||
|
||||
api.logger.Debugln("REQ", url, string(reqData))
|
||||
api.logger.Debugln("REQ", url, redactRequestLog(reqData))
|
||||
resp, err := api.client.Do(req)
|
||||
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)
|
||||
@@ -247,7 +281,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
return zero, fmt.Errorf("failed to read response body: %w", err)
|
||||
}
|
||||
|
||||
api.logger.Debugln("RES", r.method, string(respData))
|
||||
api.logger.Debugln("RES", responseLogSummary(r.method, len(respData)))
|
||||
|
||||
response, err := parseBody[R](respData)
|
||||
if err != nil {
|
||||
@@ -268,7 +302,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
|
||||
// Apply cooldown to global or chat-specific limiter
|
||||
if api.Limiter != nil {
|
||||
if r.chatID > 0 {
|
||||
if r.chatID != 0 {
|
||||
api.Limiter.SetChatLock(r.chatID, after)
|
||||
} else {
|
||||
api.Limiter.SetGlobalLock(after)
|
||||
@@ -278,12 +312,16 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
if r.method == "getUpdates" {
|
||||
return zero, responseErr
|
||||
}
|
||||
if retries >= api.maxRetries {
|
||||
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||
}
|
||||
retries++
|
||||
|
||||
// Wait and retry
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
case <-time.After(retryDelay(after)):
|
||||
continue // retry request
|
||||
}
|
||||
}
|
||||
@@ -298,11 +336,11 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
|
||||
// DoWithContext executes the request asynchronously via the worker pool.
|
||||
// Returns result or error via channel. Respects context cancellation.
|
||||
func (r TelegramRequest[R, P]) DoWithContext(ctx context.Context, api *API) (R, error) {
|
||||
func (api *API) DoWithContext[R, P any](ctx context.Context, r TelegramRequest[R, P]) (R, error) {
|
||||
var zero R
|
||||
|
||||
resultChan, err := api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||
return r.doRequest(ctx, api)
|
||||
return api.doRequest(ctx, r)
|
||||
})
|
||||
if err != nil {
|
||||
return zero, err
|
||||
@@ -324,13 +362,27 @@ func (r TelegramRequest[R, P]) DoWithContext(ctx context.Context, api *API) (R,
|
||||
|
||||
// Do executes the request synchronously with a background context.
|
||||
// Use only for simple, non-critical calls.
|
||||
func (r TelegramRequest[R, P]) Do(api *API) (R, error) {
|
||||
return r.DoWithContext(context.Background(), api)
|
||||
func (api *API) Do[R, P any](r TelegramRequest[R, P]) (R, error) {
|
||||
return api.DoWithContext(context.Background(), r)
|
||||
}
|
||||
|
||||
func readBody(body io.ReadCloser) ([]byte, error) {
|
||||
reader := io.LimitReader(body, 10<<20) // 10 MB
|
||||
return io.ReadAll(reader)
|
||||
data, err := io.ReadAll(io.LimitReader(body, maximumResponseSize+1))
|
||||
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) {
|
||||
|
||||
@@ -0,0 +1,358 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestEditMessageTextMarshalsInputRichMessage(t *testing.T) {
|
||||
params := EditMessageText{
|
||||
ChatID: 1,
|
||||
MessageID: 2,
|
||||
RichMessage: &InputRichMessage{
|
||||
HTML: "<p>hi</p>",
|
||||
SkipEntityDetection: true,
|
||||
},
|
||||
}
|
||||
data, err := json.Marshal(params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
for _, want := range []string{`"rich_message":{"html":`, `"skip_entity_detection":true`} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Fatalf("missing %s in editMessageText JSON: %s", want, got)
|
||||
}
|
||||
}
|
||||
if strings.Contains(got, `"blocks"`) {
|
||||
t.Fatalf("rich_message must be an InputRichMessage, not a block tree: %s", got)
|
||||
}
|
||||
if strings.Contains(got, `"text"`) {
|
||||
t.Fatalf("empty text must be omitted when editing rich content: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSendRichMessageDraftMarshal(t *testing.T) {
|
||||
params := SendRichMessageDraft{
|
||||
ChatID: 1,
|
||||
DraftID: 7,
|
||||
RichMessage: InputRichMessage{Markdown: "*hi*"},
|
||||
CanStop: true,
|
||||
KeepOnStop: true,
|
||||
}
|
||||
data, err := json.Marshal(params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
for _, want := range []string{`"chat_id":1`, `"draft_id":7`, `"rich_message":{"markdown":"*hi*"}`, `"can_stop":true`, `"keep_on_stop":true`} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Fatalf("missing %s in sendRichMessageDraft JSON: %s", want, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichMessageContentMarshal(t *testing.T) {
|
||||
content := InputRichMessageContent{
|
||||
RichMessage: InputRichMessage{HTML: "<p>hi</p>"},
|
||||
}
|
||||
data, err := json.Marshal(content)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
if got := string(data); !strings.Contains(got, `"rich_message":{"html":`) {
|
||||
t.Fatalf("unexpected InputRichMessageContent JSON: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichMessageMediaMarshal(t *testing.T) {
|
||||
message := InputRichMessage{
|
||||
HTML: `<video src="tg://video?id=intro"></video>`,
|
||||
Media: []InputRichMessageMedia{{
|
||||
ID: "intro",
|
||||
Media: InputMedia{Type: InputMediaTypeVideo, Media: "attach://intro"},
|
||||
}},
|
||||
}
|
||||
data, err := json.Marshal(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
|
||||
var got struct {
|
||||
Media []struct {
|
||||
ID string `json:"id"`
|
||||
Media InputMedia `json:"media"`
|
||||
} `json:"media"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &got); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if len(got.Media) != 1 || got.Media[0].ID != "intro" {
|
||||
t.Fatalf("unexpected media: %+v", got.Media)
|
||||
}
|
||||
if got.Media[0].Media.Type != InputMediaTypeVideo || got.Media[0].Media.Media != "attach://intro" {
|
||||
t.Fatalf("unexpected embedded media: %+v", got.Media[0].Media)
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralMethodsMarshalReceiverUserID(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
params any
|
||||
}{
|
||||
{"edit text", EditEphemeralMessageText{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Text: "updated"}},
|
||||
{"edit media", EditEphemeralMessageMedia{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Media: InputMedia{Type: InputMediaTypePhoto, Media: "photo-id"}}},
|
||||
{"edit caption", EditEphemeralMessageCaption{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Caption: "updated"}},
|
||||
{"edit markup", EditEphemeralMessageReplyMarkup{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}},
|
||||
{"delete", DeleteEphemeralMessage{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(tt.params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
var fields map[string]json.RawMessage
|
||||
if err := json.Unmarshal(data, &fields); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if _, ok := fields["receiver_user_id"]; !ok {
|
||||
t.Fatalf("receiver_user_id is missing from %s", data)
|
||||
}
|
||||
if _, ok := fields["reciever_user_id"]; ok {
|
||||
t.Fatalf("misspelled receiver_user_id is present in %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralSendParametersMarshal(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
params any
|
||||
}{
|
||||
{"message", SendMessage{ChatID: 1, Text: "text", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"animation", SendAnimation{ChatID: 1, Animation: "animation", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"audio", SendAudio{ChatID: 1, Audio: "audio", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"document", SendDocument{ChatID: 1, Document: "document", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"photo", SendPhoto{ChatID: 1, Photo: "photo", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"sticker", SendSticker{ChatID: 1, Sticker: "sticker", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"video", SendVideo{ChatID: 1, Video: "video", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"video note", SendVideoNote{ChatID: 1, VideoNote: "video-note", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"voice", SendVoice{ChatID: 1, Voice: "voice", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"contact", SendContact{ChatID: 1, PhoneNumber: "+10000000000", FirstName: "A", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"location", SendLocation{ChatID: 1, Latitude: 1, Longitude: 2, EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
{"venue", SendVenue{ChatID: 1, Latitude: 1, Longitude: 2, Title: "Venue", Address: "Address", EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(tt.params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
var fields map[string]json.RawMessage
|
||||
if err := json.Unmarshal(data, &fields); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, old := fields["receiver_user_id"]; old {
|
||||
t.Fatalf("legacy receiver field remains: %s", data)
|
||||
}
|
||||
if _, old := fields["callback_query_id"]; old {
|
||||
t.Fatalf("legacy callback field remains: %s", data)
|
||||
}
|
||||
if len(fields["ephemeral_message_parameters"]) == 0 {
|
||||
t.Fatalf("missing nested parameters: %s", data)
|
||||
}
|
||||
if !strings.Contains(string(data), `"receiver_user_id":2`) || !strings.Contains(string(data), `"callback_query_id":"callback"`) {
|
||||
t.Fatalf("missing ephemeral parameters in %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralUploadParametersMarshal(t *testing.T) {
|
||||
ephemeral := &EphemeralMessageParameters{ReceiverUserID: 2, CallbackQueryID: "callback"}
|
||||
cases := []struct {
|
||||
name string
|
||||
params any
|
||||
}{
|
||||
{"photo", UploadPhoto{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"animation", UploadAnimation{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"audio", UploadAudio{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"document", UploadDocument{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"live photo", UploadLivePhoto{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"video", UploadVideo{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"video note", UploadVideoNote{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
{"voice", UploadVoice{ChatID: 1, EphemeralMessageParameters: ephemeral}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(tt.params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
var fields map[string]json.RawMessage
|
||||
if err := json.Unmarshal(data, &fields); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, old := fields["receiver_user_id"]; old {
|
||||
t.Fatalf("legacy receiver field remains: %s", data)
|
||||
}
|
||||
if _, old := fields["callback_query_id"]; old {
|
||||
t.Fatalf("legacy callback field remains: %s", data)
|
||||
}
|
||||
if !strings.Contains(string(fields["ephemeral_message_parameters"]), `"receiver_user_id":2`) {
|
||||
t.Fatalf("missing nested parameters: %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotAPI103KeyboardAndAdministratorFieldsMarshal(t *testing.T) {
|
||||
trueValue := true
|
||||
cases := []struct {
|
||||
name string
|
||||
value any
|
||||
fields []string
|
||||
}{
|
||||
{"inline keyboard force reply", InlineKeyboardMarkup{ForceReply: true}, []string{`"force_reply":true`}},
|
||||
{"reply keyboard force reply", ReplyKeyboardMarkup{Keyboard: [][]KeyboardButton{}, ForceReply: true}, []string{`"force_reply":true`}},
|
||||
{"disabled inline button", InlineKeyboardButton{Text: "Wait", Disabled: &DisabledButton{}}, []string{`"disabled":{}`}},
|
||||
{"administrator member", ChatMember{CanSendWelcomeMessages: &trueValue}, []string{`"can_send_welcome_messages":true`}},
|
||||
{"administrator rights", ChatAdministratorRights{CanSendWelcomeMessages: &trueValue}, []string{`"can_send_welcome_messages":true`}},
|
||||
{"promote administrator", PromoteChatMember{ChatID: 1, UserID: 2, CanSendWelcomeMessages: true}, []string{`"can_send_welcome_messages":true`}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
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 _, field := range tt.fields {
|
||||
if !strings.Contains(string(data), field) {
|
||||
t.Fatalf("missing %s in %s", field, data)
|
||||
}
|
||||
}
|
||||
if strings.Contains(string(data), "melcome") {
|
||||
t.Fatalf("misspelled welcome field in %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMessageGenerationStoppedUpdateUnmarshal(t *testing.T) {
|
||||
var update Update
|
||||
err := json.Unmarshal([]byte(`{"update_id":1,"stopped_message_generation":{"chat":{"id":42,"type":"private"},"message_thread_id":3,"draft_id":7}}`), &update)
|
||||
if err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if update.Type != UpdateTypeMessageGenerationStopped || update.StoppedMessageGeneration == nil {
|
||||
t.Fatalf("unexpected update routing: type=%q payload=%+v", update.Type, update.StoppedMessageGeneration)
|
||||
}
|
||||
if update.StoppedMessageGeneration.Chat.ID != 42 || update.StoppedMessageGeneration.DraftID != 7 {
|
||||
t.Fatalf("unexpected stopped-generation payload: %+v", update.StoppedMessageGeneration)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotAPI103AdditionalFieldsMarshal(t *testing.T) {
|
||||
params := []struct {
|
||||
name string
|
||||
value any
|
||||
want []string
|
||||
}{
|
||||
{
|
||||
"ephemeral replacement",
|
||||
EphemeralMessageParameters{ReceiverUserID: 2, ReplaceCallbackQueryMessage: true},
|
||||
[]string{`"receiver_user_id":2`, `"replace_callback_query_message":true`},
|
||||
},
|
||||
{
|
||||
"message draft controls",
|
||||
SendMessageDraft{ChatID: 1, DraftID: 7, CanStop: true, KeepOnStop: true},
|
||||
[]string{`"can_stop":true`, `"keep_on_stop":true`},
|
||||
},
|
||||
{
|
||||
"ephemeral rich text",
|
||||
EditEphemeralMessageText{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, RichMessage: &InputRichMessage{HTML: "<b>x</b>"}},
|
||||
[]string{`"rich_message":{`, `"html":`},
|
||||
},
|
||||
{
|
||||
"ephemeral caption position",
|
||||
EditEphemeralMessageCaption{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, ShowCaptionAboveMedia: true},
|
||||
[]string{`"show_caption_above_media":true`},
|
||||
},
|
||||
{
|
||||
"unique gift privacy",
|
||||
UniqueGiftInfo{Text: "gift", Entities: []MessageEntity{{Type: MessageEntityBold, Length: 4}}, IsPrivate: true},
|
||||
[]string{`"text":"gift"`, `"entities":[`, `"is_private":true`},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range params {
|
||||
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 _, want := range tt.want {
|
||||
if !strings.Contains(string(data), want) {
|
||||
t.Fatalf("missing %s in %s", want, data)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputPollOptionMediaLinkMarshal(t *testing.T) {
|
||||
media := InputPollOptionMedia{Type: "link", URL: "https://example.com"}
|
||||
data, err := json.Marshal(media)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
if got != `{"type":"link","url":"https://example.com"}` {
|
||||
t.Fatalf("unexpected link media JSON: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPollMediaUnmarshalLink(t *testing.T) {
|
||||
var media PollMedia
|
||||
if err := json.Unmarshal([]byte(`{"link":{"url":"https://example.com"}}`), &media); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if media.Link == nil || media.Link.URL != "https://example.com" {
|
||||
t.Fatalf("unexpected poll media link: %+v", media.Link)
|
||||
}
|
||||
}
|
||||
|
||||
func TestChatJoinRequestUnmarshalQueryID(t *testing.T) {
|
||||
payload := `{"chat":{"id":1},"from":{"id":2,"first_name":"A"},"user_chat_id":2,"date":3,"query_id":"q42"}`
|
||||
var req ChatJoinRequest
|
||||
if err := json.Unmarshal([]byte(payload), &req); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if req.QueryID == nil || *req.QueryID != "q42" {
|
||||
t.Fatalf("unexpected query_id: %+v", req.QueryID)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnswerChatJoinRequestQueryResultValues(t *testing.T) {
|
||||
if JoinRequestApprove != "approve" || JoinRequestDecline != "decline" || JoinRequestQueue != "queue" {
|
||||
t.Fatalf("unexpected join request query result values: %q %q %q",
|
||||
JoinRequestApprove, JoinRequestDecline, JoinRequestQueue)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserUnmarshalSupportsJoinRequestQueries(t *testing.T) {
|
||||
var user User
|
||||
if err := json.Unmarshal([]byte(`{"id":1,"first_name":"A","supports_join_request_queries":true}`), &user); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if user.SupportsJoinRequestQueries == nil || !*user.SupportsJoinRequestQueries {
|
||||
t.Fatalf("unexpected supports_join_request_queries: %+v", user.SupportsJoinRequestQueries)
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
@@ -88,3 +89,42 @@ func TestAPICloseClosesIdleConnections(t *testing.T) {
|
||||
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)
|
||||
}
|
||||
}
|
||||
|
||||
+544
-177
@@ -6,26 +6,63 @@ import "context"
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
type SendPhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Photo string `json:"photo"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// 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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the photo caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotifications Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendPhoto sends a photo.
|
||||
@@ -33,7 +70,7 @@ type SendPhoto struct {
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (api *API) SendPhoto(params SendPhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||
@@ -42,35 +79,76 @@ func (api *API) SendPhoto(params SendPhoto) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (api *API) SendPhotoWithContext(ctx context.Context, params SendPhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendAudio holds parameters for the sendAudio method.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
type SendAudio struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Audio string `json:"audio"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// Caption Optional. Audio caption, 0-1024 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Performer string `json:"performer,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
// Duration Optional. Duration of the audio in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Performer Optional. Performer
|
||||
Performer string `json:"performer,omitempty"`
|
||||
// Title Optional. Track name
|
||||
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"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendAudio sends an audio file.
|
||||
@@ -78,7 +156,7 @@ type SendAudio struct {
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (api *API) SendAudio(params SendAudio) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||
@@ -87,33 +165,74 @@ func (api *API) SendAudio(params SendAudio) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (api *API) SendAudioWithContext(ctx context.Context, params SendAudio) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendDocument holds parameters for the sendDocument method.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
type SendDocument struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Document string `json:"document"`
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the document caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
// DisableContentTypeDetection Optional. Disables automatic server-side content type detection for files
|
||||
// uploaded using multipart/form-data
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendDocument sends a document.
|
||||
@@ -121,7 +240,7 @@ type SendDocument struct {
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (api *API) SendDocument(params SendDocument) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||
@@ -130,41 +249,91 @@ func (api *API) SendDocument(params SendDocument) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (api *API) SendDocumentWithContext(ctx context.Context, params SendDocument) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendVideo holds parameters for the sendVideo method.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
type SendVideo struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Video string `json:"video"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// 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"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
Cover string `json:"cover,omitempty"`
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Width Optional. Video width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Video height
|
||||
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"`
|
||||
|
||||
StartTimestamp int `json:"start_timestamp,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||
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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVideo sends a video.
|
||||
@@ -172,7 +341,7 @@ type SendVideo struct {
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (api *API) SendVideo(params SendVideo) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||
@@ -181,37 +350,81 @@ func (api *API) SendVideo(params SendVideo) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (api *API) SendVideoWithContext(ctx context.Context, params SendVideo) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendAnimation holds parameters for the sendAnimation method.
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
type SendAnimation struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// 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"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Duration Optional. Duration of sent animation in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Width Optional. Animation width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Animation height
|
||||
Height int `json:"height,omitempty"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the animation caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendAnimation sends an animation file (GIF or H.264/MPEG-4 AVC video without sound).
|
||||
@@ -219,7 +432,7 @@ type SendAnimation struct {
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (api *API) SendAnimation(params SendAnimation) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||
@@ -228,31 +441,64 @@ func (api *API) SendAnimation(params SendAnimation) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (api *API) SendAnimationWithContext(ctx context.Context, params SendAnimation) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendVoice holds parameters for the sendVoice method.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
type SendVoice struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Voice string `json:"voice"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// Caption Optional. Voice message caption, 0-1024 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
// Duration Optional. Duration of the voice message in seconds
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVoice sends a voice note.
|
||||
@@ -260,7 +506,7 @@ type SendVoice struct {
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (api *API) SendVoice(params SendVoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||
@@ -269,30 +515,65 @@ func (api *API) SendVoice(params SendVoice) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (api *API) SendVoiceWithContext(ctx context.Context, params SendVoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendVideoNote holds parameters for the sendVideoNote method.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
type SendVideoNote struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
VideoNote string `json:"video_note"`
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Length int `json:"length,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// 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"`
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Length Optional. Video width and height, i.e. diameter of the video message
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVideoNote sends a video note (rounded video message).
|
||||
@@ -300,7 +581,7 @@ type SendVideoNote struct {
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (api *API) SendVideoNote(params SendVideoNote) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||
@@ -309,32 +590,63 @@ func (api *API) SendVideoNote(params SendVideoNote) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (api *API) SendVideoNoteWithContext(ctx context.Context, params SendVideoNote) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendPaidMedia holds parameters for the sendPaidMedia method.
|
||||
// Since: Bot API 7.6
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
type SendPaidMedia struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Media []InputPaidMedia `json:"media"`
|
||||
Payload string `json:"payload,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// Media Required. A JSON-serialized Array describing the media to be sent; up to 10 items
|
||||
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"`
|
||||
// Caption Optional. Media caption, 0-1024 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendPaidMedia sends paid media.
|
||||
@@ -342,7 +654,7 @@ type SendPaidMedia struct {
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
func (api *API) SendPaidMedia(params SendPaidMedia) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendPaidMediaWithContext is the context-aware variant of SendPaidMedia.
|
||||
@@ -351,24 +663,41 @@ func (api *API) SendPaidMedia(params SendPaidMedia) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
func (api *API) SendPaidMediaWithContext(ctx context.Context, params SendPaidMedia) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendMediaGroup holds parameters for the sendMediaGroup method.
|
||||
// Since: Bot API 3.5
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
type SendMediaGroup struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Media []InputMedia `json:"media"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// Media Required. A JSON-serialized Array describing messages to be sent, must include 2-10 items
|
||||
Media []InputMedia `json:"media"`
|
||||
// DisableNotification Optional. Sends messages silently. Users will receive a notification with no sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
}
|
||||
|
||||
// SendMediaGroup sends a group of photos, videos, documents or audios as an album.
|
||||
@@ -376,7 +705,7 @@ type SendMediaGroup struct {
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
func (api *API) SendMediaGroup(params SendMediaGroup) ([]Message, error) {
|
||||
req := NewRequestWithChatID[[]Message]("sendMediaGroup", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendMediaGroupWithContext is the context-aware variant of SendMediaGroup.
|
||||
@@ -385,33 +714,71 @@ func (api *API) SendMediaGroup(params SendMediaGroup) ([]Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
func (api *API) SendMediaGroupWithContext(ctx context.Context, params SendMediaGroup) ([]Message, error) {
|
||||
req := NewRequestWithChatID[[]Message]("sendMediaGroup", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendLivePhoto holds parameters for the sendLivePhoto method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
type SendLivePhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
LivePhoto string `json:"live_photo"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// 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"`
|
||||
// Photo contains or identifies the associated 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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendLivePhoto sends a live photo.
|
||||
@@ -419,7 +786,7 @@ type SendLivePhoto struct {
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (api *API) SendLivePhoto(params SendLivePhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendLivePhotoWithContext is the context-aware variant of SendLivePhoto.
|
||||
@@ -428,5 +795,5 @@ func (api *API) SendLivePhoto(params SendLivePhoto) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (api *API) SendLivePhotoWithContext(ctx context.Context, params SendLivePhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+476
-184
@@ -3,107 +3,183 @@ package tgapi
|
||||
// Animation represents an animation file (GIF or H.264/MPEG-4 AVC without sound).
|
||||
// Since: Bot API 4.0
|
||||
type Animation struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Duration int `json:"duration"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
|
||||
// Thumbnail Optional. Animation thumbnail as defined by the sender
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
FileName string `json:"file_name"`
|
||||
MimeType string `json:"mime_type"`
|
||||
FileSize int `json:"file_size"`
|
||||
// FileName Optional. Original animation filename as defined by the sender
|
||||
FileName string `json:"file_name"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
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"`
|
||||
}
|
||||
|
||||
// Audio represents an audio file to be treated as music by the Telegram clients.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#audio
|
||||
type Audio struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Duration int `json:"duration"`
|
||||
// Duration Duration of the audio in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
|
||||
Performer string `json:"performer,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
FileName string `json:"file_name,omitempty"` // Since: Bot API 5.0
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Performer Optional. Performer of the audio as defined by the sender or by audio tags
|
||||
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"`
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
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"`
|
||||
// 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"`
|
||||
// Thumbnail Optional. Thumbnail of the album cover to which the music file belongs
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// Document represents a general file (as opposed to photos, voice messages and audio files).
|
||||
// Since: Bot API 1.0
|
||||
type Document struct {
|
||||
FileID string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
FileName string `json:"file_name"`
|
||||
MimeType string `json:"mime_type"`
|
||||
FileSize int `json:"file_size,omitempty"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
// Thumbnail Optional. Document thumbnail as defined by the sender
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
FileName string `json:"file_name"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
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"`
|
||||
}
|
||||
|
||||
// Story represents a story.
|
||||
// Since: Bot API 6.8
|
||||
type Story struct {
|
||||
// Chat Chat that posted the story
|
||||
Chat Chat `json:"chat"`
|
||||
ID int `json:"id"`
|
||||
// ID Unique identifier for the story in the chat
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
// Video represents a video file.
|
||||
// Since: Bot API 1.0
|
||||
type Video struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Duration int `json:"duration"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
Cover []PhotoSize `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||
StartTimestamp int64 `json:"start_timestamp"` // Since: Bot API 8.3
|
||||
Qualities []VideoQuality `json:"qualities,omitempty"` // Since: Bot API 9.4
|
||||
FileName string `json:"file_name,omitempty"`
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Thumbnail Optional. Video thumbnail
|
||||
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
|
||||
// StartTimestamp Optional. Timestamp in seconds from which the video will play in the message
|
||||
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
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
FileName string `json:"file_name,omitempty"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
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"`
|
||||
}
|
||||
|
||||
// VideoQuality describes an alternative quality for a video.
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#videoquality
|
||||
type VideoQuality struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Codec string `json:"codec"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Width Video width
|
||||
Width int `json:"width"`
|
||||
// Height Video height
|
||||
Height int `json:"height"`
|
||||
// Codec Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”
|
||||
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"`
|
||||
}
|
||||
|
||||
// VideoNote represents a video message.
|
||||
// Since: Bot API 3.0
|
||||
type VideoNote struct {
|
||||
FileID string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Length int `json:"length"`
|
||||
Duration int `json:"duration"`
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
// Length Video width and height (diameter of the video message) as defined by the sender
|
||||
Length int `json:"length"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// Thumbnail Optional. Video thumbnail
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// Voice represents a voice note.
|
||||
// Since: Bot API 1.2
|
||||
type Voice struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Duration int `json:"duration"`
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
FileSize int `json:"file_size,omitempty"`
|
||||
// Duration Duration of the audio in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
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"`
|
||||
}
|
||||
|
||||
// PaidMediaInfo describes paid media.
|
||||
// Since: Bot API 7.6
|
||||
type PaidMediaInfo struct {
|
||||
StarCount int `json:"star_count"`
|
||||
// StarCount The number of Telegram Stars that must be paid to buy access to the media
|
||||
StarCount int `json:"star_count"`
|
||||
// PaidMedia Information about the paid media
|
||||
PaidMedia []PaidMedia `json:"paid_media"`
|
||||
}
|
||||
|
||||
@@ -112,101 +188,159 @@ type PaidMediaInfo struct {
|
||||
type PaidMediaType string
|
||||
|
||||
const (
|
||||
PaidMediaPreviewType PaidMediaType = "preview"
|
||||
PaidMediaPhotoType PaidMediaType = "photo"
|
||||
PaidMediaVideoType PaidMediaType = "video"
|
||||
// PaidMediaPreviewType identifies a paid-media preview.
|
||||
PaidMediaPreviewType PaidMediaType = "preview"
|
||||
// PaidMediaPhotoType identifies a paid photo.
|
||||
PaidMediaPhotoType PaidMediaType = "photo"
|
||||
// PaidMediaVideoType identifies a paid video.
|
||||
PaidMediaVideoType PaidMediaType = "video"
|
||||
// PaidMediaLivePhotoType identifies a paid live photo.
|
||||
PaidMediaLivePhotoType PaidMediaType = "live_photo" // Since: Bot API 10.0
|
||||
)
|
||||
|
||||
// PaidMedia describes paid media content.
|
||||
// Since: Bot API 7.6
|
||||
type PaidMedia struct {
|
||||
// Type identifies the preview, photo, video, or live-photo variant.
|
||||
Type PaidMediaType `json:"type,omitempty"`
|
||||
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Width Optional. Media width as defined by the sender
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Media height as defined by the sender
|
||||
Height int `json:"height,omitempty"`
|
||||
// Duration Optional. Duration of the media in seconds as defined by the sender
|
||||
Duration int `json:"duration,omitempty"`
|
||||
|
||||
// Photo The photo
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
|
||||
Video *Video `json:"video,omitempty"`
|
||||
// Video The video
|
||||
Video *Video `json:"video,omitempty"`
|
||||
// LivePhoto The photo
|
||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"` // Since: Bot API 10.0
|
||||
}
|
||||
|
||||
// Contact represents a phone contact.
|
||||
// Since: Bot API 1.0
|
||||
type Contact struct {
|
||||
// PhoneNumber Contact's phone number
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
UserID int64 `json:"user_id,omitempty"`
|
||||
Vcard string `json:"vcard,omitempty"`
|
||||
// FirstName Contact's first name
|
||||
FirstName string `json:"first_name"`
|
||||
// LastName Optional. Contact's last name
|
||||
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"`
|
||||
// Vcard Optional. Additional data about the contact in the form of a vCard
|
||||
Vcard string `json:"vcard,omitempty"`
|
||||
}
|
||||
|
||||
// Dice represents an animated emoji with a random value.
|
||||
// Since: Bot API 4.7
|
||||
type Dice struct {
|
||||
// Emoji Emoji on which the dice throw animation is based
|
||||
Emoji string `json:"emoji"`
|
||||
Value int `json:"value"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// PollOption contains information about one answer option in a poll.
|
||||
// Since: Bot API 4.2
|
||||
// See https://core.telegram.org/bots/api#polloption
|
||||
type PollOption struct {
|
||||
PersistentID string `json:"persistent_id"` // Since: Bot API 9.6
|
||||
Text string `json:"text"`
|
||||
// PersistentID Unique identifier of the option, persistent on option addition and deletion
|
||||
PersistentID string `json:"persistent_id"` // Since: Bot API 9.6
|
||||
// Text Option text, 1-100 characters
|
||||
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"`
|
||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
VoterCount int `json:"voter_count"`
|
||||
// Media Optional. Media added to the poll option
|
||||
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"`
|
||||
|
||||
AddedByUser *User `json:"added_by_user,omitempty"` // Since: Bot API 9.6
|
||||
AddedByChat *Chat `json:"added_by_chat,omitempty"` // Since: Bot API 9.6
|
||||
AdditionDate int `json:"addition_date,omitempty"` // Since: Bot API 9.6
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
}
|
||||
|
||||
// InputPollOptionMedia describes the media to attach to a poll option.
|
||||
// For type "link" set URL instead of Media.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#inputpolloptionmedia
|
||||
type InputPollOptionMedia struct {
|
||||
Type string `json:"type"`
|
||||
Media string `json:"media"`
|
||||
// Type identifies the poll-option media variant.
|
||||
Type string `json:"type"`
|
||||
// Media is the file_id or URL of the option media for non-link variants.
|
||||
Media string `json:"media,omitempty"`
|
||||
// URL contains the HTTP URL.
|
||||
URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link"
|
||||
}
|
||||
|
||||
// InputPollOption contains information about one answer option in a poll to be sent.
|
||||
// Since: Bot API 7.3
|
||||
// See https://core.telegram.org/bots/api#inputpolloption
|
||||
type InputPollOption struct {
|
||||
Text string `json:"text"`
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
Media *InputPollOptionMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
// Text Option text, 1-100 characters
|
||||
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"`
|
||||
// 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"`
|
||||
// Media Optional. Media added to the poll option
|
||||
Media *InputPollOptionMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
}
|
||||
|
||||
// InputPollMedia describes the media to attach to a poll or its explanation.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#inputpollmedia
|
||||
type InputPollMedia struct {
|
||||
Type string `json:"type"`
|
||||
// Type identifies the poll-media variant.
|
||||
Type string `json:"type"`
|
||||
// Media is the file_id or URL of the poll media.
|
||||
Media string `json:"media"`
|
||||
}
|
||||
|
||||
// PollOptionAdded describes a service message about a poll option being added.
|
||||
// Since: Bot API 9.6
|
||||
type PollOptionAdded struct {
|
||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
OptionText string `json:"option_text"`
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
// 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"`
|
||||
// OptionPersistentID Unique identifier of the added option
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
// OptionText Option text
|
||||
OptionText string `json:"option_text"`
|
||||
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// PollOptionDeleted describes a service message about a poll option being deleted.
|
||||
// Since: Bot API 9.6
|
||||
type PollOptionDeleted struct {
|
||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
OptionText string `json:"option_text"`
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
// 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"`
|
||||
// OptionPersistentID Unique identifier of the deleted option
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
// OptionText Option text
|
||||
OptionText string `json:"option_text"`
|
||||
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// PollType represents the type of a poll.
|
||||
@@ -219,14 +353,21 @@ const (
|
||||
PollTypeQuiz PollType = "quiz"
|
||||
)
|
||||
|
||||
// PollAnswer represents an answer of a user in a poll.
|
||||
// PollAnswer represents an answer submitted by a poll voter.
|
||||
//
|
||||
// Exactly one of User and VoterChat is present.
|
||||
// Since: Bot API 4.6
|
||||
// See https://core.telegram.org/bots/api#pollanswer
|
||||
type PollAnswer struct {
|
||||
PollID string `json:"poll_id"`
|
||||
VoterChat Chat `json:"voter_chat"` // Since: Bot API 6.8
|
||||
User User `json:"user"`
|
||||
OptionIDs []int `json:"option_ids"`
|
||||
// PollID identifies the poll.
|
||||
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
|
||||
// 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"`
|
||||
// OptionPersistentIDs contains the persistent identifiers of the chosen options.
|
||||
OptionPersistentIDs []string `json:"option_persistent_ids"` // Since: Bot API 9.6
|
||||
}
|
||||
|
||||
@@ -234,98 +375,184 @@ type PollAnswer struct {
|
||||
// Since: Bot API 4.2
|
||||
// See https://core.telegram.org/bots/api#poll
|
||||
type Poll struct {
|
||||
ID string `json:"id"`
|
||||
Question string `json:"question"`
|
||||
// ID Unique poll identifier
|
||||
ID string `json:"id"`
|
||||
// Question Poll question, 1-300 characters
|
||||
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
|
||||
Options []PollOption `json:"options"`
|
||||
TotalVoterCount int `json:"total_voter_count"`
|
||||
IsClosed bool `json:"is_closed,omitempty"`
|
||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||
Type PollType `json:"type"`
|
||||
// Options List of poll options
|
||||
Options []PollOption `json:"options"`
|
||||
// TotalVoterCount Total number of users that voted in the poll
|
||||
TotalVoterCount int `json:"total_voter_count"`
|
||||
// IsClosed True, if the poll is closed
|
||||
IsClosed bool `json:"is_closed,omitempty"`
|
||||
// IsAnonymous True, if the poll is anonymous
|
||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||
// Type Poll type, currently can be “regular” or “quiz”
|
||||
Type PollType `json:"type"`
|
||||
|
||||
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // Since: Bot API 4.6
|
||||
AllowsRevoting bool `json:"allows_revoting,omitempty"` // Since: Bot API 9.6
|
||||
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
||||
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
||||
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"` // Since: Bot API 9.6
|
||||
Explanation string `json:"explanation,omitempty"` // Since: Bot API 4.8
|
||||
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // Since: Bot API 4.8
|
||||
ExplanationMedia *PollMedia `json:"explanation_media,omitempty"` // Since: Bot API 10.0
|
||||
OpenPeriod int `json:"open_period,omitempty"` // Since: Bot API 4.8
|
||||
CloseDate int `json:"close_date,omitempty"` // Since: Bot API 4.8
|
||||
Description string `json:"description,omitempty"` // Since: Bot API 9.6
|
||||
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"` // Since: Bot API 9.6
|
||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
// AllowsMultipleAnswers True, if the poll allows multiple answers
|
||||
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
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
// ExplanationMedia Optional. Media added to the quiz explanation
|
||||
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
|
||||
// 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
|
||||
// Description Optional. Description of the poll; for polls inside the Message object only
|
||||
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
|
||||
// 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
|
||||
}
|
||||
|
||||
// Link represents an HTTP link.
|
||||
// Since: Bot API 10.1
|
||||
// See https://core.telegram.org/bots/api#link
|
||||
type Link struct {
|
||||
// URL contains the HTTP URL.
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// PollMedia represents media attached to a poll.
|
||||
// Since: Bot API 10.0
|
||||
type PollMedia struct {
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
Audio *Audio `json:"audio,omitempty"`
|
||||
Document *Document `json:"document,omitempty"`
|
||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
|
||||
Location *Location `json:"location,omitempty"`
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
Sticker *Sticker `json:"sticker,omitempty"`
|
||||
Venue *Venue `json:"venue,omitempty"`
|
||||
Video *Video `json:"video,omitempty"`
|
||||
// Animation Optional. Media is an animation, information about the animation
|
||||
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"`
|
||||
// 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"`
|
||||
// Link contains link media attached to the poll.
|
||||
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"`
|
||||
// Location Optional. Media is a shared location, information about the location
|
||||
Location *Location `json:"location,omitempty"`
|
||||
// Photo Optional. Media is a photo, available sizes of the photo
|
||||
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"`
|
||||
// Venue Optional. Media is a venue, information about the venue
|
||||
Venue *Venue `json:"venue,omitempty"`
|
||||
// Video Optional. Media is a video, information about the video
|
||||
Video *Video `json:"video,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTask represents a single task in a checklist.
|
||||
// Since: Bot API 9.1
|
||||
type ChecklistTask struct {
|
||||
ID int `json:"id"`
|
||||
Text string `json:"text"`
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
CompletedByUser *User `json:"completed_by_user,omitempty"`
|
||||
CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
|
||||
CompletionDate int `json:"completion_date,omitempty"`
|
||||
// ID Unique identifier of the task
|
||||
ID int `json:"id"`
|
||||
// Text Text of the task
|
||||
Text string `json:"text"`
|
||||
// TextEntities Optional. Special entities that appear in the task text
|
||||
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"`
|
||||
// CompletedByChat Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
|
||||
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"`
|
||||
}
|
||||
|
||||
// Checklist represents a checklist.
|
||||
// Since: Bot API 9.1
|
||||
type Checklist struct {
|
||||
Title string `json:"title"`
|
||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||
// Title Title of the checklist
|
||||
Title string `json:"title"`
|
||||
// TitleEntities Optional. Special entities that appear in the checklist title
|
||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||
// Tasks List of tasks in the checklist
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// InputChecklistTask describes a task in a checklist.
|
||||
// Since: Bot API 9.1
|
||||
type InputChecklistTask struct {
|
||||
ID int `json:"id"`
|
||||
Text string `json:"text"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// ID Unique identifier of the task; must be positive and unique among all task identifiers currently
|
||||
// present in the checklist
|
||||
ID int `json:"id"`
|
||||
// Text Text of the task; 1-100 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// InputChecklist represents a checklist to be sent.
|
||||
// Since: Bot API 9.1
|
||||
type InputChecklist struct {
|
||||
Title string `json:"title"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||
Tasks []InputChecklistTask `json:"tasks"`
|
||||
OtherCanAddTasks bool `json:"other_can_add_tasks,omitempty"`
|
||||
OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"`
|
||||
// Title Title of the checklist; 1-255 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
// Tasks List of 1-30 tasks in the checklist
|
||||
Tasks []InputChecklistTask `json:"tasks"`
|
||||
// OthersCanAddTasks Optional. Pass True if other users can add tasks to the checklist
|
||||
OthersCanAddTasks 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
|
||||
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTaskDone describes a service message about checklist tasks being marked as done.
|
||||
// Since: Bot API 9.1
|
||||
type ChecklistTaskDone struct {
|
||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||
MarkedAsDoneTaskIDs []int `json:"marked_as_done_task_ids,omitempty"`
|
||||
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
||||
// ChecklistMessage is the checklist message when it is available.
|
||||
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"`
|
||||
// MarkedAsNotDoneTaskIDs Optional. Identifiers of the tasks that were marked as not done
|
||||
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTasksAdded describes a service message about new checklist tasks being added.
|
||||
// Since: Bot API 9.1
|
||||
type ChecklistTasksAdded struct {
|
||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
// 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"`
|
||||
// Tasks List of tasks added to the checklist
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
}
|
||||
|
||||
// InputMediaType represents the type of input media.
|
||||
@@ -342,10 +569,18 @@ const (
|
||||
InputMediaTypeVideo InputMediaType = "video"
|
||||
// InputMediaTypeAudio is an audio file.
|
||||
InputMediaTypeAudio InputMediaType = "audio"
|
||||
// InputMediaTypeVoiceNote is a voice message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
InputMediaTypeVoiceNote InputMediaType = "voice_note"
|
||||
|
||||
InputMediaTypeSticker InputMediaType = "sticker"
|
||||
InputMediaTypeLocation InputMediaType = "location"
|
||||
InputMediaTypeVenue InputMediaType = "venue"
|
||||
// InputMediaTypeSticker is a sticker.
|
||||
InputMediaTypeSticker InputMediaType = "sticker"
|
||||
// InputMediaTypeLocation is a location.
|
||||
InputMediaTypeLocation InputMediaType = "location"
|
||||
// InputMediaTypeVenue is a venue.
|
||||
InputMediaTypeVenue InputMediaType = "venue"
|
||||
// InputMediaTypeLivePhoto is a live photo.
|
||||
InputMediaTypeLivePhoto InputMediaType = "live_photo" // Since: Bot API 10.0
|
||||
)
|
||||
|
||||
@@ -353,35 +588,64 @@ const (
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#inputmedia
|
||||
type InputMedia struct {
|
||||
Type InputMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
// Type identifies the concrete input-media variant.
|
||||
Type InputMediaType `json:"type"`
|
||||
// Media is a file_id, HTTP URL, or attach:// reference for the media.
|
||||
Media string `json:"media"`
|
||||
|
||||
Caption *string `json:"caption,omitempty"`
|
||||
ParseMode *ParseMode `json:"parse_mode,omitempty"`
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"` // Since: Bot API 7.4
|
||||
HasSpoiler *bool `json:"has_spoiler,omitempty"` // Since: Bot API 6.4
|
||||
// Caption is the optional media caption.
|
||||
Caption *string `json:"caption,omitempty"`
|
||||
// ParseMode selects how entities in Caption are parsed.
|
||||
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"`
|
||||
// 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
|
||||
// HasSpoiler requests that supported media be covered by a spoiler animation.
|
||||
HasSpoiler *bool `json:"has_spoiler,omitempty"` // Since: Bot API 6.4
|
||||
|
||||
Cover *string `json:"cover"` // Since: Bot API 8.3
|
||||
StartTimestamp *int `json:"start_timestamp"` // Since: Bot API 8.3
|
||||
Width *int `json:"width,omitempty"`
|
||||
Height *int `json:"height,omitempty"`
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
SupportsStreaming *bool `json:"supports_streaming,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"` // 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
|
||||
// Width is the optional media width in pixels.
|
||||
Width *int `json:"width,omitempty"`
|
||||
// Height is the optional media height in pixels.
|
||||
Height *int `json:"height,omitempty"`
|
||||
// Duration is the optional duration of the media in seconds.
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||
|
||||
// Performer Optional. Performer of the audio
|
||||
Performer *string `json:"performer,omitempty"`
|
||||
Title *string `json:"title,omitempty"`
|
||||
// Title is the optional title of audio or venue media.
|
||||
Title *string `json:"title,omitempty"`
|
||||
|
||||
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
Address *string `json:"address,omitempty"`
|
||||
FoursquareID *string `json:"foursquare_id,omitempty"`
|
||||
FoursquareType *string `json:"foursquare_type,omitempty"`
|
||||
GooglePlaceID *string `json:"google_place_id,omitempty"`
|
||||
GooglePlaceType *string `json:"google_place_type,omitempty"`
|
||||
// Latitude Latitude of the location
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
// Longitude Longitude of the location
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
// Address Address of the venue
|
||||
Address *string `json:"address,omitempty"`
|
||||
// FoursquareID Optional. Foursquare identifier of the venue
|
||||
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"`
|
||||
// GooglePlaceID Optional. Google Places identifier of the venue
|
||||
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"`
|
||||
|
||||
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
|
||||
}
|
||||
|
||||
@@ -401,37 +665,65 @@ const (
|
||||
// Since: Bot API 7.6
|
||||
// See https://core.telegram.org/bots/api#inputpaidmedia
|
||||
type InputPaidMedia struct {
|
||||
Type InputPaidMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
// Type identifies the concrete paid-media variant.
|
||||
Type InputPaidMediaType `json:"type"`
|
||||
// Media is a file_id, HTTP URL, or attach:// reference for the paid media.
|
||||
Media string `json:"media"`
|
||||
|
||||
Cover *string `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||
StartTimestamp *int64 `json:"start_timestamp,omitempty"` // Since: Bot API 8.3
|
||||
Width *int `json:"width,omitempty"`
|
||||
Height *int `json:"height,omitempty"`
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
SupportsStreaming *bool `json:"supports_streaming,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"` // 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
|
||||
// Width Optional. Video width
|
||||
Width *int `json:"width,omitempty"`
|
||||
// Height Optional. Video height
|
||||
Height *int `json:"height,omitempty"`
|
||||
// Duration Optional. Video duration in seconds
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||
}
|
||||
|
||||
// PhotoSize represents one size of a photo or a file/sticker thumbnail.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#photosize
|
||||
type PhotoSize struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Width Photo width
|
||||
Width int `json:"width"`
|
||||
// Height Photo height
|
||||
Height int `json:"height"`
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// LivePhoto represents a live photo (a photo with a short video attached).
|
||||
// Since: Bot API 10.0
|
||||
type LivePhoto struct {
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
FileID string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Duration int `json:"duration"`
|
||||
MIMEType string `json:"mime_type,omitempty"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Photo Optional. Available sizes of the corresponding static photo
|
||||
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"`
|
||||
// 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"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// MIMEType Optional. MIME type of the file as defined by the sender
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
package tgapi
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestPollAnswerVoterHelpers(t *testing.T) {
|
||||
userAnswer := PollAnswer{User: &User{ID: 42}}
|
||||
user := userAnswer.User
|
||||
if user.ID != 42 {
|
||||
t.Fatalf("unexpected voter user: %#v", user)
|
||||
}
|
||||
if chat := userAnswer.VoterChat; chat != nil {
|
||||
t.Fatalf("unexpected voter chat: %#v", chat)
|
||||
}
|
||||
|
||||
chatAnswer := PollAnswer{VoterChat: &Chat{ID: -100}}
|
||||
chat := chatAnswer.VoterChat
|
||||
if chat.ID != -100 {
|
||||
t.Fatalf("unexpected voter chat: %#v", chat)
|
||||
}
|
||||
}
|
||||
+137
-67
@@ -6,9 +6,15 @@ import "context"
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
type SetMyCommands struct {
|
||||
Commands []BotCommand `json:"commands"`
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// 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"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||
// Defaults to BotCommandScopeDefault.
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetMyCommands changes the list of the bot's commands.
|
||||
@@ -17,7 +23,7 @@ type SetMyCommands struct {
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
func (api *API) SetMyCommands(params SetMyCommands) (bool, error) {
|
||||
req := NewRequest[bool]("setMyCommands", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyCommandsWithContext is the context-aware variant of SetMyCommands.
|
||||
@@ -26,15 +32,19 @@ func (api *API) SetMyCommands(params SetMyCommands) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
func (api *API) SetMyCommandsWithContext(ctx context.Context, params SetMyCommands) (bool, error) {
|
||||
req := NewRequest[bool]("setMyCommands", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteMyCommands holds parameters for the deleteMyCommands method.
|
||||
// Since: Bot API 5.3
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
type DeleteMyCommands struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||
// Defaults to BotCommandScopeDefault.
|
||||
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"`
|
||||
}
|
||||
|
||||
// DeleteMyCommands deletes the list of the bot's commands for the given scope and user language.
|
||||
@@ -43,7 +53,7 @@ type DeleteMyCommands struct {
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
func (api *API) DeleteMyCommands(params DeleteMyCommands) (bool, error) {
|
||||
req := NewRequest[bool]("deleteMyCommands", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteMyCommandsWithContext is the context-aware variant of DeleteMyCommands.
|
||||
@@ -52,15 +62,17 @@ func (api *API) DeleteMyCommands(params DeleteMyCommands) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
func (api *API) DeleteMyCommandsWithContext(ctx context.Context, params DeleteMyCommands) (bool, error) {
|
||||
req := NewRequest[bool]("deleteMyCommands", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetMyCommands holds parameters for the getMyCommands method.
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
type GetMyCommands struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
|
||||
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"`
|
||||
}
|
||||
|
||||
// GetMyCommands returns the current list of the bot's commands for the given scope and user language.
|
||||
@@ -68,7 +80,7 @@ type GetMyCommands struct {
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyCommandsWithContext is the context-aware variant of GetMyCommands.
|
||||
@@ -77,14 +89,18 @@ func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
func (api *API) GetMyCommandsWithContext(ctx context.Context, params GetMyCommands) ([]BotCommand, error) {
|
||||
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetMyName holds parameters for the setMyName method.
|
||||
// Since: Bot API 6.7
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
type SetMyName struct {
|
||||
Name string `json:"name"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
@@ -94,7 +110,7 @@ type SetMyName struct {
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||
req := NewRequest[bool]("setMyName", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyNameWithContext is the context-aware variant of SetMyName.
|
||||
@@ -103,13 +119,14 @@ func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
func (api *API) SetMyNameWithContext(ctx context.Context, params SetMyName) (bool, error) {
|
||||
req := NewRequest[bool]("setMyName", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetMyName holds parameters for the getMyName method.
|
||||
// Since: Bot API 6.7
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
type GetMyName struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
@@ -118,7 +135,7 @@ type GetMyName struct {
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||
req := NewRequest[BotName]("getMyName", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyNameWithContext is the context-aware variant of GetMyName.
|
||||
@@ -127,15 +144,19 @@ func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
func (api *API) GetMyNameWithContext(ctx context.Context, params GetMyName) (BotName, error) {
|
||||
req := NewRequest[BotName]("getMyName", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetMyDescription holds parameters for the setMyDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
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"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// SetMyDescription changes the bot's description.
|
||||
@@ -144,7 +165,7 @@ type SetMyDescription struct {
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDescription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyDescriptionWithContext is the context-aware variant of SetMyDescription.
|
||||
@@ -153,13 +174,14 @@ func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
func (api *API) SetMyDescriptionWithContext(ctx context.Context, params SetMyDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDescription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetMyDescription holds parameters for the getMyDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
type GetMyDescription struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
@@ -168,7 +190,7 @@ type GetMyDescription struct {
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) {
|
||||
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyDescriptionWithContext is the context-aware variant of GetMyDescription.
|
||||
@@ -177,15 +199,19 @@ func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
func (api *API) GetMyDescriptionWithContext(ctx context.Context, params GetMyDescription) (BotDescription, error) {
|
||||
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetMyShortDescription holds parameters for the setMyShortDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
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"`
|
||||
Language string `json:"language_code,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"`
|
||||
}
|
||||
|
||||
// SetMyShortDescription changes the bot's short description.
|
||||
@@ -194,7 +220,7 @@ type SetMyShortDescription struct {
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyShortDescription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyShortDescriptionWithContext is the context-aware variant of SetMyShortDescription.
|
||||
@@ -203,13 +229,14 @@ func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
func (api *API) SetMyShortDescriptionWithContext(ctx context.Context, params SetMyShortDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyShortDescription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetMyShortDescription holds parameters for the getMyShortDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
type GetMyShortDescription struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
@@ -218,7 +245,7 @@ type GetMyShortDescription struct {
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) {
|
||||
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyShortDescriptionWithContext is the context-aware variant of GetMyShortDescription.
|
||||
@@ -227,13 +254,14 @@ func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDes
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
func (api *API) GetMyShortDescriptionWithContext(ctx context.Context, params GetMyShortDescription) (BotShortDescription, error) {
|
||||
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetMyProfilePhoto holds parameters for the setMyProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
type SetMyProfilePhoto struct {
|
||||
// Photo Required. The new profile photo to set
|
||||
Photo InputProfilePhoto `json:"photo"`
|
||||
}
|
||||
|
||||
@@ -243,7 +271,7 @@ type SetMyProfilePhoto struct {
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
func (api *API) SetMyProfilePhoto(params SetMyProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("setMyProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyProfilePhotoWithContext is the context-aware variant of SetMyProfilePhoto.
|
||||
@@ -252,7 +280,7 @@ func (api *API) SetMyProfilePhoto(params SetMyProfilePhoto) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
func (api *API) SetMyProfilePhotoWithContext(ctx context.Context, params SetMyProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("setMyProfilePhoto", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RemoveMyProfilePhoto removes the bot's profile photo.
|
||||
@@ -261,7 +289,7 @@ func (api *API) SetMyProfilePhotoWithContext(ctx context.Context, params SetMyPr
|
||||
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||
func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||
req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RemoveMyProfilePhotoWithContext is the context-aware variant of RemoveMyProfilePhoto.
|
||||
@@ -270,14 +298,18 @@ func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||
func (api *API) RemoveMyProfilePhotoWithContext(ctx context.Context) (bool, error) {
|
||||
req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetChatMenuButton holds parameters for the setChatMenuButton method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
type SetChatMenuButton struct {
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// 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"`
|
||||
// MenuButton Optional. A JSON-serialized object for the bot's new menu button. Defaults to
|
||||
// MenuButtonDefault.
|
||||
MenuButton *MenuButton `json:"menu_button,omitempty"`
|
||||
}
|
||||
|
||||
@@ -287,7 +319,7 @@ type SetChatMenuButton struct {
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
func (api *API) SetChatMenuButton(params SetChatMenuButton) (bool, error) {
|
||||
req := NewRequest[bool]("setChatMenuButton", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetChatMenuButtonWithContext is the context-aware variant of SetChatMenuButton.
|
||||
@@ -296,13 +328,15 @@ func (api *API) SetChatMenuButton(params SetChatMenuButton) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
func (api *API) SetChatMenuButtonWithContext(ctx context.Context, params SetChatMenuButton) (bool, error) {
|
||||
req := NewRequest[bool]("setChatMenuButton", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetChatMenuButton holds parameters for the getChatMenuButton method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -311,7 +345,7 @@ type GetChatMenuButton struct {
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
func (api *API) GetChatMenuButton(params GetChatMenuButton) (MenuButton, error) {
|
||||
req := NewRequest[MenuButton]("getChatMenuButton", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetChatMenuButtonWithContext is the context-aware variant of GetChatMenuButton.
|
||||
@@ -320,15 +354,19 @@ func (api *API) GetChatMenuButton(params GetChatMenuButton) (MenuButton, error)
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
func (api *API) GetChatMenuButtonWithContext(ctx context.Context, params GetChatMenuButton) (MenuButton, error) {
|
||||
req := NewRequest[MenuButton]("getChatMenuButton", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRights holds parameters for the setMyDefaultAdministratorRights method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
type SetMyDefaultAdministratorRights struct {
|
||||
Rights *ChatAdministratorRights `json:"rights"`
|
||||
ForChannels bool `json:"for_channels"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRights changes the default administrator rights for the bot.
|
||||
@@ -337,7 +375,7 @@ type SetMyDefaultAdministratorRights struct {
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRights) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRightsWithContext is the context-aware variant of SetMyDefaultAdministratorRights.
|
||||
@@ -346,13 +384,15 @@ func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministrator
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
func (api *API) SetMyDefaultAdministratorRightsWithContext(ctx context.Context, params SetMyDefaultAdministratorRights) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRights holds parameters for the getMyDefaultAdministratorRights method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -361,7 +401,7 @@ type GetMyDefaultAdministratorRights struct {
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRights) (ChatAdministratorRights, error) {
|
||||
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRightsWithContext is the context-aware variant of GetMyDefaultAdministratorRights.
|
||||
@@ -370,7 +410,7 @@ func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministrator
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
func (api *API) GetMyDefaultAdministratorRightsWithContext(ctx context.Context, params GetMyDefaultAdministratorRights) (ChatAdministratorRights, error) {
|
||||
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetAvailableGifts returns the list of gifts that can be sent by the bot.
|
||||
@@ -378,7 +418,7 @@ func (api *API) GetMyDefaultAdministratorRightsWithContext(ctx context.Context,
|
||||
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||
func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetAvailableGiftsWithContext is the context-aware variant of GetAvailableGifts.
|
||||
@@ -387,20 +427,34 @@ func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||
func (api *API) GetAvailableGiftsWithContext(ctx context.Context) (Gifts, error) {
|
||||
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendGift holds parameters for the sendGift method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
type SendGift struct {
|
||||
UserID int64 `json:"user_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
GiftID string `json:"gift_id"`
|
||||
PayForUpgrade bool `json:"pay_for_upgrade"`
|
||||
Text string `json:"text"`
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// GiftID Required. Identifier of the gift; limited gifts can't be sent to channel chats
|
||||
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"`
|
||||
// Text Optional. Text that will be shown along with the gift; 0-128 characters
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// SendGift sends a gift to the given user or chat.
|
||||
@@ -409,7 +463,7 @@ type SendGift struct {
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
func (api *API) SendGift(params SendGift) (bool, error) {
|
||||
req := NewRequest[bool]("sendGift", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendGiftWithContext is the context-aware variant of SendGift.
|
||||
@@ -418,19 +472,32 @@ func (api *API) SendGift(params SendGift) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
func (api *API) SendGiftWithContext(ctx context.Context, params SendGift) (bool, error) {
|
||||
req := NewRequest[bool]("sendGift", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GiftPremiumSubscription holds parameters for the giftPremiumSubscription method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
type GiftPremiumSubscription struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
MonthCount int `json:"month_count"`
|
||||
StarCount int `json:"star_count"`
|
||||
Text string `json:"text,omitempty"`
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
// UserID Required. Unique identifier of the target user who will receive a Telegram Premium subscription
|
||||
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"`
|
||||
// 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"`
|
||||
// Text Optional. Text that will be shown along with the service message about the subscription; 0-128
|
||||
// characters
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// GiftPremiumSubscription gifts a Telegram Premium subscription to the user.
|
||||
@@ -439,7 +506,7 @@ type GiftPremiumSubscription struct {
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
func (api *API) GiftPremiumSubscription(params GiftPremiumSubscription) (bool, error) {
|
||||
req := NewRequest[bool]("giftPremiumSubscription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GiftPremiumSubscriptionWithContext is the context-aware variant of GiftPremiumSubscription.
|
||||
@@ -448,13 +515,14 @@ func (api *API) GiftPremiumSubscription(params GiftPremiumSubscription) (bool, e
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
func (api *API) GiftPremiumSubscriptionWithContext(ctx context.Context, params GiftPremiumSubscription) (bool, error) {
|
||||
req := NewRequest[bool]("giftPremiumSubscription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetManagedBotAccessSettings holds parameters for the getManagedBotAccessSettings method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
type GetManagedBotAccessSettings struct {
|
||||
// BotUserID identifies the managed bot.
|
||||
BotUserID int64 `json:"bot_user_id"`
|
||||
}
|
||||
|
||||
@@ -463,7 +531,7 @@ type GetManagedBotAccessSettings struct {
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
func (api *API) GetManagedBotAccessSettings(params GetManagedBotAccessSettings) (BotAccessSettings, error) {
|
||||
req := NewRequest[BotAccessSettings]("getManagedBotAccessSettings", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetManagedBotAccessSettingsWithContext is the context-aware variant of GetManagedBotAccessSettings.
|
||||
@@ -472,14 +540,16 @@ func (api *API) GetManagedBotAccessSettings(params GetManagedBotAccessSettings)
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
func (api *API) GetManagedBotAccessSettingsWithContext(ctx context.Context, params GetManagedBotAccessSettings) (BotAccessSettings, error) {
|
||||
req := NewRequest[BotAccessSettings]("getManagedBotAccessSettings", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetManagedBotAccessSettings holds parameters for the setManagedBotAccessSettings method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
type SetManagedBotAccessSettings struct {
|
||||
BotUserID int64 `json:"bot_user_id"`
|
||||
// BotUserID identifies the managed bot.
|
||||
BotUserID int64 `json:"bot_user_id"`
|
||||
// AccessSettings contains the access settings to apply to the managed bot.
|
||||
AccessSettings BotAccessSettings `json:"access_settings"`
|
||||
}
|
||||
|
||||
@@ -489,7 +559,7 @@ type SetManagedBotAccessSettings struct {
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
func (api *API) SetManagedBotAccessSettings(params SetManagedBotAccessSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setManagedBotAccessSettings", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetManagedBotAccessSettingsWithContext is the context-aware variant of SetManagedBotAccessSettings.
|
||||
@@ -498,5 +568,5 @@ func (api *API) SetManagedBotAccessSettings(params SetManagedBotAccessSettings)
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
func (api *API) SetManagedBotAccessSettingsWithContext(ctx context.Context, params SetManagedBotAccessSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setManagedBotAccessSettings", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+34
-6
@@ -4,8 +4,13 @@ package tgapi
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#botcommand
|
||||
type BotCommand struct {
|
||||
Command string `json:"command"`
|
||||
// Command Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and
|
||||
// underscores.
|
||||
Command string `json:"command"`
|
||||
// Description Description of the command; 1-256 characters
|
||||
Description string `json:"description"`
|
||||
// IsEphemeral marks the command as visible only in ephemeral command contexts.
|
||||
IsEphemeral bool `json:"is_ephemeral,omitempty"` // Since: Bot API 10.2
|
||||
}
|
||||
|
||||
// BotCommandScopeType indicates the type of a command scope.
|
||||
@@ -32,26 +37,33 @@ const (
|
||||
// Since: Bot API 5.3
|
||||
// See https://core.telegram.org/bots/api#botcommandscope
|
||||
type BotCommandScope struct {
|
||||
Type BotCommandScopeType `json:"type"`
|
||||
ChatID *int64 `json:"chat_id,omitempty"`
|
||||
UserID *int64 `json:"user_id,omitempty"`
|
||||
// Type identifies the concrete command-scope variant.
|
||||
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"`
|
||||
// UserID Unique identifier of the target user
|
||||
UserID *int64 `json:"user_id,omitempty"`
|
||||
}
|
||||
|
||||
// BotName represents the bot's name.
|
||||
// Since: Bot API 6.7
|
||||
type BotName struct {
|
||||
// Name The bot's name
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// BotDescription represents the bot's description.
|
||||
// Since: Bot API 6.6
|
||||
type BotDescription struct {
|
||||
// Description The bot's description
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// BotShortDescription represents the bot's short description.
|
||||
// Since: Bot API 6.6
|
||||
type BotShortDescription struct {
|
||||
// ShortDescription The bot's short description
|
||||
ShortDescription string `json:"short_description"`
|
||||
}
|
||||
|
||||
@@ -69,13 +81,22 @@ const (
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#inputprofilephoto
|
||||
type InputProfilePhoto struct {
|
||||
// Type identifies the static-photo or animated-photo variant.
|
||||
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)
|
||||
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)
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -95,10 +116,16 @@ const (
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#menubutton
|
||||
type MenuButton struct {
|
||||
// Type identifies the commands, web_app, or default menu-button variant.
|
||||
Type MenuButtonType `json:"type"`
|
||||
|
||||
// Text Text on the 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"`
|
||||
}
|
||||
|
||||
@@ -106,5 +133,6 @@ type MenuButton struct {
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#botaccesssettings
|
||||
type BotAccessSettings struct {
|
||||
// AllowAllPrivateChats reports whether the managed bot may access all private chats of its owner.
|
||||
AllowAllPrivateChats bool `json:"allow_all_private_chats"`
|
||||
}
|
||||
|
||||
+204
-99
@@ -6,7 +6,10 @@ import "context"
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
type VerifyUser struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Unique identifier of the target user
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -16,7 +19,7 @@ type VerifyUser struct {
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
func (api *API) VerifyUser(params VerifyUser) (bool, error) {
|
||||
req := NewRequest[bool]("verifyUser", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// VerifyUserWithContext is the context-aware variant of VerifyUser.
|
||||
@@ -25,14 +28,18 @@ func (api *API) VerifyUser(params VerifyUser) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
func (api *API) VerifyUserWithContext(ctx context.Context, params VerifyUser) (bool, error) {
|
||||
req := NewRequest[bool]("verifyUser", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// VerifyChat holds parameters for the verifyChat method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
type VerifyChat struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
@@ -42,7 +49,7 @@ type VerifyChat struct {
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
func (api *API) VerifyChat(params VerifyChat) (bool, error) {
|
||||
req := NewRequest[bool]("verifyChat", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// VerifyChatWithContext is the context-aware variant of VerifyChat.
|
||||
@@ -51,13 +58,14 @@ func (api *API) VerifyChat(params VerifyChat) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
func (api *API) VerifyChatWithContext(ctx context.Context, params VerifyChat) (bool, error) {
|
||||
req := NewRequest[bool]("verifyChat", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RemoveUserVerification holds parameters for the removeUserVerification method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
type RemoveUserVerification struct {
|
||||
// UserID Required. Unique identifier of the target user
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
@@ -67,7 +75,7 @@ type RemoveUserVerification struct {
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
func (api *API) RemoveUserVerification(params RemoveUserVerification) (bool, error) {
|
||||
req := NewRequest[bool]("removeUserVerification", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RemoveUserVerificationWithContext is the context-aware variant of RemoveUserVerification.
|
||||
@@ -76,13 +84,15 @@ func (api *API) RemoveUserVerification(params RemoveUserVerification) (bool, err
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
func (api *API) RemoveUserVerificationWithContext(ctx context.Context, params RemoveUserVerification) (bool, error) {
|
||||
req := NewRequest[bool]("removeUserVerification", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RemoveChatVerification holds parameters for the removeChatVerification method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -92,7 +102,7 @@ type RemoveChatVerification struct {
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
func (api *API) RemoveChatVerification(params RemoveChatVerification) (bool, error) {
|
||||
req := NewRequest[bool]("removeChatVerification", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RemoveChatVerificationWithContext is the context-aware variant of RemoveChatVerification.
|
||||
@@ -101,16 +111,21 @@ func (api *API) RemoveChatVerification(params RemoveChatVerification) (bool, err
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
func (api *API) RemoveChatVerificationWithContext(ctx context.Context, params RemoveChatVerification) (bool, error) {
|
||||
req := NewRequest[bool]("removeChatVerification", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ReadBusinessMessage holds parameters for the readBusinessMessage method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
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"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_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"`
|
||||
// MessageID Required. Unique identifier of the message to mark as read
|
||||
MessageID int `json:"message_id"`
|
||||
}
|
||||
|
||||
// ReadBusinessMessage marks a business message as read.
|
||||
@@ -119,7 +134,7 @@ type ReadBusinessMessage struct {
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
func (api *API) ReadBusinessMessage(params ReadBusinessMessage) (bool, error) {
|
||||
req := NewRequest[bool]("readBusinessMessage", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ReadBusinessMessageWithContext is the context-aware variant of ReadBusinessMessage.
|
||||
@@ -128,13 +143,14 @@ func (api *API) ReadBusinessMessage(params ReadBusinessMessage) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
func (api *API) ReadBusinessMessageWithContext(ctx context.Context, params ReadBusinessMessage) (bool, error) {
|
||||
req := NewRequest[bool]("readBusinessMessage", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetBusinessConnection holds parameters for the getBusinessConnection method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||
type GetBusinessConnection struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
}
|
||||
|
||||
@@ -143,7 +159,7 @@ type GetBusinessConnection struct {
|
||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||
func (api *API) GetBusinessConnection(params GetBusinessConnection) (BusinessConnection, error) {
|
||||
req := NewRequest[BusinessConnection]("getBusinessConnection", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetBusinessConnectionWithContext is the context-aware variant of GetBusinessConnection.
|
||||
@@ -152,15 +168,19 @@ func (api *API) GetBusinessConnection(params GetBusinessConnection) (BusinessCon
|
||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||
func (api *API) GetBusinessConnectionWithContext(ctx context.Context, params GetBusinessConnection) (BusinessConnection, error) {
|
||||
req := NewRequest[BusinessConnection]("getBusinessConnection", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteBusinessMessages holds parameters for the deleteBusinessMessages method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||
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"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// DeleteBusinessMessages deletes business messages.
|
||||
@@ -169,7 +189,7 @@ type DeleteBusinessMessages struct {
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||
func (api *API) DeleteBusinessMessages(params DeleteBusinessMessages) (bool, error) {
|
||||
req := NewRequest[bool]("deleteBusinessMessages", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteBusinessMessagesWithContext is the context-aware variant of DeleteBusinessMessages.
|
||||
@@ -178,16 +198,19 @@ func (api *API) DeleteBusinessMessages(params DeleteBusinessMessages) (bool, err
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||
func (api *API) DeleteBusinessMessagesWithContext(ctx context.Context, params DeleteBusinessMessages) (bool, error) {
|
||||
req := NewRequest[bool]("deleteBusinessMessages", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountName holds parameters for the setBusinessAccountName method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
type SetBusinessAccountName struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
// FirstName Required. The new value of the first name for the business account; 1-64 characters
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountName sets the first and last name of a business account.
|
||||
@@ -196,7 +219,7 @@ type SetBusinessAccountName struct {
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
func (api *API) SetBusinessAccountName(params SetBusinessAccountName) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountName", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountNameWithContext is the context-aware variant of SetBusinessAccountName.
|
||||
@@ -205,15 +228,17 @@ func (api *API) SetBusinessAccountName(params SetBusinessAccountName) (bool, err
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
func (api *API) SetBusinessAccountNameWithContext(ctx context.Context, params SetBusinessAccountName) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountName", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsername holds parameters for the setBusinessAccountUsername method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
type SetBusinessAccountUsername struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Username string `json:"username,omitempty"`
|
||||
// Username Optional. The new value of the username for the business account; 0-32 characters
|
||||
Username string `json:"username,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsername sets the username of a business account.
|
||||
@@ -222,7 +247,7 @@ type SetBusinessAccountUsername struct {
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsername) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountUsername", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsernameWithContext is the context-aware variant of SetBusinessAccountUsername.
|
||||
@@ -231,15 +256,17 @@ func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsername) (b
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
func (api *API) SetBusinessAccountUsernameWithContext(ctx context.Context, params SetBusinessAccountUsername) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountUsername", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountBio holds parameters for the setBusinessAccountBio method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
type SetBusinessAccountBio struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Bio string `json:"bio,omitempty"`
|
||||
// Bio Optional. The new value of the bio for the business account; 0-140 characters
|
||||
Bio string `json:"bio,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountBio sets the bio of a business account.
|
||||
@@ -248,7 +275,7 @@ type SetBusinessAccountBio struct {
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
func (api *API) SetBusinessAccountBio(params SetBusinessAccountBio) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountBio", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountBioWithContext is the context-aware variant of SetBusinessAccountBio.
|
||||
@@ -257,16 +284,20 @@ func (api *API) SetBusinessAccountBio(params SetBusinessAccountBio) (bool, error
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
func (api *API) SetBusinessAccountBioWithContext(ctx context.Context, params SetBusinessAccountBio) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountBio", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
type SetBusinessAccountProfilePhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Photo InputProfilePhoto `json:"photo,omitempty"`
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// Photo Required. The new profile photo to set
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
|
||||
@@ -275,7 +306,7 @@ type SetBusinessAccountProfilePhoto struct {
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhotoWithContext is the context-aware variant of SetBusinessAccountProfilePhoto.
|
||||
@@ -284,15 +315,19 @@ func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfileP
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
func (api *API) SetBusinessAccountProfilePhotoWithContext(ctx context.Context, params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhoto holds parameters for the removeBusinessAccountProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
type RemoveBusinessAccountProfilePhoto struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
|
||||
@@ -301,7 +336,7 @@ type RemoveBusinessAccountProfilePhoto struct {
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhotoWithContext is the context-aware variant of RemoveBusinessAccountProfilePhoto.
|
||||
@@ -310,16 +345,20 @@ func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountPr
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
func (api *API) RemoveBusinessAccountProfilePhotoWithContext(ctx context.Context, params RemoveBusinessAccountProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettings holds parameters for the setBusinessAccountGiftSettings method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
type SetBusinessAccountGiftSettings struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ShowGiftButton bool `json:"show_gift_button"`
|
||||
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
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"`
|
||||
// AcceptedGiftTypes Required. Types of gifts accepted by the business account
|
||||
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettings sets gift settings for a business account.
|
||||
@@ -328,7 +367,7 @@ type SetBusinessAccountGiftSettings struct {
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettingsWithContext is the context-aware variant of SetBusinessAccountGiftSettings.
|
||||
@@ -337,13 +376,14 @@ func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSett
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
func (api *API) SetBusinessAccountGiftSettingsWithContext(ctx context.Context, params SetBusinessAccountGiftSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalance holds parameters for the getBusinessAccountStarBalance method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
type GetBusinessAccountStarBalance struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
}
|
||||
|
||||
@@ -352,7 +392,7 @@ type GetBusinessAccountStarBalance struct {
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalance) (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getBusinessAccountStarBalance", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalanceWithContext is the context-aware variant of GetBusinessAccountStarBalance.
|
||||
@@ -361,15 +401,17 @@ func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalan
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
func (api *API) GetBusinessAccountStarBalanceWithContext(ctx context.Context, params GetBusinessAccountStarBalance) (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getBusinessAccountStarBalance", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStars holds parameters for the transferBusinessAccountStars method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||
type TransferBusinessAccountStars struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StarCount int `json:"star_count"`
|
||||
// StarCount Required. Number of Telegram Stars to transfer; 1-10000
|
||||
StarCount int `json:"star_count"`
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStars transfers stars from a business account.
|
||||
@@ -378,7 +420,7 @@ type TransferBusinessAccountStars struct {
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||
func (api *API) TransferBusinessAccountStars(params TransferBusinessAccountStars) (bool, error) {
|
||||
req := NewRequest[bool]("transferBusinessAccountStars", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStarsWithContext is the context-aware variant of TransferBusinessAccountStars.
|
||||
@@ -387,24 +429,40 @@ func (api *API) TransferBusinessAccountStars(params TransferBusinessAccountStars
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||
func (api *API) TransferBusinessAccountStarsWithContext(ctx context.Context, params TransferBusinessAccountStars) (bool, error) {
|
||||
req := NewRequest[bool]("transferBusinessAccountStars", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetBusinessAccountGifts holds parameters for the getBusinessAccountGifts method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
type GetBusinessAccountGifts struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||
Offset string `json:"offset,omitempty"`
|
||||
Limit int `json:"limit,omitempty"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
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"`
|
||||
// ExcludeSaved Optional. Pass True to exclude gifts that are saved to the account's profile page
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// ExcludeUnique Optional. Pass True to exclude unique gifts
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// Limit Optional. The maximum number of gifts to be returned; 1-100. Defaults to 100.
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetBusinessAccountGifts returns gifts owned by a business account.
|
||||
@@ -412,7 +470,7 @@ type GetBusinessAccountGifts struct {
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGifts) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetBusinessAccountGiftsWithContext is the context-aware variant of GetBusinessAccountGifts.
|
||||
@@ -421,15 +479,17 @@ func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGifts) (OwnedGi
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
func (api *API) GetBusinessAccountGiftsWithContext(ctx context.Context, params GetBusinessAccountGifts) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ConvertGiftToStars holds parameters for the convertGiftToStars method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
type ConvertGiftToStars struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be converted to Telegram Stars
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
}
|
||||
|
||||
// ConvertGiftToStars converts a gift to Telegram Stars.
|
||||
@@ -438,7 +498,7 @@ type ConvertGiftToStars struct {
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
func (api *API) ConvertGiftToStars(params ConvertGiftToStars) (bool, error) {
|
||||
req := NewRequest[bool]("convertGiftToStars", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ConvertGiftToStarsWithContext is the context-aware variant of ConvertGiftToStars.
|
||||
@@ -447,17 +507,24 @@ func (api *API) ConvertGiftToStars(params ConvertGiftToStars) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
func (api *API) ConvertGiftToStarsWithContext(ctx context.Context, params ConvertGiftToStars) (bool, error) {
|
||||
req := NewRequest[bool]("convertGiftToStars", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UpgradeGift holds parameters for the upgradeGift method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
type UpgradeGift struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
KeepOriginalDetails bool `json:"keep_original_details,omitempty"`
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be upgraded to a unique one
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// UpgradeGift upgrades a gift.
|
||||
@@ -466,7 +533,7 @@ type UpgradeGift struct {
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
func (api *API) UpgradeGift(params UpgradeGift) (bool, error) {
|
||||
req := NewRequest[bool]("upgradeGift", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// UpgradeGiftWithContext is the context-aware variant of UpgradeGift.
|
||||
@@ -475,17 +542,23 @@ func (api *API) UpgradeGift(params UpgradeGift) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
func (api *API) UpgradeGiftWithContext(ctx context.Context, params UpgradeGift) (bool, error) {
|
||||
req := NewRequest[bool]("upgradeGift", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// TransferGift holds parameters for the transferGift method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
type TransferGift struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
NewOwnerChatID int64 `json:"new_owner_chat_id"`
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be transferred
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// TransferGift transfers a gift to another chat.
|
||||
@@ -494,7 +567,7 @@ type TransferGift struct {
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
func (api *API) TransferGift(params TransferGift) (bool, error) {
|
||||
req := NewRequest[bool]("transferGift", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// TransferGiftWithContext is the context-aware variant of TransferGift.
|
||||
@@ -503,23 +576,36 @@ func (api *API) TransferGift(params TransferGift) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
func (api *API) TransferGiftWithContext(ctx context.Context, params TransferGift) (bool, error) {
|
||||
req := NewRequest[bool]("transferGift", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// PostStory holds parameters for the postStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
type PostStory struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Content InputStoryContent `json:"content"`
|
||||
ActivePeriod int `json:"active_period"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// Content Required. Content of the story
|
||||
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"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
Areas []StoryArea `json:"areas"`
|
||||
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||
Areas []StoryArea `json:"areas"`
|
||||
|
||||
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -528,7 +614,7 @@ type PostStory struct {
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
func (api *API) PostStory(params PostStory) (Story, error) {
|
||||
req := NewRequest[Story]("postStory", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// PostStoryWithContext is the context-aware variant of PostStory.
|
||||
@@ -537,19 +623,27 @@ func (api *API) PostStory(params PostStory) (Story, error) {
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
func (api *API) PostStoryWithContext(ctx context.Context, params PostStory) (Story, error) {
|
||||
req := NewRequest[Story]("postStory", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RepostStory holds parameters for the repostStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
type RepostStory struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
FromChatID int64 `json:"from_chat_id"`
|
||||
FromStoryID int `json:"from_story_id"`
|
||||
ActivePeriod int `json:"active_period"`
|
||||
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// FromChatID Required. Unique identifier of the chat which posted the story that should be reposted
|
||||
FromChatID int64 `json:"from_chat_id"`
|
||||
// FromStoryID Required. Unique identifier of the story that should be reposted
|
||||
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"`
|
||||
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||
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"`
|
||||
}
|
||||
|
||||
// RepostStory reposts a story from another chat.
|
||||
@@ -558,7 +652,7 @@ type RepostStory struct {
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
func (api *API) RepostStory(params RepostStory) (Story, error) {
|
||||
req := NewRequest[Story]("repostStory", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RepostStoryWithContext is the context-aware variant of RepostStory.
|
||||
@@ -567,21 +661,30 @@ func (api *API) RepostStory(params RepostStory) (Story, error) {
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
func (api *API) RepostStoryWithContext(ctx context.Context, params RepostStory) (Story, error) {
|
||||
req := NewRequest[Story]("repostStory", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// EditStory holds parameters for the editStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
type EditStory struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StoryID int `json:"story_id"`
|
||||
Content InputStoryContent `json:"content"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// StoryID Required. Unique identifier of the story to edit
|
||||
StoryID int `json:"story_id"`
|
||||
// Content Required. Content of the story
|
||||
Content InputStoryContent `json:"content"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
Areas []StoryArea `json:"areas,omitempty"`
|
||||
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||
Areas []StoryArea `json:"areas,omitempty"`
|
||||
}
|
||||
|
||||
// EditStory edits an existing story.
|
||||
@@ -590,7 +693,7 @@ type EditStory struct {
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
func (api *API) EditStory(params EditStory) (Story, error) {
|
||||
req := NewRequest[Story]("editStory", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// EditStoryWithContext is the context-aware variant of EditStory.
|
||||
@@ -599,15 +702,17 @@ func (api *API) EditStory(params EditStory) (Story, error) {
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
func (api *API) EditStoryWithContext(ctx context.Context, params EditStory) (Story, error) {
|
||||
req := NewRequest[Story]("editStory", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteStory holds parameters for the deleteStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
type DeleteStory struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StoryID int `json:"story_id"`
|
||||
// StoryID Required. Unique identifier of the story to delete
|
||||
StoryID int `json:"story_id"`
|
||||
}
|
||||
|
||||
// DeleteStory deletes a story.
|
||||
@@ -616,7 +721,7 @@ type DeleteStory struct {
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
func (api *API) DeleteStory(params DeleteStory) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStory", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteStoryWithContext is the context-aware variant of DeleteStory.
|
||||
@@ -625,5 +730,5 @@ func (api *API) DeleteStory(params DeleteStory) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
func (api *API) DeleteStoryWithContext(ctx context.Context, params DeleteStory) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStory", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+112
-42
@@ -4,8 +4,11 @@ package tgapi
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessintro
|
||||
type BusinessIntro struct {
|
||||
Title string `json:"title,omitempty"`
|
||||
Message string `json:"message,omitempty"`
|
||||
// Title Optional. Title text of the business intro
|
||||
Title string `json:"title,omitempty"`
|
||||
// Message Optional. Message text of the business intro
|
||||
Message string `json:"message,omitempty"`
|
||||
// Sticker Optional. Sticker of the business intro
|
||||
Sticker *Sticker `json:"sticker,omitempty"`
|
||||
}
|
||||
|
||||
@@ -13,7 +16,9 @@ type BusinessIntro struct {
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businesslocation
|
||||
type BusinessLocation struct {
|
||||
Address string `json:"address"`
|
||||
// Address Address of the business
|
||||
Address string `json:"address"`
|
||||
// Location Optional. Location of the business
|
||||
Location *Location `json:"location,omitempty"`
|
||||
}
|
||||
|
||||
@@ -21,7 +26,11 @@ type BusinessLocation struct {
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
@@ -29,7 +38,9 @@ type BusinessOpeningHoursInterval struct {
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessopeninghours
|
||||
type BusinessOpeningHours struct {
|
||||
TimeZoneName string `json:"time_zone_name"`
|
||||
// TimeZoneName Unique name of the time zone for which the opening hours are defined
|
||||
TimeZoneName string `json:"time_zone_name"`
|
||||
// OpeningHours List of time intervals describing business opening hours
|
||||
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
||||
}
|
||||
|
||||
@@ -38,41 +49,75 @@ type BusinessOpeningHours struct {
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#businessbotrights
|
||||
type BusinessBotRights struct {
|
||||
CanReply *bool `json:"can_reply,omitempty"`
|
||||
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
||||
CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
|
||||
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
|
||||
CanEditName *bool `json:"can_edit_name,omitempty"`
|
||||
CanEditBio *bool `json:"can_edit_bio,omitempty"`
|
||||
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
|
||||
CanEditUsername *bool `json:"can_edit_username,omitempty"`
|
||||
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
|
||||
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
|
||||
CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
|
||||
// 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"`
|
||||
// CanReadMessages Optional. True, if the bot can mark incoming private messages as read
|
||||
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"`
|
||||
// CanDeleteAllMessages Optional. True, if the bot can delete all private messages in managed chats
|
||||
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"`
|
||||
// CanEditBio Optional. True, if the bot can edit the bio of the business account
|
||||
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"`
|
||||
// CanEditUsername Optional. True, if the bot can edit the username of the business account
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||
CanManageStories *bool `json:"can_manage_stories,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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// BusinessConnection contains information about a business connection.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessconnection
|
||||
type BusinessConnection struct {
|
||||
ID string `json:"id"`
|
||||
User User `json:"user"`
|
||||
UserChatID int64 `json:"user_chat_id"`
|
||||
Date int `json:"date"`
|
||||
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||
IsEnabled bool `json:"is_enabled"`
|
||||
// ID Unique identifier of the business connection
|
||||
ID string `json:"id"`
|
||||
// User Business account user that created the business connection
|
||||
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"`
|
||||
// Date Date the connection was established in Unix time
|
||||
Date int `json:"date"`
|
||||
// Rights Optional. Rights of the business bot
|
||||
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||
// IsEnabled True, if the connection is active
|
||||
IsEnabled bool `json:"is_enabled"`
|
||||
}
|
||||
|
||||
// BusinessMessagesDeleted is received when messages are deleted from a connected business account.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessmessagesdeleted
|
||||
type BusinessMessagesDeleted struct {
|
||||
// BusinessConnectionID Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Chat Chat `json:"chat"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
// 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"`
|
||||
// MessageIDs The list of identifiers of deleted messages in the chat of the business account
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
}
|
||||
|
||||
// InputStoryContentType indicates the type of input story content.
|
||||
@@ -89,27 +134,38 @@ const (
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#inputstorycontent
|
||||
type InputStoryContent struct {
|
||||
// Type identifies the photo or video story-content variant.
|
||||
Type InputStoryContentType `json:"type"`
|
||||
|
||||
// Photo fields
|
||||
Photo *string `json:"photo,omitempty"`
|
||||
|
||||
// Video fields
|
||||
Video *string `json:"video,omitempty"`
|
||||
Duration *float64 `json:"duration,omitempty"`
|
||||
Video *string `json:"video,omitempty"`
|
||||
// Duration Optional. Precise duration of the video in seconds; 0-60
|
||||
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"`
|
||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||
// IsAnimation Optional. Pass True if the video has no sound
|
||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||
}
|
||||
|
||||
// StoryAreaPosition describes the position of a clickable area on a story.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#storyareaposition
|
||||
type StoryAreaPosition struct {
|
||||
XPercentage float64 `json:"x_percentage"`
|
||||
YPercentage float64 `json:"y_percentage"`
|
||||
WidthPercentage float64 `json:"width_percentage"`
|
||||
HeightPercentage float64 `json:"height_percentage"`
|
||||
RotationAngle float64 `json:"rotation_angle"`
|
||||
// XPercentage The abscissa of the area's center, as a percentage of the media width
|
||||
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"`
|
||||
// WidthPercentage The width of the area's rectangle, as a percentage of the media width
|
||||
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"`
|
||||
// RotationAngle The clockwise rotation angle of the rectangle, in degrees; 0-360
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -133,26 +189,38 @@ const (
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#storyareatype
|
||||
type StoryAreaType struct {
|
||||
// Type identifies the concrete story-area variant.
|
||||
Type StoryAreaTypeType `json:"type"`
|
||||
|
||||
// Latitude Location latitude in degrees
|
||||
// Location
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
Address *LocationAddress `json:"address,omitempty"`
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
// Longitude Location longitude in degrees
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
// Address Optional. Address of the location
|
||||
Address *LocationAddress `json:"address,omitempty"`
|
||||
|
||||
// ReactionType Type of the reaction
|
||||
// Suggested reaction
|
||||
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
||||
IsDark *bool `json:"is_dark,omitempty"`
|
||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||
// IsDark Optional. Pass True if the reaction area has a dark background
|
||||
IsDark *bool `json:"is_dark,omitempty"`
|
||||
// IsFlipped Optional. Pass True if reaction area corner is flipped
|
||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||
|
||||
// URL HTTP or tg:// URL to be opened when the area is clicked
|
||||
// Link
|
||||
URL *string `json:"url,omitempty"`
|
||||
|
||||
// Temperature Temperature, in degree Celsius
|
||||
// Weather
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
BackgroundColor *int `json:"background_color,omitempty"`
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
// Emoji Emoji representing the weather
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
// BackgroundColor A color of the area background in the ARGB format
|
||||
BackgroundColor *int `json:"background_color,omitempty"`
|
||||
|
||||
// Name Unique name of the gift
|
||||
// Unique gift
|
||||
Name *string `json:"name,omitempty"`
|
||||
}
|
||||
@@ -161,6 +229,8 @@ type StoryAreaType struct {
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#storyarea
|
||||
type StoryArea struct {
|
||||
// Position Position of the area
|
||||
Position StoryAreaPosition `json:"position"`
|
||||
Type StoryAreaType `json:"type"`
|
||||
// Type Type of the area
|
||||
Type StoryAreaType `json:"type"`
|
||||
}
|
||||
|
||||
+409
-144
File diff suppressed because it is too large
Load Diff
+417
-141
@@ -4,14 +4,25 @@ package tgapi
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#chat
|
||||
type Chat struct {
|
||||
ID int64 `json:"id"`
|
||||
Type ChatType `json:"type"`
|
||||
Title *string `json:"title,omitempty"`
|
||||
Username *string `json:"username,omitempty"`
|
||||
FirstName *string `json:"first_name,omitempty"`
|
||||
LastName *string `json:"last_name,omitempty"`
|
||||
IsForum *bool `json:"is_forum,omitempty"` // Since: Bot API 6.3
|
||||
IsDirectMessages *bool `json:"is_direct_messages,omitempty"` // Since: Bot API 9.2
|
||||
// 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"`
|
||||
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||
Type ChatType `json:"type"`
|
||||
// Title Optional. Title, for supergroups, channels and group chats
|
||||
Title *string `json:"title,omitempty"`
|
||||
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||
Username *string `json:"username,omitempty"`
|
||||
// FirstName Optional. First name of the other party in a private chat
|
||||
FirstName *string `json:"first_name,omitempty"`
|
||||
// LastName Optional. Last name of the other party in a private chat
|
||||
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
|
||||
// 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
|
||||
}
|
||||
|
||||
// ChatType represents the type of a chat.
|
||||
@@ -32,123 +43,254 @@ const (
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#chatfullinfo
|
||||
type ChatFullInfo struct {
|
||||
ID int64 `json:"id"`
|
||||
Type ChatType `json:"type"`
|
||||
Title string `json:"title"`
|
||||
Username string `json:"username"`
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name"`
|
||||
IsForum bool `json:"is_forum"`
|
||||
IsDirectMessages bool `json:"is_direct_messages"`
|
||||
AccentColorID int `json:"accent_color_id"`
|
||||
MaxReactionCount int `json:"max_reaction_count"`
|
||||
Photo *ChatPhoto `json:"photo,omitempty"`
|
||||
ActiveUsernames []string `json:"active_usernames,omitempty"`
|
||||
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
||||
// 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"`
|
||||
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||
Type ChatType `json:"type"`
|
||||
// Title Optional. Title, for supergroups, channels and group chats
|
||||
Title string `json:"title"`
|
||||
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||
Username string `json:"username"`
|
||||
// FirstName Optional. First name of the other party in a private chat
|
||||
FirstName string `json:"first_name"`
|
||||
// LastName Optional. Last name of the other party in a private chat
|
||||
LastName string `json:"last_name"`
|
||||
// IsForum Optional. True, if the supergroup chat is a forum (has topics enabled)
|
||||
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"`
|
||||
// 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"`
|
||||
// MaxReactionCount The maximum number of reactions that can be set on a message in the chat
|
||||
MaxReactionCount int `json:"max_reaction_count"`
|
||||
// Photo Optional. Chat photo
|
||||
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"`
|
||||
// Birthdate Optional. For private chats, the date of birth of the user
|
||||
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
||||
|
||||
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
||||
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
||||
// BusinessIntro Optional. For private chats with business accounts, the intro of the business
|
||||
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"`
|
||||
// BusinessOpeningHours Optional. For private chats with business accounts, the opening hours of the
|
||||
// business
|
||||
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
|
||||
|
||||
// PersonalChat Optional. For private chats, the personal channel of the user
|
||||
PersonalChat *Chat `json:"personal_chat,omitempty"`
|
||||
ParentChat *Chat `json:"parent_chat,omitempty"` // Since: Bot API 9.2
|
||||
// ParentChat Optional. Information about the corresponding channel chat; for direct messages chats only
|
||||
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.
|
||||
AvailableReactions []ReactionType `json:"available_reactions,omitempty"`
|
||||
|
||||
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
||||
ProfileAccentColorID *int `json:"profile_accent_color_id,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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
EmojiStatusCustomEmojiID *string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||
EmojiStatusExpirationDate *int `json:"emoji_status_expiration_date,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"`
|
||||
// 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"`
|
||||
|
||||
Bio *string `json:"bio,omitempty"`
|
||||
HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
|
||||
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
|
||||
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
|
||||
JoinByRequest *bool `json:"join_by_request,omitempty"`
|
||||
// Bio Optional. Bio of the other party in a private chat
|
||||
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"`
|
||||
// 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"`
|
||||
// JoinToSendMessages Optional. True, if users need to join the supergroup before they can send messages
|
||||
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"`
|
||||
|
||||
Description *string `json:"description,omitempty"`
|
||||
InviteLink *string `json:"invite_link,omitempty"`
|
||||
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
||||
Permissions *ChatPermissions `json:"permissions,omitempty"`
|
||||
// Description Optional. Description, for groups, supergroups and channel chats
|
||||
Description *string `json:"description,omitempty"`
|
||||
// InviteLink Optional. Primary invite link, for groups, supergroups and channel chats
|
||||
InviteLink *string `json:"invite_link,omitempty"`
|
||||
// PinnedMessage Optional. The most recent pinned message (by sending date)
|
||||
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
||||
// Permissions Optional. Default chat member permissions, for groups and supergroups
|
||||
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"`
|
||||
|
||||
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
|
||||
SlowModeDelay *int `json:"slow_mode_delay,omitempty"`
|
||||
UnrestrictedBoostCount *int `json:"unrestricted_boost_count,omitempty"`
|
||||
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty"`
|
||||
HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
|
||||
HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
|
||||
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
|
||||
HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
|
||||
StickerSetName *string `json:"sticker_set_name,omitempty"`
|
||||
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
|
||||
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty"`
|
||||
LinkedChatID *int64 `json:"linked_chat_id,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"`
|
||||
// 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"`
|
||||
// UnrestrictedBoostCount is the number of unrestricted boosts available to the chat.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// HasProtectedContent Optional. True, if messages from the chat can't be forwarded to other chats
|
||||
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"`
|
||||
// StickerSetName Optional. For supergroups, name of the group sticker set
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Location *ChatLocation `json:"location,omitempty"`
|
||||
Rating *UserRating `json:"rating,omitempty"`
|
||||
FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"` // Since: Bot API 9.4
|
||||
UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"` // Since: Bot API 9.3
|
||||
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` // Since: Bot API 9.3
|
||||
// Location Optional. For supergroups, the location to which the supergroup is connected
|
||||
Location *ChatLocation `json:"location,omitempty"`
|
||||
// Rating Optional. For private chats, the rating of the user if any
|
||||
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
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
// Community contains information about the affected community.
|
||||
Community *Community `json:"community,omitempty"` // Since: Bot API 10.2
|
||||
}
|
||||
|
||||
// ChatPhoto represents a chat photo.
|
||||
// Since: Bot API 3.1
|
||||
// See https://core.telegram.org/bots/api#chatphoto
|
||||
type ChatPhoto struct {
|
||||
SmallFileID string `json:"small_file_id"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
BigFileID string `json:"big_file_id"`
|
||||
BigFileUniqueID string `json:"big_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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// ChatPermissions describes actions that a non‑administrator user is allowed to take in a chat.
|
||||
// Since: Bot API 4.4
|
||||
// See https://core.telegram.org/bots/api#chatpermissions
|
||||
type ChatPermissions struct {
|
||||
CanSendMessages bool `json:"can_send_messages"`
|
||||
CanSendAudios bool `json:"can_send_audios"` // Since: Bot API 6.5
|
||||
CanSendDocuments bool `json:"can_send_documents"` // Since: Bot API 6.5
|
||||
CanSendPhotos bool `json:"can_send_photos"` // Since: Bot API 6.5
|
||||
CanSendVideos bool `json:"can_send_videos"` // Since: Bot API 6.5
|
||||
CanSendVideoNotes bool `json:"can_send_video_notes"` // Since: Bot API 6.5
|
||||
CanSendVoiceNotes bool `json:"can_send_voice_notes"` // Since: Bot API 6.5
|
||||
CanSendPolls bool `json:"can_send_polls"`
|
||||
// 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"`
|
||||
// CanSendAudios Optional. True, if the user is allowed to send audios
|
||||
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
|
||||
// CanSendPhotos Optional. True, if the user is allowed to send photos
|
||||
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
|
||||
// CanSendVideoNotes Optional. True, if the user is allowed to send video notes
|
||||
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
|
||||
// CanSendPolls Optional. True, if the user is allowed to send polls and checklists
|
||||
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"`
|
||||
// CanAddWebPagePreview Optional. True, if the user is allowed to add web page previews to their messages
|
||||
CanAddWebPagePreview bool `json:"can_add_web_page_previews"`
|
||||
CanReactToMessages bool `json:"can_react_to_messages"` // Since: Bot API 10.0
|
||||
CanEditTag bool `json:"can_edit_tag"` // Since: Bot API 9.5
|
||||
CanChangeInfo bool `json:"can_change_info"`
|
||||
CanInviteUsers bool `json:"can_invite_users"`
|
||||
CanPinMessages bool `json:"can_pin_messages"`
|
||||
CanManageTopics bool `json:"can_manage_topics"` // Since: Bot API 6.3
|
||||
// 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
|
||||
// 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
|
||||
// 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"`
|
||||
// CanInviteUsers Optional. True, if the user is allowed to invite new users to the chat
|
||||
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"`
|
||||
// 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
|
||||
}
|
||||
|
||||
// ChatLocation represents a location to which a chat is connected.
|
||||
// Since: Bot API 5.0
|
||||
// See https://core.telegram.org/bots/api#chatlocation
|
||||
type ChatLocation struct {
|
||||
// Location The location to which the supergroup is connected. Can't be a live location.
|
||||
Location Location `json:"location"`
|
||||
Address string `json:"address"`
|
||||
// Address Location address; 1-64 characters, as defined by the chat owner
|
||||
Address string `json:"address"`
|
||||
}
|
||||
|
||||
// ChatInviteLink represents an invite link for a chat.
|
||||
// Since: Bot API 5.1
|
||||
// See https://core.telegram.org/bots/api#chatinvitelink
|
||||
type ChatInviteLink struct {
|
||||
InviteLink string `json:"invite_link"`
|
||||
Creator User `json:"creator"`
|
||||
CreateJoinRequest bool `json:"creates_join_request"`
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
IsRevoked bool `json:"is_revoked"`
|
||||
// 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"`
|
||||
// Creator Creator of the link
|
||||
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"`
|
||||
// IsPrimary True, if the link is primary
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
// IsRevoked True, if the link is revoked
|
||||
IsRevoked bool `json:"is_revoked"`
|
||||
|
||||
Name *string `json:"name,omitempty"`
|
||||
ExpireDate *int `json:"expire_date,omitempty"`
|
||||
MemberLimit *int `json:"member_limit,omitempty"`
|
||||
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
|
||||
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
|
||||
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
||||
// Name Optional. Invite link name
|
||||
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"`
|
||||
// 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"`
|
||||
// PendingJoinRequestCount Optional. Number of pending join requests created using this link
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// ChatMemberStatusType indicates the status of a chat member.
|
||||
@@ -173,92 +315,156 @@ const (
|
||||
// Since: Bot API 3.1
|
||||
// See https://core.telegram.org/bots/api#chatmember
|
||||
type ChatMember struct {
|
||||
// Status is the member's current status in the chat.
|
||||
Status ChatMemberStatusType `json:"status"`
|
||||
User User `json:"user"`
|
||||
Tag string `json:"tag,omitempty"` // Since: Bot API 9.5
|
||||
// User Information about the user
|
||||
User User `json:"user"`
|
||||
// Tag Optional. Tag of the member
|
||||
Tag string `json:"tag,omitempty"` // Since: Bot API 9.5
|
||||
|
||||
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||
// Owner
|
||||
IsAnonymous *bool `json:"is_anonymous"`
|
||||
IsAnonymous *bool `json:"is_anonymous"`
|
||||
// CustomTitle Optional. Custom title for this user
|
||||
CustomTitle *string `json:"custom_title,omitempty"`
|
||||
|
||||
// CanBeEdited True, if the bot is allowed to edit administrator privileges of that user
|
||||
// Administrator
|
||||
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
||||
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
||||
CanDeleteMessages *bool `json:"can_delete_messages,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"`
|
||||
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
||||
// CanManageVideoChats True, if the administrator can manage video chats
|
||||
CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`
|
||||
CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
|
||||
CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
|
||||
CanChangeInfo *bool `json:"can_change_info,omitempty"`
|
||||
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
|
||||
CanPostStories *bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
||||
CanEditStories *bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
||||
CanDeleteStories *bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
||||
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||
// supergroup statistics
|
||||
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"`
|
||||
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||
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"`
|
||||
// CanPostStories True, if the administrator can post stories to the chat
|
||||
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
|
||||
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||
CanDeleteStories *bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
||||
// CanSendWelcomeMessages reports whether the administrator can manage chat welcome messages or send them as a bot.
|
||||
CanSendWelcomeMessages *bool `json:"can_send_welcome_messages,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
||||
// 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"`
|
||||
// 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"`
|
||||
// CanPinMessages reports whether the member may pin messages.
|
||||
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
|
||||
// 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
|
||||
CanManageTags *bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
||||
// 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
|
||||
|
||||
// UntilDate is the Unix time when restrictions expire; zero means forever.
|
||||
// Member
|
||||
UntilDate *int `json:"until_date,omitempty"`
|
||||
|
||||
// IsMember True, if the user is a member of the chat at the moment of the request
|
||||
// Restricted
|
||||
IsMember *bool `json:"is_member,omitempty"`
|
||||
CanSendMessages *bool `json:"can_send_messages,omitempty"`
|
||||
CanSendAudios *bool `json:"can_send_audios,omitempty"` // Since: Bot API 6.5
|
||||
CanSendDocuments *bool `json:"can_send_documents,omitempty"` // Since: Bot API 6.5
|
||||
CanSendPhotos *bool `json:"can_send_photos,omitempty"` // Since: Bot API 6.5
|
||||
CanSendVideos *bool `json:"can_send_videos,omitempty"` // Since: Bot API 6.5
|
||||
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"` // Since: Bot API 6.5
|
||||
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"` // Since: Bot API 6.5
|
||||
CanSendPolls *bool `json:"can_send_polls,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"`
|
||||
// CanSendAudios True, if the user is allowed to send audios
|
||||
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
|
||||
// CanSendPhotos True, if the user is allowed to send photos
|
||||
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
|
||||
// CanSendVideoNotes True, if the user is allowed to send video notes
|
||||
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
|
||||
// CanSendPolls True, if the user is allowed to send polls and checklists
|
||||
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"`
|
||||
// CanAddWebPagePreview True, if the user is allowed to add web page previews to their messages
|
||||
CanAddWebPagePreview *bool `json:"can_add_web_page_previews,omitempty"`
|
||||
CanReactToMessages *bool `json:"can_react_to_messages,omitempty"` // Since: Bot API 10.0
|
||||
CanEditTag *bool `json:"can_edit_tag,omitempty"` // Since: Bot API 9.5
|
||||
// CanReactToMessages True, if the user is allowed to react to messages
|
||||
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
|
||||
}
|
||||
|
||||
// ChatBoostSource describes the source of a chat boost.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboostsource
|
||||
type ChatBoostSource struct {
|
||||
// Source identifies the source variant: premium, gift_code, or giveaway.
|
||||
Source string `json:"source"`
|
||||
User User `json:"user"`
|
||||
// User is the user responsible for the boost when supplied by the source variant.
|
||||
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
|
||||
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
||||
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
||||
IsUnclaimed *bool `json:"is_unclaimed,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"`
|
||||
// IsUnclaimed Optional. True, if the giveaway was completed, but there was no user to win the prize
|
||||
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoost represents a boost added to a chat.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboost
|
||||
type ChatBoost struct {
|
||||
BoostID string `json:"boost_id"`
|
||||
AddDate int `json:"add_date"`
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
Source ChatBoostSource `json:"source"`
|
||||
// BoostID Unique identifier of the boost
|
||||
BoostID string `json:"boost_id"`
|
||||
// AddDate Point in time (Unix timestamp) when the chat was boosted
|
||||
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"`
|
||||
// Source Source of the added boost
|
||||
Source ChatBoostSource `json:"source"`
|
||||
}
|
||||
|
||||
// UserChatBoosts represents a list of boosts a user has given to a chat.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#userchatboosts
|
||||
type UserChatBoosts struct {
|
||||
// Boosts The list of boosts added to the chat by the user
|
||||
Boosts []ChatBoost `json:"boosts"`
|
||||
}
|
||||
|
||||
// ChatBoostAdded describes a service message about a user boosting a chat.
|
||||
// Since: Bot API 7.1
|
||||
type ChatBoostAdded struct {
|
||||
// BoostCount Number of boosts added by the user
|
||||
BoostCount int `json:"boost_count"`
|
||||
}
|
||||
|
||||
// ChatBackground represents a chat background.
|
||||
// Since: Bot API 7.5
|
||||
type ChatBackground struct {
|
||||
// Type Type of the background
|
||||
Type BackgroundType `json:"type"`
|
||||
}
|
||||
|
||||
@@ -266,6 +472,8 @@ type ChatBackground struct {
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#chatownerleft
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -273,6 +481,7 @@ type ChatOwnerLeft struct {
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#chatownerchanged
|
||||
type ChatOwnerChanged struct {
|
||||
// NewOwner The new owner of the chat
|
||||
NewOwner User `json:"new_owner"`
|
||||
}
|
||||
|
||||
@@ -280,31 +489,63 @@ type ChatOwnerChanged struct {
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#chatadministratorrights
|
||||
type ChatAdministratorRights struct {
|
||||
IsAnonymous bool `json:"is_anonymous"`
|
||||
CanManageChat bool `json:"can_manage_chat"`
|
||||
CanDeleteMessages bool `json:"can_delete_messages"`
|
||||
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||
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"`
|
||||
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||
CanDeleteMessages bool `json:"can_delete_messages"`
|
||||
// CanManageVideoChats True, if the administrator can manage video chats
|
||||
CanManageVideoChats bool `json:"can_manage_video_chats"`
|
||||
CanRestrictMembers bool `json:"can_restrict_members"`
|
||||
CanPromoteMembers bool `json:"can_promote_members"`
|
||||
CanChangeInfo bool `json:"can_change_info"`
|
||||
CanInviteUsers bool `json:"can_invite_users"`
|
||||
CanPostStories bool `json:"can_post_stories"`
|
||||
CanEditStories bool `json:"can_edit_stories"`
|
||||
CanDeleteStories bool `json:"can_delete_stories"`
|
||||
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||
// supergroup statistics
|
||||
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"`
|
||||
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||
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"`
|
||||
// CanPostStories True, if the administrator can post stories to the chat
|
||||
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"`
|
||||
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||
CanDeleteStories bool `json:"can_delete_stories"`
|
||||
|
||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// CanPinMessages Optional. True, if the user is allowed to pin messages; for groups and supergroups only
|
||||
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"`
|
||||
// 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"`
|
||||
CanManageTags *bool `json:"can_manage_tags,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"`
|
||||
// CanSendWelcomeMessages reports whether the administrator can manage chat welcome messages or send them as a bot.
|
||||
CanSendWelcomeMessages *bool `json:"can_send_welcome_messages,omitempty"` // Since: Bot API 10.3
|
||||
}
|
||||
|
||||
// ChatBoostUpdated represents a boost added to a chat or changed.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboostupdated
|
||||
type ChatBoostUpdated struct {
|
||||
Chat Chat `json:"chat"`
|
||||
// Chat Chat which was boosted
|
||||
Chat Chat `json:"chat"`
|
||||
// Boost Information about the chat boost
|
||||
Boost ChatBoost `json:"boost"`
|
||||
}
|
||||
|
||||
@@ -312,8 +553,43 @@ type ChatBoostUpdated struct {
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboostremoved
|
||||
type ChatBoostRemoved struct {
|
||||
Chat Chat `json:"chat"`
|
||||
BoostID string `json:"boost_id"`
|
||||
RemoveDate int `json:"remove_date"`
|
||||
Source ChatBoostSource `json:"source"`
|
||||
// Chat Chat which was boosted
|
||||
Chat Chat `json:"chat"`
|
||||
// BoostID Unique identifier of the boost
|
||||
BoostID string `json:"boost_id"`
|
||||
// RemoveDate Point in time (Unix timestamp) when the boost was removed
|
||||
RemoveDate int `json:"remove_date"`
|
||||
// Source Source of the removed boost
|
||||
Source ChatBoostSource `json:"source"`
|
||||
}
|
||||
|
||||
// Community represents a group of chats.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type Community struct {
|
||||
// ID uniquely identifies the value within its containing object.
|
||||
ID int64 `json:"id"`
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// CommunityChatAdded describes a service message about a chat joining a community.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type CommunityChatAdded struct {
|
||||
// Community contains information about the affected community.
|
||||
Community Community `json:"community"`
|
||||
}
|
||||
|
||||
// CommunityChatJoined describes a service message about a chat being joined by a user from a community.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type CommunityChatJoined struct {
|
||||
// Community contains information about the community from which the user joined the chat.
|
||||
Community Community `json:"community"`
|
||||
}
|
||||
|
||||
// CommunityChatRemoved describes a service message about a chat leaving a community.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type CommunityChatRemoved struct{}
|
||||
|
||||
+28
-2
@@ -14,11 +14,37 @@ var ErrPoolQueueFull = errors.New("worker pool queue full")
|
||||
// ErrPoolStopped reports that a request was submitted after the 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.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
var ErrRichMessageDraftUploadUnsupported = errors.New("sendRichMessageDraft does not support direct file uploads")
|
||||
|
||||
// ResponseError reports an unsuccessful Telegram API response.
|
||||
type ResponseError struct {
|
||||
Code int
|
||||
// Code is the Telegram API error code.
|
||||
Code int
|
||||
// Description is the human-readable Telegram API error description.
|
||||
Description string
|
||||
Parameters *ResponseParameters
|
||||
// Parameters contains additional recovery metadata such as retry_after.
|
||||
Parameters *ResponseParameters
|
||||
}
|
||||
|
||||
// Error returns the Telegram API error code and description.
|
||||
|
||||
+54
-35
@@ -5,8 +5,10 @@ import "context"
|
||||
// BaseForumTopic contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
||||
// Since: Bot API 6.3
|
||||
type BaseForumTopic struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
// ChatID identifies the target supergroup.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID identifies the target forum topic.
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
}
|
||||
|
||||
// GetForumTopicIconStickers returns the list of custom emoji that can be used as a forum topic icon.
|
||||
@@ -14,7 +16,7 @@ type BaseForumTopic struct {
|
||||
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||
func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetForumTopicIconStickersWithContext is the context-aware variant of GetForumTopicIconStickers.
|
||||
@@ -23,17 +25,25 @@ func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||
func (api *API) GetForumTopicIconStickersWithContext(ctx context.Context) ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CreateForumTopic holds parameters for the createForumTopic method.
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
type CreateForumTopic struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name"`
|
||||
IconColor ForumTopicIconColor `json:"icon_color"`
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||
// @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// Name Required. Topic name, 1-128 characters
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// CreateForumTopic creates a topic in a forum supergroup.
|
||||
@@ -42,7 +52,7 @@ type CreateForumTopic struct {
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
func (api *API) CreateForumTopic(params CreateForumTopic) (ForumTopic, error) {
|
||||
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CreateForumTopicWithContext is the context-aware variant of CreateForumTopic.
|
||||
@@ -51,7 +61,7 @@ func (api *API) CreateForumTopic(params CreateForumTopic) (ForumTopic, error) {
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
func (api *API) CreateForumTopicWithContext(ctx context.Context, params CreateForumTopic) (ForumTopic, error) {
|
||||
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// EditForumTopic holds parameters for the editForumTopic method.
|
||||
@@ -59,7 +69,12 @@ func (api *API) CreateForumTopicWithContext(ctx context.Context, params CreateFo
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
type EditForumTopic struct {
|
||||
BaseForumTopic
|
||||
Name string `json:"name"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
@@ -69,7 +84,7 @@ type EditForumTopic struct {
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
func (api *API) EditForumTopic(params EditForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// EditForumTopicWithContext is the context-aware variant of EditForumTopic.
|
||||
@@ -78,7 +93,7 @@ func (api *API) EditForumTopic(params EditForumTopic) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
func (api *API) EditForumTopicWithContext(ctx context.Context, params EditForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CloseForumTopic closes an open forum topic.
|
||||
@@ -87,7 +102,7 @@ func (api *API) EditForumTopicWithContext(ctx context.Context, params EditForumT
|
||||
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||
func (api *API) CloseForumTopic(params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CloseForumTopicWithContext is the context-aware variant of CloseForumTopic.
|
||||
@@ -96,7 +111,7 @@ func (api *API) CloseForumTopic(params BaseForumTopic) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||
func (api *API) CloseForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ReopenForumTopic reopens a closed forum topic.
|
||||
@@ -105,7 +120,7 @@ func (api *API) CloseForumTopicWithContext(ctx context.Context, params BaseForum
|
||||
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||
func (api *API) ReopenForumTopic(params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ReopenForumTopicWithContext is the context-aware variant of ReopenForumTopic.
|
||||
@@ -114,7 +129,7 @@ func (api *API) ReopenForumTopic(params BaseForumTopic) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||
func (api *API) ReopenForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteForumTopic deletes a forum topic.
|
||||
@@ -123,7 +138,7 @@ func (api *API) ReopenForumTopicWithContext(ctx context.Context, params BaseForu
|
||||
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||
func (api *API) DeleteForumTopic(params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteForumTopicWithContext is the context-aware variant of DeleteForumTopic.
|
||||
@@ -132,7 +147,7 @@ func (api *API) DeleteForumTopic(params BaseForumTopic) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||
func (api *API) DeleteForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UnpinAllForumTopicMessages clears the list of pinned messages in a forum topic.
|
||||
@@ -141,7 +156,7 @@ func (api *API) DeleteForumTopicWithContext(ctx context.Context, params BaseForu
|
||||
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||
func (api *API) UnpinAllForumTopicMessages(params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// UnpinAllForumTopicMessagesWithContext is the context-aware variant of UnpinAllForumTopicMessages.
|
||||
@@ -150,12 +165,13 @@ func (api *API) UnpinAllForumTopicMessages(params BaseForumTopic) (bool, error)
|
||||
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||
func (api *API) UnpinAllForumTopicMessagesWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// BaseGeneralForumTopic contains common fields for general forum topic operations that require a chat ID.
|
||||
// Since: Bot API 6.4
|
||||
type BaseGeneralForumTopic struct {
|
||||
// ChatID identifies the target supergroup.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
@@ -163,8 +179,11 @@ type BaseGeneralForumTopic struct {
|
||||
// Since: Bot API 6.4
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
type EditGeneralForumTopic struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||
// @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// Name Required. New topic name, 1-128 characters
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// EditGeneralForumTopic edits the name of the 'General' topic in a forum supergroup.
|
||||
@@ -173,7 +192,7 @@ type EditGeneralForumTopic struct {
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
func (api *API) EditGeneralForumTopic(params EditGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// EditGeneralForumTopicWithContext is the context-aware variant of EditGeneralForumTopic.
|
||||
@@ -182,7 +201,7 @@ func (api *API) EditGeneralForumTopic(params EditGeneralForumTopic) (bool, error
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
func (api *API) EditGeneralForumTopicWithContext(ctx context.Context, params EditGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CloseGeneralForumTopic closes the 'General' topic in a forum supergroup.
|
||||
@@ -191,7 +210,7 @@ func (api *API) EditGeneralForumTopicWithContext(ctx context.Context, params Edi
|
||||
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||
func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CloseGeneralForumTopicWithContext is the context-aware variant of CloseGeneralForumTopic.
|
||||
@@ -200,7 +219,7 @@ func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopic) (bool, erro
|
||||
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||
func (api *API) CloseGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ReopenGeneralForumTopic reopens the 'General' topic in a forum supergroup.
|
||||
@@ -209,7 +228,7 @@ func (api *API) CloseGeneralForumTopicWithContext(ctx context.Context, params Ba
|
||||
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||
func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ReopenGeneralForumTopicWithContext is the context-aware variant of ReopenGeneralForumTopic.
|
||||
@@ -218,7 +237,7 @@ func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopic) (bool, err
|
||||
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||
func (api *API) ReopenGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// HideGeneralForumTopic hides the 'General' topic in a forum supergroup.
|
||||
@@ -227,7 +246,7 @@ func (api *API) ReopenGeneralForumTopicWithContext(ctx context.Context, params B
|
||||
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||
func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// HideGeneralForumTopicWithContext is the context-aware variant of HideGeneralForumTopic.
|
||||
@@ -236,7 +255,7 @@ func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error
|
||||
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||
func (api *API) HideGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UnhideGeneralForumTopic unhides the 'General' topic in a forum supergroup.
|
||||
@@ -245,7 +264,7 @@ func (api *API) HideGeneralForumTopicWithContext(ctx context.Context, params Bas
|
||||
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||
func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// UnhideGeneralForumTopicWithContext is the context-aware variant of UnhideGeneralForumTopic.
|
||||
@@ -254,7 +273,7 @@ func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopic) (bool, err
|
||||
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||
func (api *API) UnhideGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UnpinAllGeneralForumTopicMessages clears the list of pinned messages in the 'General' topic.
|
||||
@@ -263,7 +282,7 @@ func (api *API) UnhideGeneralForumTopicWithContext(ctx context.Context, params B
|
||||
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||
func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// UnpinAllGeneralForumTopicMessagesWithContext is the context-aware variant of UnpinAllGeneralForumTopicMessages.
|
||||
@@ -272,5 +291,5 @@ func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopic)
|
||||
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||
func (api *API) UnpinAllGeneralForumTopicMessagesWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+22
-8
@@ -4,11 +4,17 @@ package tgapi
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#forumtopic
|
||||
type ForumTopic struct {
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
Name string `json:"name"`
|
||||
IconColor int `json:"icon_color"`
|
||||
// MessageThreadID Unique identifier of the forum topic
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
// Name Name of the topic
|
||||
Name string `json:"name"`
|
||||
// IconColor Color of the topic icon in RGB format
|
||||
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"`
|
||||
IsNameImplicit bool `json:"is_name_implicit,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"`
|
||||
}
|
||||
|
||||
// ForumTopicIconColor represents the color of a forum topic icon.
|
||||
@@ -25,16 +31,24 @@ const (
|
||||
// ForumTopicCreated represents a service message about a new forum topic created.
|
||||
// Since: Bot API 6.3
|
||||
type ForumTopicCreated struct {
|
||||
Name string `json:"name"`
|
||||
IconColor int `json:"icon_color"`
|
||||
// Name Name of the topic
|
||||
Name string `json:"name"`
|
||||
// IconColor Color of the topic icon in RGB format
|
||||
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"`
|
||||
IsNameImplicit bool `json:"is_name_implicit,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"`
|
||||
}
|
||||
|
||||
// ForumTopicEdited represents a service message about an edited forum topic.
|
||||
// Since: Bot API 6.4
|
||||
type ForumTopicEdited struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
// Name Optional. New name of the topic, if it was edited
|
||||
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"`
|
||||
}
|
||||
|
||||
|
||||
+60
-26
@@ -6,18 +6,37 @@ import "context"
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#sendgame
|
||||
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"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendGame sends a game message.
|
||||
@@ -25,7 +44,7 @@ type SendGame struct {
|
||||
// See https://core.telegram.org/bots/api#sendgame
|
||||
func (api *API) SendGame(params SendGame) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendGame", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendGameWithContext is the context-aware variant of SendGame.
|
||||
@@ -34,20 +53,30 @@ func (api *API) SendGame(params SendGame) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendgame
|
||||
func (api *API) SendGameWithContext(ctx context.Context, params SendGame) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendGame", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetGameScore holds parameters for the setGameScore method.
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#setgamescore
|
||||
type SetGameScore struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Score int `json:"score"`
|
||||
Force bool `json:"force,omitempty"`
|
||||
DisableEditMessage bool `json:"disable_edit_message,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
// UserID Required. User identifier
|
||||
UserID int64 `json:"user_id"`
|
||||
// Score Required. New score, must be non-negative
|
||||
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"`
|
||||
// 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"`
|
||||
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat.
|
||||
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"`
|
||||
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||
// message.
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
}
|
||||
|
||||
// SetGameScore sets a user's score in a game message.
|
||||
@@ -59,11 +88,11 @@ func (api *API) SetGameScore(params SetGameScore) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequestWithChatID[bool]("setGameScore", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
res, err := api.Do(req)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequestWithChatID[Message]("setGameScore", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
res, err := api.Do(req)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
@@ -75,11 +104,11 @@ func (api *API) SetGameScoreWithContext(ctx context.Context, params SetGameScore
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequestWithChatID[bool]("setGameScore", params, params.ChatID)
|
||||
res, err := req.DoWithContext(ctx, api)
|
||||
res, err := api.DoWithContext(ctx, req)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequestWithChatID[Message]("setGameScore", params, params.ChatID)
|
||||
res, err := req.DoWithContext(ctx, api)
|
||||
res, err := api.DoWithContext(ctx, req)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
@@ -87,9 +116,14 @@ func (api *API) SetGameScoreWithContext(ctx context.Context, params SetGameScore
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||
type GetGameHighScores struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
// UserID Required. Target 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"`
|
||||
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the sent message.
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -98,7 +132,7 @@ type GetGameHighScores struct {
|
||||
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||
func (api *API) GetGameHighScores(params GetGameHighScores) ([]GameHighScore, error) {
|
||||
req := NewRequestWithChatID[[]GameHighScore]("getGameHighScores", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetGameHighScoresWithContext is the context-aware variant of GetGameHighScores.
|
||||
@@ -107,5 +141,5 @@ func (api *API) GetGameHighScores(params GetGameHighScores) ([]GameHighScore, er
|
||||
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||
func (api *API) GetGameHighScoresWithContext(ctx context.Context, params GetGameHighScores) ([]GameHighScore, error) {
|
||||
req := NewRequestWithChatID[[]GameHighScore]("getGameHighScores", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+19
-8
@@ -3,12 +3,20 @@ package tgapi
|
||||
// Game represents a game.
|
||||
// Since: Bot API 2.2
|
||||
type Game struct {
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
Text string `json:"text,omitempty"`
|
||||
// Title Title of the game
|
||||
Title string `json:"title"`
|
||||
// Description Description of the game
|
||||
Description string `json:"description"`
|
||||
// Photo Photo that will be displayed in the game message in chats
|
||||
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"`
|
||||
// TextEntities Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
// Animation Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
}
|
||||
|
||||
// CallbackGame is a placeholder for the future use of callback games.
|
||||
@@ -19,7 +27,10 @@ type CallbackGame struct{}
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#gamehighscore
|
||||
type GameHighScore struct {
|
||||
Position int `json:"position"`
|
||||
User User `json:"user"`
|
||||
Score int `json:"score"`
|
||||
// Position Position in high score table for the game
|
||||
Position int `json:"position"`
|
||||
// User User
|
||||
User User `json:"user"`
|
||||
// Score Score
|
||||
Score int `json:"score"`
|
||||
}
|
||||
|
||||
+44
-23
@@ -6,12 +6,22 @@ import "context"
|
||||
// Since: Bot API 1.7
|
||||
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||
type AnswerInlineQuery struct {
|
||||
InlineQueryID string `json:"inline_query_id"`
|
||||
Results []InlineQueryResult `json:"results"`
|
||||
CacheTime int `json:"cache_time,omitempty"`
|
||||
IsPersonal bool `json:"is_personal,omitempty"`
|
||||
NextOffset string `json:"next_offset,omitempty"`
|
||||
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
||||
// InlineQueryID Required. Unique identifier for the answered query
|
||||
InlineQueryID string `json:"inline_query_id"`
|
||||
// Results Required. A JSON-serialized Array of results for the inline query
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// Button Optional. A JSON-serialized object describing a button to be shown above inline query results
|
||||
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
||||
}
|
||||
|
||||
// AnswerInlineQuery sends answers to an inline query.
|
||||
@@ -20,7 +30,7 @@ type AnswerInlineQuery struct {
|
||||
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||
func (api *API) AnswerInlineQuery(params AnswerInlineQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerInlineQuery", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// AnswerInlineQueryWithContext is the context-aware variant of AnswerInlineQuery.
|
||||
@@ -29,15 +39,17 @@ func (api *API) AnswerInlineQuery(params AnswerInlineQuery) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||
func (api *API) AnswerInlineQueryWithContext(ctx context.Context, params AnswerInlineQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerInlineQuery", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// AnswerWebAppQuery holds parameters for the answerWebAppQuery method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||
type AnswerWebAppQuery struct {
|
||||
WebAppQueryID string `json:"web_app_query_id"`
|
||||
Result InlineQueryResult `json:"result"`
|
||||
// WebAppQueryID Required. Unique identifier for the query to be answered
|
||||
WebAppQueryID string `json:"web_app_query_id"`
|
||||
// Result Required. A JSON-serialized object describing the message to be sent
|
||||
Result InlineQueryResult `json:"result"`
|
||||
}
|
||||
|
||||
// AnswerWebAppQuery sets the result of a Web App interaction.
|
||||
@@ -45,7 +57,7 @@ type AnswerWebAppQuery struct {
|
||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||
func (api *API) AnswerWebAppQuery(params AnswerWebAppQuery) (SentWebAppMessage, error) {
|
||||
req := NewRequest[SentWebAppMessage]("answerWebAppQuery", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// AnswerWebAppQueryWithContext is the context-aware variant of AnswerWebAppQuery.
|
||||
@@ -54,19 +66,25 @@ func (api *API) AnswerWebAppQuery(params AnswerWebAppQuery) (SentWebAppMessage,
|
||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||
func (api *API) AnswerWebAppQueryWithContext(ctx context.Context, params AnswerWebAppQuery) (SentWebAppMessage, error) {
|
||||
req := NewRequest[SentWebAppMessage]("answerWebAppQuery", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessage holds parameters for the savePreparedInlineMessage method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||
type SavePreparedInlineMessage struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Result InlineQueryResult `json:"result"`
|
||||
AllowUserChats bool `json:"allow_user_chats,omitempty"`
|
||||
AllowBotChats bool `json:"allow_bot_chats,omitempty"`
|
||||
AllowGroupChats bool `json:"allow_group_chats,omitempty"`
|
||||
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
||||
// UserID Required. Unique identifier of the target user that can use the prepared message
|
||||
UserID int64 `json:"user_id"`
|
||||
// Result Required. A JSON-serialized object describing the message to be sent
|
||||
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"`
|
||||
// AllowBotChats Optional. Pass True if the message can be sent to private chats with bots
|
||||
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"`
|
||||
// AllowChannelChats Optional. Pass True if the message can be sent to channel chats
|
||||
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessage stores a prepared message for Mini App users.
|
||||
@@ -74,7 +92,7 @@ type SavePreparedInlineMessage struct {
|
||||
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||
func (api *API) SavePreparedInlineMessage(params SavePreparedInlineMessage) (PreparedInlineMessage, error) {
|
||||
req := NewRequest[PreparedInlineMessage]("savePreparedInlineMessage", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessageWithContext is the context-aware variant of SavePreparedInlineMessage.
|
||||
@@ -83,14 +101,17 @@ func (api *API) SavePreparedInlineMessage(params SavePreparedInlineMessage) (Pre
|
||||
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||
func (api *API) SavePreparedInlineMessageWithContext(ctx context.Context, params SavePreparedInlineMessage) (PreparedInlineMessage, error) {
|
||||
req := NewRequest[PreparedInlineMessage]("savePreparedInlineMessage", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SavePreparedKeyboardButton holds parameters for the savePreparedKeyboardButton method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||
type SavePreparedKeyboardButton struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Unique identifier of the target user that can use the button
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -99,7 +120,7 @@ type SavePreparedKeyboardButton struct {
|
||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||
func (api *API) SavePreparedKeyboardButton(params SavePreparedKeyboardButton) (PreparedKeyboardButton, error) {
|
||||
req := NewRequest[PreparedKeyboardButton]("savePreparedKeyboardButton", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SavePreparedKeyboardButtonWithContext is the context-aware variant of SavePreparedKeyboardButton.
|
||||
@@ -108,5 +129,5 @@ func (api *API) SavePreparedKeyboardButton(params SavePreparedKeyboardButton) (P
|
||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||
func (api *API) SavePreparedKeyboardButtonWithContext(ctx context.Context, params SavePreparedKeyboardButton) (PreparedKeyboardButton, error) {
|
||||
req := NewRequest[PreparedKeyboardButton]("savePreparedKeyboardButton", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+33
-5
@@ -9,15 +9,39 @@ type InlineQueryResult map[string]any
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#inlinequeryresultsbutton
|
||||
type InlineQueryResultsButton struct {
|
||||
Text string `json:"text"`
|
||||
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||
StartParameter string `json:"start_parameter,omitempty"`
|
||||
// Text Label text on the button
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// InputRichMessageContent represents the content of a rich message to be
|
||||
// sent as the result of an inline query. Use it as the input_message_content
|
||||
// value of an InlineQueryResult.
|
||||
// Since: Bot API 10.1
|
||||
// See https://core.telegram.org/bots/api#inputrichmessagecontent
|
||||
type InputRichMessageContent struct {
|
||||
// RichMessage contains structured rich-message content.
|
||||
RichMessage InputRichMessage `json:"rich_message"`
|
||||
}
|
||||
|
||||
// SentWebAppMessage describes an inline message sent by a Web App on behalf of a user.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#sentwebappmessage
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -25,13 +49,17 @@ type SentWebAppMessage struct {
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#preparedinlinemessage
|
||||
type PreparedInlineMessage struct {
|
||||
ID string `json:"id"`
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
// ID Unique identifier of the prepared message
|
||||
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"`
|
||||
}
|
||||
|
||||
// PreparedKeyboardButton describes a prepared keyboard button.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#preparedkeyboardbutton
|
||||
type PreparedKeyboardButton struct {
|
||||
// ID Unique identifier of the keyboard button
|
||||
ID string `json:"id"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const redactedLogValue = "<REDACTED>"
|
||||
|
||||
var sensitiveLogFields = map[string]struct{}{
|
||||
"callback_data": {},
|
||||
"credentials": {},
|
||||
"data": {},
|
||||
"invoice_payload": {},
|
||||
"payload": {},
|
||||
"provider_data": {},
|
||||
"provider_token": {},
|
||||
"secret": {},
|
||||
"secret_token": {},
|
||||
"token": {},
|
||||
"web_app_query_id": {},
|
||||
}
|
||||
|
||||
func redactRequestLog(data []byte) string {
|
||||
var value any
|
||||
if err := json.Unmarshal(data, &value); err != nil {
|
||||
return fmt.Sprintf("<invalid JSON omitted: %d bytes>", len(data))
|
||||
}
|
||||
redactLogValue(value)
|
||||
redacted, err := json.Marshal(value)
|
||||
if err != nil {
|
||||
return fmt.Sprintf("<unavailable JSON omitted: %d bytes>", len(data))
|
||||
}
|
||||
return string(redacted)
|
||||
}
|
||||
|
||||
func redactLogValue(value any) {
|
||||
switch value := value.(type) {
|
||||
case map[string]any:
|
||||
for key, item := range value {
|
||||
if _, sensitive := sensitiveLogFields[strings.ToLower(key)]; sensitive {
|
||||
value[key] = redactedLogValue
|
||||
continue
|
||||
}
|
||||
redactLogValue(item)
|
||||
}
|
||||
case []any:
|
||||
for _, item := range value {
|
||||
redactLogValue(item)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func responseLogSummary(method string, size int) string {
|
||||
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
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRedactRequestLogRemovesSensitiveValues(t *testing.T) {
|
||||
const input = `{"secret_token":"webhook-secret","provider_token":"payment-token","nested":{"data":"passport-data","callback_data":"callback-secret"},"chat_id":42}`
|
||||
got := redactRequestLog([]byte(input))
|
||||
|
||||
for _, secret := range []string{"webhook-secret", "payment-token", "passport-data", "callback-secret"} {
|
||||
if strings.Contains(got, secret) {
|
||||
t.Errorf("redacted request contains %q: %s", secret, got)
|
||||
}
|
||||
}
|
||||
if !strings.Contains(got, `"chat_id":42`) {
|
||||
t.Errorf("redacted request lost non-sensitive field: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactRequestLogOmitsInvalidJSON(t *testing.T) {
|
||||
const secret = "not-json-secret"
|
||||
got := redactRequestLog([]byte(secret))
|
||||
if strings.Contains(got, secret) {
|
||||
t.Fatalf("invalid JSON was logged verbatim: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResponseLogSummaryNeverContainsBody(t *testing.T) {
|
||||
const token = "managed-bot-token"
|
||||
got := responseLogSummary("getManagedBotToken", len(token))
|
||||
if strings.Contains(got, token) {
|
||||
t.Fatalf("response summary contains response body: %s", got)
|
||||
}
|
||||
if !strings.Contains(got, "body=omitted") {
|
||||
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)
|
||||
}
|
||||
}
|
||||
+1034
-313
File diff suppressed because it is too large
Load Diff
+855
-253
File diff suppressed because it is too large
Load Diff
+99
-58
@@ -4,17 +4,33 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"math"
|
||||
"net/http"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
)
|
||||
|
||||
// UpdateParams holds parameters for the getUpdates method.
|
||||
// See https://core.telegram.org/bots/api#getupdates
|
||||
type UpdateParams struct {
|
||||
Offset *int `json:"offset,omitempty"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
Timeout *int `json:"timeout,omitempty"`
|
||||
// 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"`
|
||||
// Limit Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults
|
||||
// to 100.
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
@@ -22,7 +38,7 @@ type UpdateParams struct {
|
||||
// See https://core.telegram.org/bots/api#getme
|
||||
func (api *API) GetMe() (User, error) {
|
||||
req := NewRequest[User]("getMe", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMeWithContext is the context-aware variant of GetMe.
|
||||
@@ -30,12 +46,13 @@ func (api *API) GetMe() (User, error) {
|
||||
// See https://core.telegram.org/bots/api#getme
|
||||
func (api *API) GetMeWithContext(ctx context.Context) (User, error) {
|
||||
req := NewRequest[User]("getMe", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetManagedBotToken holds parameters for the getManagedBotToken method.
|
||||
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||
type GetManagedBotToken struct {
|
||||
// UserID Required. User identifier of the managed bot whose token will be returned
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
@@ -43,7 +60,7 @@ type GetManagedBotToken struct {
|
||||
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||
func (api *API) GetManagedBotToken(params GetManagedBotToken) (string, error) {
|
||||
req := NewRequest[string]("getManagedBotToken", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetManagedBotTokenWithContext is the context-aware variant of GetManagedBotToken.
|
||||
@@ -51,12 +68,13 @@ func (api *API) GetManagedBotToken(params GetManagedBotToken) (string, error) {
|
||||
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||
func (api *API) GetManagedBotTokenWithContext(ctx context.Context, params GetManagedBotToken) (string, error) {
|
||||
req := NewRequest[string]("getManagedBotToken", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ReplaceManagedBotToken holds parameters for the replaceManagedBotToken method.
|
||||
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||
type ReplaceManagedBotToken struct {
|
||||
// UserID Required. User identifier of the managed bot whose token will be replaced
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
@@ -64,7 +82,7 @@ type ReplaceManagedBotToken struct {
|
||||
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||
func (api *API) ReplaceManagedBotToken(params ReplaceManagedBotToken) (string, error) {
|
||||
req := NewRequest[string]("replaceManagedBotToken", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ReplaceManagedBotTokenWithContext is the context-aware variant of ReplaceManagedBotToken.
|
||||
@@ -72,46 +90,46 @@ func (api *API) ReplaceManagedBotToken(params ReplaceManagedBotToken) (string, e
|
||||
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||
func (api *API) ReplaceManagedBotTokenWithContext(ctx context.Context, params ReplaceManagedBotToken) (string, error) {
|
||||
req := NewRequest[string]("replaceManagedBotToken", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// LogOut logs the bot out from the cloud Bot API server.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#logout
|
||||
func (api *API) LogOut() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||
return req.Do(api)
|
||||
req := NewRequest[bool]("logOut", NoParams)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// LogOutWithContext is the context-aware variant of LogOut.
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#logout
|
||||
func (api *API) LogOutWithContext(ctx context.Context) (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
req := NewRequest[bool]("logOut", NoParams)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CloseRemote closes the bot instance on the local server.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#close
|
||||
func (api *API) CloseRemote() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||
return req.Do(api)
|
||||
req := NewRequest[bool]("close", NoParams)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CloseRemoteWithContext is the context-aware variant of CloseRemote.
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#close
|
||||
func (api *API) CloseRemoteWithContext(ctx context.Context) (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
req := NewRequest[bool]("close", NoParams)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetUpdates receives incoming updates using long polling.
|
||||
// See https://core.telegram.org/bots/api#getupdates
|
||||
func (api *API) GetUpdates(params UpdateParams) ([]Update, error) {
|
||||
req := NewRequest[[]Update]("getUpdates", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetUpdatesWithContext is the context-aware variant of GetUpdates.
|
||||
@@ -119,19 +137,36 @@ func (api *API) GetUpdates(params UpdateParams) ([]Update, error) {
|
||||
// See https://core.telegram.org/bots/api#getupdates
|
||||
func (api *API) GetUpdatesWithContext(ctx context.Context, params UpdateParams) ([]Update, error) {
|
||||
req := NewRequest[[]Update]("getUpdates", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetWebhook holds parameters for the setWebhook method.
|
||||
// To upload a self-signed certificate, use Uploader.SetWebhook.
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
type SetWebhook struct {
|
||||
URL string `json:"url"`
|
||||
IPAddress string `json:"ip_address,omitempty"`
|
||||
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||
SecretToken string `json:"secret_token,omitempty"`
|
||||
// URL Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetWebhook sets a webhook URL for incoming updates.
|
||||
@@ -140,7 +175,7 @@ type SetWebhook struct {
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
func (api *API) SetWebhook(params SetWebhook) (bool, error) {
|
||||
req := NewRequest[bool]("setWebhook", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetWebhookWithContext is the context-aware variant of SetWebhook.
|
||||
@@ -149,12 +184,13 @@ func (api *API) SetWebhook(params SetWebhook) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
func (api *API) SetWebhookWithContext(ctx context.Context, params SetWebhook) (bool, error) {
|
||||
req := NewRequest[bool]("setWebhook", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteWebhook holds parameters for the deleteWebhook method.
|
||||
// See https://core.telegram.org/bots/api#deletewebhook
|
||||
type DeleteWebhook struct {
|
||||
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||
}
|
||||
|
||||
@@ -163,7 +199,7 @@ type DeleteWebhook struct {
|
||||
// See https://core.telegram.org/bots/api#deletewebhook
|
||||
func (api *API) DeleteWebhook(params DeleteWebhook) (bool, error) {
|
||||
req := NewRequest[bool]("deleteWebhook", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteWebhookWithContext is the context-aware variant of DeleteWebhook.
|
||||
@@ -171,14 +207,14 @@ func (api *API) DeleteWebhook(params DeleteWebhook) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#deletewebhook
|
||||
func (api *API) DeleteWebhookWithContext(ctx context.Context, params DeleteWebhook) (bool, error) {
|
||||
req := NewRequest[bool]("deleteWebhook", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetWebhookInfo returns the current webhook status.
|
||||
// See https://core.telegram.org/bots/api#getwebhookinfo
|
||||
func (api *API) GetWebhookInfo() (WebhookInfo, error) {
|
||||
req := NewRequest[WebhookInfo]("getWebhookInfo", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetWebhookInfoWithContext is the context-aware variant of GetWebhookInfo.
|
||||
@@ -186,12 +222,13 @@ func (api *API) GetWebhookInfo() (WebhookInfo, error) {
|
||||
// See https://core.telegram.org/bots/api#getwebhookinfo
|
||||
func (api *API) GetWebhookInfoWithContext(ctx context.Context) (WebhookInfo, error) {
|
||||
req := NewRequest[WebhookInfo]("getWebhookInfo", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetFile holds parameters for the getFile method.
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
type GetFile struct {
|
||||
// FileID Required. File identifier to get information about
|
||||
FileID string `json:"file_id"`
|
||||
}
|
||||
|
||||
@@ -199,7 +236,7 @@ type GetFile struct {
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
func (api *API) GetFile(params GetFile) (File, error) {
|
||||
req := NewRequest[File]("getFile", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetFileWithContext is the context-aware variant of GetFile.
|
||||
@@ -207,23 +244,38 @@ func (api *API) GetFile(params GetFile) (File, error) {
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
func (api *API) GetFileWithContext(ctx context.Context, params GetFile) (File, error) {
|
||||
req := NewRequest[File]("getFile", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
|
||||
// The link is usually obtained from File.FilePath.
|
||||
// For large files, prefer OpenFileByLink or OpenFileByLinkWithContext to stream the response body.
|
||||
// See https://core.telegram.org/bots/api#file
|
||||
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
||||
return api.getFileByLink(context.Background(), 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)
|
||||
}
|
||||
|
||||
// GetFileByLinkWithContext is the context-aware variant of GetFileByLink.
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// For large files, prefer OpenFileByLinkWithContext to stream the response body.
|
||||
// See https://core.telegram.org/bots/api#file
|
||||
func (api *API) GetFileByLinkWithContext(ctx context.Context, link string) ([]byte, error) {
|
||||
return api.getFileByLink(ctx, link)
|
||||
// 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.
|
||||
@@ -240,17 +292,6 @@ func (api *API) OpenFileByLinkWithContext(ctx context.Context, link string) (io.
|
||||
return api.openFileByLink(ctx, link)
|
||||
}
|
||||
|
||||
func (api *API) getFileByLink(ctx context.Context, link string) ([]byte, error) {
|
||||
body, err := api.openFileByLink(ctx, link)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer func() {
|
||||
_ = body.Close()
|
||||
}()
|
||||
return io.ReadAll(body)
|
||||
}
|
||||
|
||||
func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser, error) {
|
||||
methodPrefix := ""
|
||||
if api.useTestServer {
|
||||
@@ -266,7 +307,7 @@ func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser,
|
||||
|
||||
res, err := api.client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, redactHTTPError(err, api.token)
|
||||
}
|
||||
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
|
||||
defer func() {
|
||||
|
||||
+25
-5
@@ -2,13 +2,14 @@ package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestGetFileByLinkUsesConfiguredAPIURL(t *testing.T) {
|
||||
func TestGetFileByLinkLimitUsesConfiguredAPIURL(t *testing.T) {
|
||||
var gotPath string
|
||||
|
||||
client := &http.Client{
|
||||
@@ -32,9 +33,9 @@ func TestGetFileByLinkUsesConfiguredAPIURL(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
data, err := api.GetFileByLink("files/report.txt")
|
||||
data, err := api.GetFileByLinkLimit("files/report.txt", 1024)
|
||||
if err != nil {
|
||||
t.Fatalf("GetFileByLink returned error: %v", err)
|
||||
t.Fatalf("GetFileByLinkLimit returned error: %v", err)
|
||||
}
|
||||
if string(data) != "payload" {
|
||||
t.Fatalf("unexpected payload: %q", string(data))
|
||||
@@ -82,7 +83,7 @@ func TestOpenFileByLinkStreamsResponseBody(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
||||
func TestGetFileByLinkLimitReturnsHTTPStatusError(t *testing.T) {
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
return &http.Response{
|
||||
@@ -103,12 +104,31 @@ func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
_, err := api.GetFileByLink("files/report.txt")
|
||||
_, err := api.GetFileByLinkLimit("files/report.txt", 1024)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for non-2xx response")
|
||||
}
|
||||
}
|
||||
|
||||
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) {
|
||||
var gotBody map[string]any
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestV2MigrationSurfaceCompiles(t *testing.T) {
|
||||
answer := PollAnswer{User: &User{ID: 1}}
|
||||
if answer.User == nil {
|
||||
t.Fatal("poll voter is missing")
|
||||
}
|
||||
|
||||
_ = ChatFullInfo{AvailableReactions: []ReactionType{}}
|
||||
_ = ReplyParameters{QuoteParseMode: string(ParseHTML)}
|
||||
_ = InputChecklist{OthersCanAddTasks: true, OthersCanMarkTasksAsDone: true}
|
||||
_ = SendMessage{EphemeralMessageParameters: &EphemeralMessageParameters{ReceiverUserID: 1}}
|
||||
|
||||
request := NewRequest[bool]("customMethod", NoParams)
|
||||
upload := NewUploaderRequest[bool]("customUpload", NoParams)
|
||||
var api *API
|
||||
var uploader *Uploader
|
||||
if false {
|
||||
_, _ = api.Do(request)
|
||||
_, _ = api.DoWithContext(context.Background(), request)
|
||||
_, _ = uploader.Do(upload)
|
||||
_, _ = uploader.DoWithContext(context.Background(), upload)
|
||||
_, _ = api.DeleteAllMessageReactions(DeleteAllMessageReactions{})
|
||||
_, _ = api.GetFileByLinkLimit("file/path", 1<<20)
|
||||
_, _ = api.OpenFileByLinkWithContext(context.Background(), "file/path")
|
||||
}
|
||||
}
|
||||
@@ -6,7 +6,9 @@ import "context"
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||
type SetPassportDataErrors struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. User identifier
|
||||
UserID int64 `json:"user_id"`
|
||||
// Errors Required. A JSON-serialized Array describing the errors
|
||||
Errors []PassportElementError `json:"errors"`
|
||||
}
|
||||
|
||||
@@ -16,7 +18,7 @@ type SetPassportDataErrors struct {
|
||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||
func (api *API) SetPassportDataErrors(params SetPassportDataErrors) (bool, error) {
|
||||
req := NewRequest[bool]("setPassportDataErrors", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetPassportDataErrorsWithContext is the context-aware variant of SetPassportDataErrors.
|
||||
@@ -25,5 +27,5 @@ func (api *API) SetPassportDataErrors(params SetPassportDataErrors) (bool, error
|
||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||
func (api *API) SetPassportDataErrorsWithContext(ctx context.Context, params SetPassportDataErrors) (bool, error) {
|
||||
req := NewRequest[bool]("setPassportDataErrors", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+96
-33
@@ -3,58 +3,113 @@ package tgapi
|
||||
// PassportData contains information about Telegram Passport data shared with the bot.
|
||||
// Since: Bot API 4.0
|
||||
type PassportData struct {
|
||||
Data []EncryptedPassportElement `json:"data"`
|
||||
Credentials EncryptedCredentials `json:"credentials"`
|
||||
// Data Array with information about documents and other Telegram Passport elements that was shared with the
|
||||
// bot
|
||||
Data []EncryptedPassportElement `json:"data"`
|
||||
// Credentials Encrypted credentials required to decrypt the data
|
||||
Credentials EncryptedCredentials `json:"credentials"`
|
||||
}
|
||||
|
||||
// PassportFile represents a file uploaded to Telegram Passport.
|
||||
// Since: Bot API 4.0
|
||||
type PassportFile struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
FileSize int64 `json:"file_size"`
|
||||
FileDate int64 `json:"file_date"`
|
||||
// FileSize File size in bytes
|
||||
FileSize int64 `json:"file_size"`
|
||||
// FileDate Unix time when the file was uploaded
|
||||
FileDate int64 `json:"file_date"`
|
||||
}
|
||||
|
||||
// PassportElementType represents the type of a Telegram Passport element.
|
||||
type PassportElementType string
|
||||
|
||||
const (
|
||||
PassportPersonalDetailsType PassportElementType = "personal_details"
|
||||
PassportPassportType PassportElementType = "passport"
|
||||
PassportDriverLicenseType PassportElementType = "driver_license"
|
||||
PassportIdentityCardType PassportElementType = "identity_card"
|
||||
PassportInternalPassportType PassportElementType = "internal_passport"
|
||||
PassportAddressType PassportElementType = "address"
|
||||
PassportUtilityBillType PassportElementType = "utility_bill"
|
||||
PassportBankStatementType PassportElementType = "bank_statement"
|
||||
PassportRentalAgreementType PassportElementType = "rental_agreement"
|
||||
PassportPassportRegistrationType PassportElementType = "passport_registration"
|
||||
// PassportPersonalDetailsType identifies personal details.
|
||||
PassportPersonalDetailsType PassportElementType = "personal_details"
|
||||
// PassportPassportType identifies an international passport.
|
||||
PassportPassportType PassportElementType = "passport"
|
||||
// PassportDriverLicenseType identifies a driver license.
|
||||
PassportDriverLicenseType PassportElementType = "driver_license"
|
||||
// PassportIdentityCardType identifies an identity card.
|
||||
PassportIdentityCardType PassportElementType = "identity_card"
|
||||
// PassportInternalPassportType identifies an internal passport.
|
||||
PassportInternalPassportType PassportElementType = "internal_passport"
|
||||
// PassportAddressType identifies a residential address.
|
||||
PassportAddressType PassportElementType = "address"
|
||||
// PassportUtilityBillType identifies a utility bill.
|
||||
PassportUtilityBillType PassportElementType = "utility_bill"
|
||||
// PassportBankStatementType identifies a bank statement.
|
||||
PassportBankStatementType PassportElementType = "bank_statement"
|
||||
// PassportRentalAgreementType identifies a rental agreement.
|
||||
PassportRentalAgreementType PassportElementType = "rental_agreement"
|
||||
// PassportPassportRegistrationType identifies a passport registration.
|
||||
PassportPassportRegistrationType PassportElementType = "passport_registration"
|
||||
// PassportTemporaryRegistrationType identifies a temporary registration.
|
||||
PassportTemporaryRegistrationType PassportElementType = "temporary_registration"
|
||||
PassportPhoneNumberType PassportElementType = "phone_number"
|
||||
PassportEmailType PassportElementType = "email"
|
||||
// PassportPhoneNumberType identifies a phone number.
|
||||
PassportPhoneNumberType PassportElementType = "phone_number"
|
||||
// PassportEmailType identifies an email address.
|
||||
PassportEmailType PassportElementType = "email"
|
||||
)
|
||||
|
||||
// EncryptedPassportElement contains information about documents or other Telegram Passport elements.
|
||||
// Since: Bot API 4.0
|
||||
type EncryptedPassportElement struct {
|
||||
Type PassportElementType `json:"type"`
|
||||
Data string `json:"data,omitempty"`
|
||||
PhoneNumber string `json:"phone_number,omitempty"`
|
||||
Email string `json:"email,omitempty"`
|
||||
Files []PassportFile `json:"files,omitempty"`
|
||||
FrontSide *PassportFile `json:"front_side,omitempty"`
|
||||
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
|
||||
Selfie *PassportFile `json:"selfie,omitempty"`
|
||||
Translation *PassportFile `json:"translation,omitempty"`
|
||||
Hash string `json:"hash,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// PhoneNumber Optional. User's verified phone number; available only for “phone_number” type
|
||||
PhoneNumber string `json:"phone_number,omitempty"`
|
||||
// Email Optional. User's verified email address; available only for “email” type
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// Hash Base64-encoded element hash for using in PassportElementErrorUnspecified
|
||||
Hash string `json:"hash,omitempty"`
|
||||
}
|
||||
|
||||
// EncryptedCredentials contains data required for decrypting and authenticating EncryptedPassportElement.
|
||||
// Since: Bot API 4.0
|
||||
type EncryptedCredentials struct {
|
||||
Data string `json:"data"`
|
||||
Hash string `json:"hash"`
|
||||
// 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"`
|
||||
// Hash Base64-encoded data hash for data authentication
|
||||
Hash string `json:"hash"`
|
||||
// Secret Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
|
||||
Secret string `json:"secret"`
|
||||
}
|
||||
|
||||
@@ -62,16 +117,24 @@ type EncryptedCredentials struct {
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#passportelementerror
|
||||
type PassportElementError struct {
|
||||
Source string `json:"source"`
|
||||
Type PassportElementType `json:"type"`
|
||||
// Source identifies the source of the passport validation error.
|
||||
Source string `json:"source"`
|
||||
// Type identifies the Telegram Passport element type with the error.
|
||||
Type PassportElementType `json:"type"`
|
||||
|
||||
// FieldName Name of the data field which has the error
|
||||
FieldName string `json:"field_name,omitempty"`
|
||||
DataHash string `json:"data_hash,omitempty"`
|
||||
// DataHash Base64-encoded data hash
|
||||
DataHash string `json:"data_hash,omitempty"`
|
||||
|
||||
FileHash string `json:"file_hash,omitempty"`
|
||||
// FileHash is the base64-encoded hash of the file that contains the error.
|
||||
FileHash string `json:"file_hash,omitempty"`
|
||||
// FileHashes List of base64-encoded file hashes
|
||||
FileHashes []string `json:"file_hashes,omitempty"`
|
||||
|
||||
// ElementHash Base64-encoded element hash
|
||||
ElementHash string `json:"element_hash,omitempty"`
|
||||
|
||||
// Message Error message
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
+189
-64
@@ -6,40 +6,104 @@ import "context"
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#sendinvoice
|
||||
type SendInvoice struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Payload string `json:"payload"`
|
||||
ProviderToken string `json:"provider_token,omitempty"`
|
||||
Currency string `json:"currency"`
|
||||
Prices []LabeledPrice `json:"prices"`
|
||||
// Title Required. Product name, 1-32 characters
|
||||
Title string `json:"title"`
|
||||
// Description Required. Product description, 1-255 characters
|
||||
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"`
|
||||
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||
// payments in Telegram Stars.
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||
StartParameter string `json:"start_parameter,omitempty"`
|
||||
ProviderData string `json:"provider_data,omitempty"`
|
||||
PhotoURL string `json:"photo_url,omitempty"`
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
PhotoHeight int `json:"photo_height,omitempty"`
|
||||
NeedName bool `json:"need_name,omitempty"`
|
||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||
NeedEmail bool `json:"need_email,omitempty"`
|
||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// PhotoSize Optional. Photo size in bytes
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
// PhotoWidth Optional. Photo width
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
// PhotoHeight Optional. Photo height
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendInvoice sends an invoice.
|
||||
@@ -47,7 +111,7 @@ type SendInvoice struct {
|
||||
// See https://core.telegram.org/bots/api#sendinvoice
|
||||
func (api *API) SendInvoice(params SendInvoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendInvoice", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendInvoiceWithContext is the context-aware variant of SendInvoice.
|
||||
@@ -56,37 +120,84 @@ func (api *API) SendInvoice(params SendInvoice) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendinvoice
|
||||
func (api *API) SendInvoiceWithContext(ctx context.Context, params SendInvoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendInvoice", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CreateInvoiceLink holds parameters for the createInvoiceLink method.
|
||||
// Since: Bot API 6.1
|
||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||
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"`
|
||||
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Payload string `json:"payload"`
|
||||
ProviderToken string `json:"provider_token,omitempty"`
|
||||
Currency string `json:"currency"`
|
||||
Prices []LabeledPrice `json:"prices"`
|
||||
// Title Required. Product name, 1-32 characters
|
||||
Title string `json:"title"`
|
||||
// Description Required. Product description, 1-255 characters
|
||||
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"`
|
||||
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||
// payments in Telegram Stars.
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||
ProviderData string `json:"provider_data,omitempty"`
|
||||
PhotoURL string `json:"photo_url,omitempty"`
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
PhotoHeight int `json:"photo_height,omitempty"`
|
||||
NeedName bool `json:"need_name,omitempty"`
|
||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||
NeedEmail bool `json:"need_email,omitempty"`
|
||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// PhotoSize Optional. Photo size in bytes
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
// PhotoWidth Optional. Photo width
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
// PhotoHeight Optional. Photo height
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// CreateInvoiceLink creates an invoice link.
|
||||
@@ -94,7 +205,7 @@ type CreateInvoiceLink struct {
|
||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||
func (api *API) CreateInvoiceLink(params CreateInvoiceLink) (string, error) {
|
||||
req := NewRequest[string]("createInvoiceLink", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CreateInvoiceLinkWithContext is the context-aware variant of CreateInvoiceLink.
|
||||
@@ -103,17 +214,24 @@ func (api *API) CreateInvoiceLink(params CreateInvoiceLink) (string, error) {
|
||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||
func (api *API) CreateInvoiceLinkWithContext(ctx context.Context, params CreateInvoiceLink) (string, error) {
|
||||
req := NewRequest[string]("createInvoiceLink", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// AnswerShippingQuery holds parameters for the answerShippingQuery method.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#answershippingquery
|
||||
type AnswerShippingQuery struct {
|
||||
ShippingQueryID string `json:"shipping_query_id"`
|
||||
OK bool `json:"ok"`
|
||||
// ShippingQueryID Required. Unique identifier for the query to be answered
|
||||
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"`
|
||||
// ShippingOptions Optional. Required if ok is True. A JSON-serialized Array of available shipping options.
|
||||
ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
|
||||
ErrorMessage string `json:"error_message,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"`
|
||||
}
|
||||
|
||||
// AnswerShippingQuery answers a shipping query.
|
||||
@@ -122,7 +240,7 @@ type AnswerShippingQuery struct {
|
||||
// See https://core.telegram.org/bots/api#answershippingquery
|
||||
func (api *API) AnswerShippingQuery(params AnswerShippingQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerShippingQuery", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// AnswerShippingQueryWithContext is the context-aware variant of AnswerShippingQuery.
|
||||
@@ -131,16 +249,23 @@ func (api *API) AnswerShippingQuery(params AnswerShippingQuery) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#answershippingquery
|
||||
func (api *API) AnswerShippingQueryWithContext(ctx context.Context, params AnswerShippingQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerShippingQuery", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQuery holds parameters for the answerPreCheckoutQuery method.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||
type AnswerPreCheckoutQuery struct {
|
||||
// PreCheckoutQueryID Required. Unique identifier for the query to be answered
|
||||
PreCheckoutQueryID string `json:"pre_checkout_query_id"`
|
||||
OK bool `json:"ok"`
|
||||
ErrorMessage string `json:"error_message,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQuery answers a pre-checkout query.
|
||||
@@ -149,7 +274,7 @@ type AnswerPreCheckoutQuery struct {
|
||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||
func (api *API) AnswerPreCheckoutQuery(params AnswerPreCheckoutQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerPreCheckoutQuery", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQueryWithContext is the context-aware variant of AnswerPreCheckoutQuery.
|
||||
@@ -158,5 +283,5 @@ func (api *API) AnswerPreCheckoutQuery(params AnswerPreCheckoutQuery) (bool, err
|
||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||
func (api *API) AnswerPreCheckoutQueryWithContext(ctx context.Context, params AnswerPreCheckoutQuery) (bool, error) {
|
||||
req := NewRequest[bool]("answerPreCheckoutQuery", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+96
-36
@@ -4,27 +4,42 @@ package tgapi
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#labeledprice
|
||||
type LabeledPrice struct {
|
||||
Label string `json:"label"`
|
||||
Amount int `json:"amount"`
|
||||
// Label Portion 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"`
|
||||
}
|
||||
|
||||
// Invoice contains basic information about an invoice.
|
||||
// Since: Bot API 3.0
|
||||
type Invoice struct {
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
// Title Product name
|
||||
Title string `json:"title"`
|
||||
// Description Product description
|
||||
Description string `json:"description"`
|
||||
// StartParameter Unique bot deep-linking parameter that can be used to generate this invoice
|
||||
StartParameter string `json:"start_parameter"`
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
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"`
|
||||
}
|
||||
|
||||
// ShippingQuery represents an incoming shipping query.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingquery
|
||||
type ShippingQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ID Unique query identifier
|
||||
ID string `json:"id"`
|
||||
// From User who sent the query
|
||||
From User `json:"from"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ShippingAddress User specified shipping address
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
@@ -32,21 +47,31 @@ type ShippingQuery struct {
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingaddress
|
||||
type ShippingAddress struct {
|
||||
// CountryCode Two-letter ISO 3166-1 alpha-2 country code
|
||||
CountryCode string `json:"country_code"`
|
||||
State string `json:"state"`
|
||||
City string `json:"city"`
|
||||
// State State, if applicable
|
||||
State string `json:"state"`
|
||||
// City City
|
||||
City string `json:"city"`
|
||||
// StreetLine1 First line for the address
|
||||
StreetLine1 string `json:"street_line1"`
|
||||
// StreetLine2 Second line for the address
|
||||
StreetLine2 string `json:"street_line2"`
|
||||
PostCode string `json:"post_code"`
|
||||
// PostCode Address post code
|
||||
PostCode string `json:"post_code"`
|
||||
}
|
||||
|
||||
// OrderInfo represents information about an order.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#orderinfo
|
||||
type OrderInfo struct {
|
||||
Name string `json:"name"`
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
Email string `json:"email"`
|
||||
// Name Optional. User name
|
||||
Name string `json:"name"`
|
||||
// PhoneNumber Optional. User's phone number
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
// Email Optional. User email
|
||||
Email string `json:"email"`
|
||||
// ShippingAddress Optional. User shipping address
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
@@ -54,20 +79,31 @@ type OrderInfo struct {
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#precheckoutquery
|
||||
type PreCheckoutQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
ShippingOptionID string `json:"shipping_option_id"`
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
// ID Unique query identifier
|
||||
ID string `json:"id"`
|
||||
// From User who sent the query
|
||||
From User `json:"from"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
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"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||
ShippingOptionID string `json:"shipping_option_id"`
|
||||
// OrderInfo Optional. Order information provided by the user
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
}
|
||||
|
||||
// PaidMediaPurchased represents a purchased paid media.
|
||||
// Since: Bot API 7.10
|
||||
// See https://core.telegram.org/bots/api#paidmediapurchased
|
||||
type PaidMediaPurchased struct {
|
||||
From User `json:"from"`
|
||||
// From User who purchased the media
|
||||
From User `json:"from"`
|
||||
// PaidMediaPayload Bot-specified paid media payload
|
||||
PaidMediaPayload string `json:"paid_media_payload"`
|
||||
}
|
||||
|
||||
@@ -75,35 +111,59 @@ type PaidMediaPurchased struct {
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingoption
|
||||
type ShippingOption struct {
|
||||
ID string `json:"id"`
|
||||
Title string `json:"title"`
|
||||
// ID Shipping option identifier
|
||||
ID string `json:"id"`
|
||||
// Title Option title
|
||||
Title string `json:"title"`
|
||||
// Prices List of price portions
|
||||
Prices []LabeledPrice `json:"prices"`
|
||||
}
|
||||
|
||||
// SuccessfulPayment contains basic information about a successful payment.
|
||||
// Since: Bot API 3.0
|
||||
type SuccessfulPayment struct {
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
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"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
|
||||
SubscriptionExpirationDate int `json:"subscription_expiration_date,omitempty"` // Since: Bot API 8.0
|
||||
IsRecurring bool `json:"is_recurring,omitempty"` // Since: Bot API 8.0
|
||||
IsFirstRecurring bool `json:"is_first_recurring,omitempty"` // Since: Bot API 8.0
|
||||
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
// 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
|
||||
// IsRecurring Optional. True, if the payment is a recurring payment for a subscription
|
||||
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
|
||||
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
||||
// OrderInfo Optional. Order information provided by the user
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
|
||||
// TelegramPaymentChargeID Telegram payment identifier
|
||||
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.
|
||||
// Since: Bot API 7.7
|
||||
type RefundedPayment struct {
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently,
|
||||
// always “XTR”.
|
||||
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"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
|
||||
// TelegramPaymentChargeID Telegram payment identifier
|
||||
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"`
|
||||
}
|
||||
|
||||
+11
-6
@@ -2,6 +2,7 @@ package tgapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
)
|
||||
|
||||
@@ -126,10 +127,14 @@ func (p *workerPool) worker() {
|
||||
}
|
||||
|
||||
func (p *workerPool) executeEnvelope(envelope requestEnvelope) {
|
||||
value, err := envelope.doFunc(envelope.ctx)
|
||||
envelope.resultCh <- requestResult{
|
||||
value: value,
|
||||
err: err,
|
||||
}
|
||||
close(envelope.resultCh)
|
||||
result := requestResult{}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
result.value = nil
|
||||
result.err = fmt.Errorf("%w: %v", ErrPoolWorkerPanic, recovered)
|
||||
}
|
||||
envelope.resultCh <- result
|
||||
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) {
|
||||
pool := newWorkerPool(1, 1)
|
||||
pool.start()
|
||||
|
||||
@@ -0,0 +1,156 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"mime"
|
||||
"mime/multipart"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRich103RoundTrip(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
name, data string
|
||||
want any
|
||||
}{
|
||||
{"inline button", `{"blocks":[{"type":"paragraph","text":{"type":"button","button":{"text":["Go",{"type":"custom_emoji","custom_emoji_id":"123","alternative_text":"!"}],"switch_inline_query":""}}}]}`, RichBlockWrap{}},
|
||||
{"button row", `{"blocks":[{"type":"buttons","align":"right","buttons":[{"text":"Go","switch_inline_query_current_chat":""},{"text":"Choose","switch_inline_query_chosen_chat":{"query":"x","allow_user_chats":true}}]}]}`, RichBlockButtons{}},
|
||||
{"expandable quote", `{"blocks":[{"type":"expandable_blockquote","text":{"type":"bold","text":"quote"},"credit":"source"}]}`, RichBlockExpandableBlockQuotation{}},
|
||||
{"document", `{"blocks":[{"type":"document","document":{"file_id":"file","file_unique_id":"unique","file_name":"notes.txt"},"caption":{"text":"Notes","credit":"Author"}}]}`, RichBlockDocument{}},
|
||||
{"compact table", `{"blocks":[{"type":"table","cells":[],"is_compact":true}]}`, RichBlockTable{}},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
msg, err := UnmarshalRichMessage([]byte(tc.data))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if reflect.TypeOf(msg.Blocks[0]) != reflect.TypeOf(tc.want) {
|
||||
t.Fatalf("got %T", msg.Blocks[0])
|
||||
}
|
||||
data, err := json.Marshal(msg)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
// Compare the second decode to avoid unrelated omitted zero-value media fields.
|
||||
again, err := UnmarshalRichMessage(data)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !reflect.DeepEqual(msg, again) {
|
||||
t.Fatalf("round trip lost data: %s", data)
|
||||
}
|
||||
if strings.Contains(tc.data, `"switch_inline_query":""`) && !strings.Contains(string(data), `"switch_inline_query":""`) {
|
||||
t.Fatalf("lost empty query: %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichButtonActionsRoundTrip(t *testing.T) {
|
||||
for _, action := range []string{
|
||||
`"url":"https://example.com"`, `"callback_data":"callback","style":"link"`,
|
||||
`"web_app":{"url":"https://example.com"}`, `"login_url":{"url":"https://example.com","forward_text":"Forward","request_write_access":true}`,
|
||||
`"switch_inline_query":""`, `"switch_inline_query_current_chat":""`,
|
||||
`"switch_inline_query_chosen_chat":{"allow_user_chats":true}`, `"copy_text":{"text":"Copy"}`, `"disabled":{}`,
|
||||
} {
|
||||
raw := `{"text":"Button",` + action + `}`
|
||||
var button RichMessageButton
|
||||
if err := json.Unmarshal([]byte(raw), &button); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
encoded, err := json.Marshal(button)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var expected, actual any
|
||||
if err := json.Unmarshal([]byte(raw), &expected); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := json.Unmarshal(encoded, &actual); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !reflect.DeepEqual(expected, actual) {
|
||||
t.Fatalf("wire fields changed: %s -> %s", raw, encoded)
|
||||
}
|
||||
var again RichMessageButton
|
||||
if err := json.Unmarshal(encoded, &again); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !reflect.DeepEqual(button, again) {
|
||||
t.Fatalf("action lost: %s", encoded)
|
||||
}
|
||||
if button.Text != RichTextPlain("Button") {
|
||||
t.Fatalf("label lost: %#v", button)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRich103Malformed(t *testing.T) {
|
||||
for _, raw := range []string{
|
||||
`{"type":"button","button":{"text":null,"disabled":{}}}`,
|
||||
} {
|
||||
if _, err := UnmarshalRichText([]byte(raw)); err == nil {
|
||||
t.Fatalf("accepted %s", raw)
|
||||
}
|
||||
}
|
||||
for _, raw := range []string{
|
||||
`{"type":"buttons","buttons":[{"text":null,"disabled":{}}]}`,
|
||||
`{"type":"document","document":42}`,
|
||||
} {
|
||||
if _, err := UnmarshalRichBlock([]byte(raw)); err == nil {
|
||||
t.Fatalf("accepted %s", raw)
|
||||
}
|
||||
}
|
||||
raw := `"x"`
|
||||
for range 70 {
|
||||
raw = `{"type":"button","button":{"text":` + raw + `,"disabled":{}}}`
|
||||
}
|
||||
if _, err := UnmarshalRichText([]byte(raw)); err == nil {
|
||||
t.Fatal("accepted excessive nesting")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichDocumentMultipart(t *testing.T) {
|
||||
params := SendRichMessage{ChatID: 42, RichMessage: InputRichMessage{
|
||||
HTML: `<tg-document src="tg://document?id=notes"></tg-document>`,
|
||||
Media: []InputRichMessageMedia{{ID: "notes", Media: InputMedia{Type: InputMediaTypeDocument, Media: "attach://notes"}}},
|
||||
}}
|
||||
body, contentType := prepareMultipartStream([]UploaderFile{NewUploaderFile("notes.txt", []byte("hello")).SetAttachName("notes")}, params)
|
||||
defer func() { _ = body.Close() }()
|
||||
_, attrs, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
reader := multipart.NewReader(body, attrs["boundary"])
|
||||
gotFile, gotMessage := false, false
|
||||
for {
|
||||
part, err := reader.NextPart()
|
||||
if err == io.EOF {
|
||||
break
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
data, err := io.ReadAll(part)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
switch part.FormName() {
|
||||
case "notes":
|
||||
gotFile = true
|
||||
if part.FileName() != "notes.txt" || string(data) != "hello" {
|
||||
t.Fatalf("bad file part: %s", data)
|
||||
}
|
||||
case "rich_message":
|
||||
gotMessage = true
|
||||
if !strings.Contains(string(data), `"media":"attach://notes"`) || !strings.Contains(string(data), `"type":"document"`) {
|
||||
t.Fatalf("bad rich payload: %s", data)
|
||||
}
|
||||
}
|
||||
}
|
||||
if !gotFile || !gotMessage {
|
||||
t.Fatal("missing multipart parts")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,717 @@
|
||||
package tgapi
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
// RichBlockButtonAlign selects horizontal alignment of a button row.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichBlockButtonAlign string
|
||||
|
||||
const (
|
||||
// RichBlockButtonLeft aligns buttons to left.
|
||||
RichBlockButtonLeft RichBlockButtonAlign = "left"
|
||||
// RichBlockButtonCenter aligns buttons to center.
|
||||
RichBlockButtonCenter RichBlockButtonAlign = "center"
|
||||
// RichBlockButtonRight aligns buttons to right.
|
||||
RichBlockButtonRight RichBlockButtonAlign = "right"
|
||||
)
|
||||
|
||||
// RichBlock is a block in a structured rich message.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlock interface {
|
||||
isRichBlock()
|
||||
}
|
||||
|
||||
// RichBlockUnknown preserves an unrecognized rich-block object for lossless forwarding.
|
||||
type RichBlockUnknown struct {
|
||||
// Raw contains the complete JSON object received from Telegram.
|
||||
Raw json.RawMessage
|
||||
}
|
||||
|
||||
func (RichBlockUnknown) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
func (u RichBlockUnknown) MarshalJSON() ([]byte, error) {
|
||||
if !json.Valid(u.Raw) {
|
||||
return nil, errInvalidUnknownRichJSON
|
||||
}
|
||||
return append([]byte(nil), u.Raw...), nil
|
||||
}
|
||||
|
||||
// RichBlockCaption is the caption of a media block or container.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockCaption struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c RichBlockCaption) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Text RichText `json:"text"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{c.Text, c.Credit})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c *RichBlockCaption) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Text json.RawMessage `json:"text"`
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
text, err := parseOptRichText(raw.Text)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*c = RichBlockCaption{text, credit}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockListItem is a single list item. Label is the ready-to-display
|
||||
// visible marker ("1.", "c.", "vii.", "•"): the server renders it itself
|
||||
// when parsing html/markdown.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockListItem struct {
|
||||
// Label contains the list-item label.
|
||||
Label string
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// HasCheckbox reports whether the list item includes a checkbox.
|
||||
HasCheckbox bool
|
||||
// IsChecked reports whether the list-item checkbox is checked.
|
||||
IsChecked bool
|
||||
// Value is the numeric marker value for an ordered list item.
|
||||
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"
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (i RichBlockListItem) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Label string `json:"label"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
HasCheckbox bool `json:"has_checkbox,omitempty"`
|
||||
IsChecked bool `json:"is_checked,omitempty"`
|
||||
Value int `json:"value,omitempty"`
|
||||
Type RichBlockListItemType `json:"type,omitempty"`
|
||||
}{i.Label, i.Blocks, i.HasCheckbox, i.IsChecked, i.Value, i.Type})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (i *RichBlockListItem) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Label string `json:"label"`
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
HasCheckbox bool `json:"has_checkbox"`
|
||||
IsChecked bool `json:"is_checked"`
|
||||
Value int `json:"value"`
|
||||
Type RichBlockListItemType `json:"type"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*i = RichBlockListItem{raw.Label, blocks, raw.HasCheckbox, raw.IsChecked, raw.Value, raw.Type}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockTableCell is a table cell. An empty Text means an invisible cell.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockTableCell struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// IsHeader marks the table cell as a header cell.
|
||||
IsHeader bool
|
||||
// ColSpan is the number of table columns spanned by the cell.
|
||||
ColSpan int
|
||||
// RowSpan is the number of table rows spanned by the cell.
|
||||
RowSpan int
|
||||
// Align is the horizontal alignment: 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"
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c RichBlockTableCell) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Text RichText `json:"text,omitempty"`
|
||||
IsHeader bool `json:"is_header,omitempty"`
|
||||
Colspan int `json:"colspan,omitempty"`
|
||||
Rowspan int `json:"rowspan,omitempty"`
|
||||
Align string `json:"align,omitempty"`
|
||||
VAlign string `json:"valign,omitempty"`
|
||||
}{c.Text, c.IsHeader, c.ColSpan, c.RowSpan, c.Align, c.VAlign})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c *RichBlockTableCell) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Text json.RawMessage `json:"text"`
|
||||
IsHeader bool `json:"is_header"`
|
||||
Colspan int `json:"colspan"`
|
||||
Rowspan int `json:"rowspan"`
|
||||
Align string `json:"align"`
|
||||
VAlign string `json:"valign"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
text, err := parseOptRichText(raw.Text)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*c = RichBlockTableCell{text, raw.IsHeader, raw.Colspan, raw.Rowspan, raw.Align, raw.VAlign}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockWrap covers all blocks that have only a text field.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockWrap struct {
|
||||
// Tag identifies the rich-text formatting wrapper.
|
||||
Tag string
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
}
|
||||
|
||||
func (RichBlockWrap) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockWrap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
}{b.Tag, b.Text})
|
||||
}
|
||||
|
||||
var richBlockWrapTags = map[string]bool{
|
||||
"paragraph": true, "footer": true, "thinking": true,
|
||||
}
|
||||
|
||||
// RichBlockSectionHeading is a section heading block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockSectionHeading struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Size is the heading level from 1 through 6, where 1 is largest.
|
||||
Size int // 1-6, 1 is the largest
|
||||
}
|
||||
|
||||
func (RichBlockSectionHeading) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockSectionHeading) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Size int `json:"size"`
|
||||
}{"heading", b.Text, b.Size})
|
||||
}
|
||||
|
||||
// RichBlockPreformatted is a preformatted code block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPreformatted struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Language identifies the programming language used for syntax highlighting.
|
||||
Language string
|
||||
}
|
||||
|
||||
func (RichBlockPreformatted) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPreformatted) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Language string `json:"language,omitempty"`
|
||||
}{"pre", b.Text, b.Language})
|
||||
}
|
||||
|
||||
// RichBlockQuotation is a block quotation with block-level content
|
||||
// (officially RichBlockBlockQuotation).
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockQuotation struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
func (RichBlockQuotation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockQuotation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{"blockquote", b.Blocks, b.Credit})
|
||||
}
|
||||
|
||||
// RichBlockPullQuotation is a pull quotation with inline content.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPullQuotation struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
func (RichBlockPullQuotation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPullQuotation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{"pullquote", b.Text, b.Credit})
|
||||
}
|
||||
|
||||
// RichBlockList is a list block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockList struct {
|
||||
// Items contains the list items.
|
||||
Items []RichBlockListItem
|
||||
}
|
||||
|
||||
func (RichBlockList) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockList) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Items []RichBlockListItem `json:"items"`
|
||||
}{"list", b.Items})
|
||||
}
|
||||
|
||||
// RichBlockCollage is a collage of media blocks.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockCollage struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockCollage) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockCollage) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"collage", b.Blocks, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockSlideshow is a slideshow of media blocks.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockSlideshow struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockSlideshow) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockSlideshow) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"slideshow", b.Blocks, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockDetails is an expandable block with an inline summary.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockDetails struct {
|
||||
// Summary contains the visible summary of a details block.
|
||||
Summary RichText
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// IsOpen requests the details block to be expanded initially.
|
||||
IsOpen bool
|
||||
}
|
||||
|
||||
func (RichBlockDetails) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockDetails) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Summary RichText `json:"summary"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
IsOpen bool `json:"is_open,omitempty"`
|
||||
}{"details", b.Summary, b.Blocks, b.IsOpen})
|
||||
}
|
||||
|
||||
// RichBlockTable is a table block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockTable struct {
|
||||
// Cells contains the table rows and cells.
|
||||
Cells [][]RichBlockTableCell
|
||||
// IsBordered requests visible table borders.
|
||||
IsBordered bool
|
||||
// IsStriped requests alternating table row styling.
|
||||
IsStriped bool
|
||||
// IsCompact requests smaller table-cell padding.
|
||||
IsCompact bool // Since: Bot API 10.3
|
||||
// Caption contains the media or block caption.
|
||||
Caption RichText
|
||||
}
|
||||
|
||||
func (RichBlockTable) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockTable) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
IsBordered bool `json:"is_bordered,omitempty"`
|
||||
IsStriped bool `json:"is_striped,omitempty"`
|
||||
IsCompact bool `json:"is_compact,omitempty"`
|
||||
Caption RichText `json:"caption,omitempty"`
|
||||
}{"table", b.Cells, b.IsBordered, b.IsStriped, b.IsCompact, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockMap is a location map block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockMap struct {
|
||||
// Location contains the map location.
|
||||
Location Location
|
||||
// Zoom is the map zoom level in the range 13 through 20.
|
||||
Zoom int // 13-20
|
||||
// Width is the requested media or map width in pixels.
|
||||
Width int
|
||||
// Height is the requested media or map height in pixels.
|
||||
Height int
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockMap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Location Location `json:"location"`
|
||||
Zoom int `json:"zoom"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"map", b.Location, b.Zoom, b.Width, b.Height, b.Caption})
|
||||
}
|
||||
func (RichBlockMap) isRichBlock() {}
|
||||
|
||||
// RichBlockButtons is a row of buttons corresponding to <tg-button-row>.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichBlockButtons struct {
|
||||
// Buttons contains the row contents.
|
||||
Buttons []RichMessageButton `json:"buttons"`
|
||||
// Align optionally selects left, center, or right alignment.
|
||||
Align RichBlockButtonAlign `json:"align,omitempty"`
|
||||
}
|
||||
|
||||
// MarshalJSON adds the buttons type discriminator.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (b RichBlockButtons) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Buttons []RichMessageButton `json:"buttons"`
|
||||
Align RichBlockButtonAlign `json:"align,omitempty"`
|
||||
}{"buttons", b.Buttons, b.Align})
|
||||
}
|
||||
func (RichBlockButtons) isRichBlock() {}
|
||||
|
||||
// RichBlockPhoto is a photo block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPhoto struct {
|
||||
// Photo contains or identifies the associated photo.
|
||||
Photo []PhotoSize
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockPhoto) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPhoto) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"photo", b.Photo, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockVideo is a video block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockVideo struct {
|
||||
// Video contains the video rendered by the block.
|
||||
Video Video
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockVideo) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockVideo) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Video Video `json:"video"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"video", b.Video, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockAudio is an audio block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAudio struct {
|
||||
// Audio contains the audio rendered by the block.
|
||||
Audio Audio
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockAudio) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAudio) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Audio Audio `json:"audio"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"audio", b.Audio, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockAnimation is an animation block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAnimation struct {
|
||||
// Animation contains the animation rendered by the block.
|
||||
Animation Animation
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockAnimation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAnimation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Animation Animation `json:"animation"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"animation", b.Animation, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockVoiceNote is a voice note block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockVoiceNote struct {
|
||||
// VoiceNote contains the voice note rendered by the block.
|
||||
VoiceNote Voice
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockVoiceNote) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockVoiceNote) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
VoiceNote Voice `json:"voice_note"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"voice_note", b.VoiceNote, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockDivider is a horizontal divider block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockDivider struct{}
|
||||
|
||||
func (RichBlockDivider) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockDivider) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
}{"divider"})
|
||||
}
|
||||
|
||||
// RichBlockMathematicalExpression is a block-level mathematical expression.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockMathematicalExpression struct {
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string
|
||||
}
|
||||
|
||||
func (RichBlockMathematicalExpression) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockMathematicalExpression) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Expression string `json:"expression"`
|
||||
}{"mathematical_expression", b.Expression})
|
||||
}
|
||||
|
||||
// RichBlockAnchor is a named anchor block that anchor links can point to.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAnchor struct {
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichBlockAnchor) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAnchor) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Name string `json:"name"`
|
||||
}{"anchor", b.Name})
|
||||
}
|
||||
|
||||
// RichBlockExpandableBlockQuotation corresponds to <blockquote expandable>.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichBlockExpandableBlockQuotation struct {
|
||||
// Text is the quotation content.
|
||||
Text RichText `json:"text"`
|
||||
// Credit optionally identifies the source.
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (RichBlockExpandableBlockQuotation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON adds the expandable_blockquote type discriminator.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (b RichBlockExpandableBlockQuotation) MarshalJSON() ([]byte, error) {
|
||||
type plain RichBlockExpandableBlockQuotation
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
plain
|
||||
}{"expandable_blockquote", plain(b)})
|
||||
}
|
||||
|
||||
// RichBlockDocument is a general-file block corresponding to <tg-document>.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichBlockDocument struct {
|
||||
// Document is the attached file.
|
||||
Document Document `json:"document"`
|
||||
// Caption optionally supplies the block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (RichBlockDocument) isRichBlock() {}
|
||||
|
||||
// MarshalJSON adds the document type discriminator.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (b RichBlockDocument) MarshalJSON() ([]byte, error) {
|
||||
type plain RichBlockDocument
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
plain
|
||||
}{"document", plain(b)})
|
||||
}
|
||||
@@ -0,0 +1,485 @@
|
||||
package tgapi
|
||||
|
||||
// InputRichType identifies the JSON type of an input rich block.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichType string
|
||||
|
||||
const (
|
||||
// InputRichTypeParagraph identifies a paragraph block.
|
||||
InputRichTypeParagraph InputRichType = "paragraph"
|
||||
// InputRichTypeSectionHeading identifies a section-heading block.
|
||||
InputRichTypeSectionHeading InputRichType = "heading"
|
||||
// InputRichTypePre identifies a preformatted block.
|
||||
InputRichTypePre InputRichType = "pre"
|
||||
// InputRichTypeFooter identifies a footer block.
|
||||
InputRichTypeFooter InputRichType = "footer"
|
||||
// InputRichTypeDivider identifies a divider block.
|
||||
InputRichTypeDivider InputRichType = "divider"
|
||||
// InputRichTypeMathematicalExpression identifies a mathematical-expression block.
|
||||
InputRichTypeMathematicalExpression InputRichType = "mathematical_expression"
|
||||
// InputRichTypeAnchor identifies an anchor block.
|
||||
InputRichTypeAnchor InputRichType = "anchor"
|
||||
// InputRichTypeList identifies a list block.
|
||||
InputRichTypeList InputRichType = "list"
|
||||
// InputRichTypeBlockQuotation identifies a block-quotation block.
|
||||
InputRichTypeBlockQuotation InputRichType = "blockquote"
|
||||
// InputRichTypePullQuotation identifies a pull-quotation block.
|
||||
InputRichTypePullQuotation InputRichType = "pullquote"
|
||||
// InputRichTypeCollage identifies a collage block.
|
||||
InputRichTypeCollage InputRichType = "collage"
|
||||
// InputRichTypeSlideshow identifies a slideshow block.
|
||||
InputRichTypeSlideshow InputRichType = "slideshow"
|
||||
// InputRichTypeTable identifies a table block.
|
||||
InputRichTypeTable InputRichType = "table"
|
||||
// InputRichTypeDetails identifies an expandable details block.
|
||||
InputRichTypeDetails InputRichType = "details"
|
||||
// InputRichTypeMap identifies a map block.
|
||||
InputRichTypeMap InputRichType = "map"
|
||||
// InputRichTypeButtons identifies a button row.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
InputRichTypeButtons InputRichType = "buttons"
|
||||
// InputRichTypeAnimation identifies an animation block.
|
||||
InputRichTypeAnimation InputRichType = "animation"
|
||||
// InputRichTypeAudio identifies an audio block.
|
||||
InputRichTypeAudio InputRichType = "audio"
|
||||
// InputRichTypePhoto identifies a photo block.
|
||||
InputRichTypePhoto InputRichType = "photo"
|
||||
// InputRichTypeVideo identifies a video block.
|
||||
InputRichTypeVideo InputRichType = "video"
|
||||
// InputRichTypeVoiceNote identifies a voice-note block.
|
||||
InputRichTypeVoiceNote InputRichType = "voice_note"
|
||||
// InputRichTypeThinking identifies a thinking block.
|
||||
InputRichTypeThinking InputRichType = "thinking"
|
||||
)
|
||||
|
||||
// InputRichBlock represents a block available to format an outgoing rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlock interface {
|
||||
isInputRichBlock()
|
||||
}
|
||||
|
||||
// InputRichBlockParagraph is a text paragraph corresponding to the HTML <p> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockParagraph struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockParagraph) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockSectionHeading is a section heading corresponding to an HTML <h1> through <h6> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockSectionHeading struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Size selects the section heading level from 1 through 6.
|
||||
Size uint8 `json:"size"`
|
||||
}
|
||||
|
||||
func (InputRichBlockSectionHeading) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPreformatted is a preformatted text block corresponding to nested HTML <pre> and <code> tags.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPreformatted struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Language identifies the programming language used for syntax highlighting.
|
||||
Language string `json:"language,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPreformatted) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockFooter is a footer corresponding to the HTML <footer> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockFooter struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockFooter) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockDivider is a divider corresponding to the HTML <hr/> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockDivider struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
}
|
||||
|
||||
func (InputRichBlockDivider) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockMath is a block containing a mathematical expression in LaTeX format,
|
||||
// corresponding to the custom HTML <tg-math-block> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockMath struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
|
||||
func (InputRichBlockMath) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAnchor is a block containing an anchor corresponding to an HTML <a> tag with a name attribute.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAnchor struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAnchor) isInputRichBlock() {}
|
||||
|
||||
// RichBlockListItemType identifies an ordered-list label style.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type RichBlockListItemType string
|
||||
|
||||
const (
|
||||
// InputRichBlockListItemTypeLower uses lowercase letters.
|
||||
InputRichBlockListItemTypeLower RichBlockListItemType = "a"
|
||||
// InputRichBlockListItemTypeUpper uses uppercase letters.
|
||||
InputRichBlockListItemTypeUpper RichBlockListItemType = "A"
|
||||
// InputRichBlockListItemTypeRomanLow uses lowercase Roman numerals.
|
||||
InputRichBlockListItemTypeRomanLow RichBlockListItemType = "i"
|
||||
// InputRichBlockListItemTypeRomanUpper uses uppercase Roman numerals.
|
||||
InputRichBlockListItemTypeRomanUpper RichBlockListItemType = "I"
|
||||
// InputRichBlockListItemTypeDecimal uses decimal numbers.
|
||||
InputRichBlockListItemTypeDecimal RichBlockListItemType = "1"
|
||||
)
|
||||
|
||||
// InputRichBlockListItem represents an item in an input rich-message list.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockListItem struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// HasCheckbox reports whether the list item includes a checkbox.
|
||||
HasCheckbox bool `json:"has_checkbox,omitempty"`
|
||||
// IsChecked reports whether the list-item checkbox is checked.
|
||||
IsChecked bool `json:"is_checked,omitempty"`
|
||||
// Value sets the numeric marker value for an ordered list item.
|
||||
Value int `json:"value,omitempty"`
|
||||
// Type is the Bot API type discriminator.
|
||||
Type RichBlockListItemType `json:"type,omitempty"`
|
||||
}
|
||||
|
||||
// NewInputRichBlockListItem creates a list item containing blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func NewInputRichBlockListItem(blocks ...InputRichBlock) *InputRichBlockListItem {
|
||||
return &InputRichBlockListItem{Blocks: blocks}
|
||||
}
|
||||
|
||||
// SetCheckbox configures whether the list item has a checkbox.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetCheckbox(hasCheckbox bool) *InputRichBlockListItem {
|
||||
i.HasCheckbox = hasCheckbox
|
||||
return i
|
||||
}
|
||||
|
||||
// Check marks the list item's checkbox as checked.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) Check() *InputRichBlockListItem {
|
||||
i.IsChecked = true
|
||||
return i
|
||||
}
|
||||
|
||||
// SetValue sets the numeric value of an ordered-list item.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetValue(val int) *InputRichBlockListItem {
|
||||
i.Value = val
|
||||
return i
|
||||
}
|
||||
|
||||
// SetType sets the label style of an ordered-list item.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetType(t RichBlockListItemType) *InputRichBlockListItem {
|
||||
i.Type = t
|
||||
return i
|
||||
}
|
||||
|
||||
// InputRichBlockList is a list of input rich-message blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockList struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Items contains the list items.
|
||||
Items []InputRichBlockListItem `json:"items"`
|
||||
}
|
||||
|
||||
func (InputRichBlockList) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockBlockQuotation is a block quotation in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockBlockQuotation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit *RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockBlockQuotation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPullQuotation is a centered quotation in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPullQuotation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit *RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPullQuotation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockCollage is a collage in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockCollage struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockCollage) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockSlideshow is a slideshow in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockSlideshow struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockSlideshow) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockTable is a table in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockTable struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Cells contains the table rows and cells.
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
// IsBordered requests visible table borders.
|
||||
IsBordered bool `json:"is_bordered,omitempty"`
|
||||
// IsStriped requests alternating table row styling.
|
||||
IsStriped bool `json:"is_striped,omitempty"`
|
||||
// IsCompact requests smaller table-cell padding.
|
||||
IsCompact bool `json:"is_compact,omitempty"` // Since: Bot API 10.3
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichText `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockTable) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockDetails is an expandable block in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockDetails struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Summary contains the visible summary of a details block.
|
||||
Summary RichText `json:"summary"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// IsOpen requests the details block to be expanded initially.
|
||||
IsOpen bool `json:"is_open,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockDetails) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockMap is a location map in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockMap struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Location contains the map location.
|
||||
Location Location `json:"location"`
|
||||
// Zoom sets the map zoom level.
|
||||
Zoom uint8 `json:"zoom,omitempty"`
|
||||
// Width is the requested media or map width in pixels.
|
||||
Width uint16 `json:"width,omitempty"`
|
||||
// Height is the requested media or map height in pixels.
|
||||
Height uint16 `json:"height,omitempty"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockMap) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockButtons is a block containing a list of buttons that are shown in one row.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type InputRichBlockButtons struct {
|
||||
// Type is always buttons.
|
||||
Type InputRichType `json:"type"`
|
||||
// Buttons contains 1-8 buttons in one row.
|
||||
Buttons []RichMessageButton `json:"buttons"`
|
||||
// Align optionally selects left, center, or right alignment.
|
||||
Align RichBlockButtonAlign `json:"align,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockButtons) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAnimation is an animation block corresponding to the HTML <video> tag.
|
||||
// The animation caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAnimation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Animation contains the animation rendered by the block.
|
||||
Animation InputMedia `json:"animation"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAnimation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAudio is a music-file block corresponding to the HTML <audio> tag.
|
||||
// The audio caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAudio struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Audio contains the audio rendered by the block.
|
||||
Audio InputMedia `json:"audio"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAudio) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPhoto is a photo block corresponding to the HTML <img> tag.
|
||||
// The photo caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPhoto struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Photo contains or identifies the associated photo.
|
||||
Photo InputMedia `json:"photo"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPhoto) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockVideo is a video block corresponding to the HTML <video> tag.
|
||||
// The video caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockVideo struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Video contains the video rendered by the block.
|
||||
Video InputMedia `json:"video"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockVideo) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockVoiceNote is a voice-note block corresponding to the HTML <audio> tag.
|
||||
// The voice-note caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockVoiceNote struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// VoiceNote contains the voice note rendered by the block.
|
||||
VoiceNote InputMedia `json:"voice_note"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockVoiceNote) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockThinking is a block for displaying a thinking state.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockThinking struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockThinking) isInputRichBlock() {}
|
||||
|
||||
// InputRichTypeExpandableBlockQuotation identifies an expandable quotation.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
const InputRichTypeExpandableBlockQuotation InputRichType = "expandable_blockquote"
|
||||
|
||||
// InputRichTypeDocument identifies a general-file block.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
const InputRichTypeDocument InputRichType = "document"
|
||||
|
||||
// InputRichBlockExpandableBlockQuotation corresponds to <blockquote expandable>.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type InputRichBlockExpandableBlockQuotation struct {
|
||||
// Type is always expandable_blockquote.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text is the quotation content.
|
||||
Text RichText `json:"text"`
|
||||
// Credit optionally identifies the source.
|
||||
Credit *RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockExpandableBlockQuotation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockDocument corresponds to <tg-document>.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type InputRichBlockDocument struct {
|
||||
// Type is always document.
|
||||
Type InputRichType `json:"type"`
|
||||
// Document contains document media; its caption is ignored in favor of Caption.
|
||||
Document InputMedia `json:"document"`
|
||||
// Caption optionally supplies the block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockDocument) isInputRichBlock() {}
|
||||
@@ -0,0 +1,65 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestInputRichMediaBlocksMarshal(t *testing.T) {
|
||||
caption := RichBlockCaption{Text: RichTextPlain("caption")}
|
||||
cases := []struct {
|
||||
name string
|
||||
block InputRichBlock
|
||||
blockType InputRichType
|
||||
mediaKey string
|
||||
mediaType InputMediaType
|
||||
}{
|
||||
{"animation", InputRichBlockAnimation{Type: InputRichTypeAnimation, Animation: InputMedia{Type: InputMediaTypeAnimation, Media: "animation-id"}, Caption: &caption}, InputRichTypeAnimation, "animation", InputMediaTypeAnimation},
|
||||
{"audio", InputRichBlockAudio{Type: InputRichTypeAudio, Audio: InputMedia{Type: InputMediaTypeAudio, Media: "audio-id"}, Caption: &caption}, InputRichTypeAudio, "audio", InputMediaTypeAudio},
|
||||
{"photo", InputRichBlockPhoto{Type: InputRichTypePhoto, Photo: InputMedia{Type: InputMediaTypePhoto, Media: "photo-id"}, Caption: &caption}, InputRichTypePhoto, "photo", InputMediaTypePhoto},
|
||||
{"video", InputRichBlockVideo{Type: InputRichTypeVideo, Video: InputMedia{Type: InputMediaTypeVideo, Media: "video-id"}, Caption: &caption}, InputRichTypeVideo, "video", InputMediaTypeVideo},
|
||||
{"voice note", InputRichBlockVoiceNote{Type: InputRichTypeVoiceNote, VoiceNote: InputMedia{Type: InputMediaTypeVoiceNote, Media: "voice-id"}, Caption: &caption}, InputRichTypeVoiceNote, "voice_note", InputMediaTypeVoiceNote},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(InputRichMessage{Blocks: []InputRichBlock{tt.block}})
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
|
||||
var message struct {
|
||||
Blocks []map[string]json.RawMessage `json:"blocks"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &message); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if len(message.Blocks) != 1 {
|
||||
t.Fatalf("got %d blocks, want 1", len(message.Blocks))
|
||||
}
|
||||
|
||||
var blockType InputRichType
|
||||
if err := json.Unmarshal(message.Blocks[0]["type"], &blockType); err != nil {
|
||||
t.Fatalf("unmarshal block type: %v", err)
|
||||
}
|
||||
if blockType != tt.blockType {
|
||||
t.Errorf("block type = %q, want %q", blockType, tt.blockType)
|
||||
}
|
||||
|
||||
var media InputMedia
|
||||
if err := json.Unmarshal(message.Blocks[0][tt.mediaKey], &media); err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", tt.mediaKey, err)
|
||||
}
|
||||
if media.Type != tt.mediaType {
|
||||
t.Errorf("media type = %q, want %q", media.Type, tt.mediaType)
|
||||
}
|
||||
if message.Blocks[0]["caption"] == nil {
|
||||
t.Error("caption is missing")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichBlockMapImplementsInputRichBlock(t *testing.T) {
|
||||
var _ InputRichBlock = InputRichBlockMap{}
|
||||
}
|
||||
@@ -0,0 +1,516 @@
|
||||
package tgapi
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
// RichText is a node of the rich formatted text tree: a plain string, an
|
||||
// array, or one of the typed objects below.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichText interface {
|
||||
isRichText()
|
||||
}
|
||||
|
||||
// RichTextPlain is a plain text leaf.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextPlain string
|
||||
|
||||
func (RichTextPlain) isRichText() {}
|
||||
|
||||
// RichTextArray is a concatenation of rich text nodes.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextArray []RichText
|
||||
|
||||
func (RichTextArray) isRichText() {}
|
||||
|
||||
// RichTextUnknown preserves an unrecognized rich-text object for lossless forwarding.
|
||||
type RichTextUnknown struct {
|
||||
// Raw contains the complete JSON object received from Telegram.
|
||||
Raw json.RawMessage
|
||||
}
|
||||
|
||||
func (RichTextUnknown) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
func (u RichTextUnknown) MarshalJSON() ([]byte, error) {
|
||||
if !json.Valid(u.Raw) {
|
||||
return nil, errInvalidUnknownRichJSON
|
||||
}
|
||||
return append([]byte(nil), u.Raw...), nil
|
||||
}
|
||||
|
||||
// RichTextWrap covers all "pure" wrapper nodes with a single type.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextWrap struct {
|
||||
// Tag identifies the rich-text formatting wrapper.
|
||||
Tag string
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
}
|
||||
|
||||
func (RichTextWrap) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (w RichTextWrap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
}{w.Tag, w.Text})
|
||||
}
|
||||
|
||||
var richTextWrapTags = map[string]bool{
|
||||
"bold": true, "italic": true, "underline": true,
|
||||
"strikethrough": true, "spoiler": true, "subscript": true,
|
||||
"superscript": true, "marked": true, "code": true,
|
||||
}
|
||||
|
||||
// RichTextURL is rich text linking to a URL.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextURL struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// URL contains the HTTP URL.
|
||||
URL string
|
||||
}
|
||||
|
||||
func (RichTextURL) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextURL) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
URL string `json:"url"`
|
||||
}{"url", v.Text, v.URL})
|
||||
}
|
||||
|
||||
// RichTextEmailAddress is rich text linking to an email address.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextEmailAddress struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// EmailAddress is the email address associated with the text.
|
||||
EmailAddress string
|
||||
}
|
||||
|
||||
func (RichTextEmailAddress) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextEmailAddress) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
EmailAddress string `json:"email_address"`
|
||||
}{"email_address", v.Text, v.EmailAddress})
|
||||
}
|
||||
|
||||
// RichTextPhoneNumber is rich text linking to a phone number.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextPhoneNumber struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// PhoneNumber is the phone number associated with the text.
|
||||
PhoneNumber string
|
||||
}
|
||||
|
||||
func (RichTextPhoneNumber) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextPhoneNumber) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
}{"phone_number", v.Text, v.PhoneNumber})
|
||||
}
|
||||
|
||||
// RichTextBankCardNumber is rich text marked as a bank card number.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextBankCardNumber struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// BankCardNumber is the bank card number associated with the text.
|
||||
BankCardNumber string
|
||||
}
|
||||
|
||||
func (RichTextBankCardNumber) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextBankCardNumber) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
BankCardNumber string `json:"bank_card_number"`
|
||||
}{"bank_card_number", v.Text, v.BankCardNumber})
|
||||
}
|
||||
|
||||
// RichTextMention is rich text mentioning a user by username.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextMention struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Username is the username associated with the mention.
|
||||
Username string
|
||||
}
|
||||
|
||||
func (RichTextMention) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextMention) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Username string `json:"username"`
|
||||
}{"mention", v.Text, v.Username})
|
||||
}
|
||||
|
||||
// RichTextHashtag is rich text marked as a hashtag.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextHashtag struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Hashtag is the hashtag associated with the text.
|
||||
Hashtag string
|
||||
}
|
||||
|
||||
func (RichTextHashtag) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextHashtag) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Hashtag string `json:"hashtag"`
|
||||
}{"hashtag", v.Text, v.Hashtag})
|
||||
}
|
||||
|
||||
// RichTextCashtag is rich text marked as a cashtag.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextCashtag struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Cashtag is the cashtag associated with the text.
|
||||
Cashtag string
|
||||
}
|
||||
|
||||
func (RichTextCashtag) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextCashtag) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Cashtag string `json:"cashtag"`
|
||||
}{"cashtag", v.Text, v.Cashtag})
|
||||
}
|
||||
|
||||
// RichTextBotCommand is rich text marked as a bot command.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextBotCommand struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// BotCommand is the bot command associated with the text.
|
||||
BotCommand string
|
||||
}
|
||||
|
||||
func (RichTextBotCommand) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextBotCommand) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
BotCommand string `json:"bot_command"`
|
||||
}{"bot_command", v.Text, v.BotCommand})
|
||||
}
|
||||
|
||||
// RichMessageButton describes a rich-message button with exactly one action.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichMessageButton struct {
|
||||
// Text allows plain text, custom emoji, and date-time entities only.
|
||||
Text RichText `json:"text"`
|
||||
// Style selects danger, success, primary, or link; link requires a callback action.
|
||||
Style KeyboardButtonStyle `json:"style,omitempty"`
|
||||
// URL opens an HTTP or tg:// link.
|
||||
URL string `json:"url,omitempty"`
|
||||
// CallbackData sends 1-64 bytes to the bot when pressed.
|
||||
CallbackData string `json:"callback_data,omitempty"`
|
||||
// WebApp opens a Mini App in private chats; unavailable for business messages.
|
||||
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||
// LoginURL opens an HTTPS authorization link; unavailable for ephemeral messages.
|
||||
// Its BotUsername field is not supported in rich buttons.
|
||||
LoginURL *LoginURL `json:"login_url,omitempty"`
|
||||
// SwitchInlineQuery selects a chat for an inline query; a pointer to an empty string is valid.
|
||||
// Unavailable for channel direct messages and business messages.
|
||||
SwitchInlineQuery *string `json:"switch_inline_query,omitempty"`
|
||||
// SwitchInlineQueryCurrentChat inserts an inline query in the current chat; an empty query is valid.
|
||||
// Unavailable in channels, channel direct messages, and business messages.
|
||||
SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"`
|
||||
// SwitchInlineQueryChosenChat selects a permitted chat for an inline query.
|
||||
// Unavailable for channel direct messages and business messages.
|
||||
SwitchInlineQueryChosenChat *SwitchInlineQueryChosenChat `json:"switch_inline_query_chosen_chat,omitempty"`
|
||||
// CopyText copies the specified text to the clipboard.
|
||||
CopyText *CopyTextButton `json:"copy_text,omitempty"`
|
||||
// Disabled makes the button do nothing.
|
||||
Disabled *DisabledButton `json:"disabled,omitempty"`
|
||||
}
|
||||
|
||||
// UnmarshalJSON decodes the button's nested rich-text label.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (b *RichMessageButton) UnmarshalJSON(data []byte) error {
|
||||
if err := validateRichJSON(data); err != nil {
|
||||
return err
|
||||
}
|
||||
type plain RichMessageButton
|
||||
var raw struct {
|
||||
Text json.RawMessage `json:"text"`
|
||||
*plain
|
||||
}
|
||||
var result RichMessageButton
|
||||
raw.plain = (*plain)(&result)
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
text, err := unmarshalRichText(raw.Text)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
result.Text = text
|
||||
*b = result
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichTextButton embeds a button in rich text.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
type RichTextButton struct {
|
||||
// Button is the embedded button.
|
||||
Button RichMessageButton `json:"button"`
|
||||
}
|
||||
|
||||
// MarshalJSON adds the button type discriminator.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (v RichTextButton) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Button RichMessageButton `json:"button"`
|
||||
}{"button", v.Button})
|
||||
}
|
||||
func (v RichTextButton) isRichText() {}
|
||||
|
||||
// RichTextAnchorLink is rich text linking to a named anchor in the same message.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextAnchorLink struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// AnchorName names the anchor targeted by the link.
|
||||
AnchorName string
|
||||
}
|
||||
|
||||
func (RichTextAnchorLink) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextAnchorLink) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
AnchorName string `json:"anchor_name"`
|
||||
}{"anchor_link", v.Text, v.AnchorName})
|
||||
}
|
||||
|
||||
// RichTextReference is rich text marked as a named reference target.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextReference struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichTextReference) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextReference) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Name string `json:"name"`
|
||||
}{"reference", v.Text, v.Name})
|
||||
}
|
||||
|
||||
// RichTextReferenceLink is rich text linking to a named reference.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextReferenceLink struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// ReferenceName names the reference targeted by the link.
|
||||
ReferenceName string
|
||||
}
|
||||
|
||||
func (RichTextReferenceLink) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextReferenceLink) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
ReferenceName string `json:"reference_name"`
|
||||
}{"reference_link", v.Text, v.ReferenceName})
|
||||
}
|
||||
|
||||
// RichTextDateTime is rich text bound to a point in time with a display format.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextDateTime struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// UnixTime is the Unix timestamp associated with the text.
|
||||
UnixTime int64
|
||||
// DateTimeFormat controls how the associated Unix time is displayed.
|
||||
DateTimeFormat string
|
||||
}
|
||||
|
||||
func (RichTextDateTime) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextDateTime) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
UnixTime int64 `json:"unix_time"`
|
||||
DateTimeFormat string `json:"date_time_format"`
|
||||
}{"date_time", v.Text, v.UnixTime, v.DateTimeFormat})
|
||||
}
|
||||
|
||||
// RichTextTextMention is rich text mentioning a user without a username.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextTextMention struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// User contains the user associated with the value.
|
||||
User User
|
||||
}
|
||||
|
||||
func (RichTextTextMention) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextTextMention) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
User User `json:"user"`
|
||||
}{"text_mention", v.Text, v.User})
|
||||
}
|
||||
|
||||
// RichTextCustomEmoji is a custom emoji leaf with alternative text.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextCustomEmoji struct {
|
||||
// CustomEmojiID identifies the custom emoji.
|
||||
CustomEmojiID string
|
||||
// AlternativeText is shown when the custom emoji can't be rendered.
|
||||
AlternativeText string
|
||||
}
|
||||
|
||||
func (RichTextCustomEmoji) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextCustomEmoji) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
CustomEmojiID string `json:"custom_emoji_id"`
|
||||
AlternativeText string `json:"alternative_text"`
|
||||
}{"custom_emoji", v.CustomEmojiID, v.AlternativeText})
|
||||
}
|
||||
|
||||
// RichTextMathematicalExpression is an inline mathematical expression leaf.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextMathematicalExpression struct {
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string
|
||||
}
|
||||
|
||||
func (RichTextMathematicalExpression) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextMathematicalExpression) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Expression string `json:"expression"`
|
||||
}{"mathematical_expression", v.Expression})
|
||||
}
|
||||
|
||||
// RichTextAnchor is a named anchor leaf that anchor links can point to.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextAnchor struct {
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichTextAnchor) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextAnchor) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Name string `json:"name"`
|
||||
}{"anchor", v.Name})
|
||||
}
|
||||
|
||||
// RichMessageButtonStyleLink renders a callback button as a borderless link.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
const RichMessageButtonStyleLink KeyboardButtonStyle = "link"
|
||||
@@ -0,0 +1,85 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func roundtripRichText(t *testing.T, in RichText) {
|
||||
t.Helper()
|
||||
b, err := json.Marshal(in)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
out, err := UnmarshalRichText(b)
|
||||
if err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", b, err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextRoundtrip(t *testing.T) {
|
||||
cases := []RichText{
|
||||
RichTextPlain("hello"),
|
||||
RichTextArray{RichTextPlain("a "), RichTextWrap{"bold", RichTextPlain("b")}, RichTextPlain(" c")},
|
||||
RichTextWrap{"bold", RichTextWrap{"italic", RichTextPlain("nested")}},
|
||||
RichTextURL{RichTextPlain("Anthropic"), "https://anthropic.com"},
|
||||
RichTextCustomEmoji{"5368324170671202286", "👍"},
|
||||
RichTextMathematicalExpression{"x^2 + y^2"},
|
||||
RichTextAnchor{"chapter-1"},
|
||||
RichTextDateTime{RichTextPlain("22:45 tomorrow"), 1647531900, "wDT"},
|
||||
RichTextTextMention{RichTextPlain("Bob"), User{ID: 42, FirstName: "Bob"}},
|
||||
RichTextAnchorLink{RichTextPlain("back to top"), ""},
|
||||
RichTextReference{RichTextPlain("ref"), "note-1"},
|
||||
// deep nesting
|
||||
RichTextWrap{"bold", RichTextArray{
|
||||
RichTextPlain("bold and "),
|
||||
RichTextWrap{"italic", RichTextWrap{"underline", RichTextPlain("deep")}},
|
||||
RichTextWrap{"spoiler", RichTextCustomEmoji{"1", "x"}},
|
||||
}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
roundtripRichText(t, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextPlainFormsAreBare(t *testing.T) {
|
||||
b, _ := json.Marshal(RichTextPlain("hi"))
|
||||
if string(b) != `"hi"` {
|
||||
t.Fatalf("string should be bare: %s", b)
|
||||
}
|
||||
b, _ = json.Marshal(RichTextArray{RichTextPlain("a"), RichTextPlain("b")})
|
||||
if string(b) != `["a","b"]` {
|
||||
t.Fatalf("array should be bare: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextLeafHasNoText(t *testing.T) {
|
||||
b, _ := json.Marshal(RichTextAnchor{"x"})
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if _, ok := m["text"]; ok {
|
||||
t.Fatalf("anchor must not have text field: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichTextRejectsInvalidValues(t *testing.T) {
|
||||
tests := []string{
|
||||
`null`,
|
||||
`{"type":"date_time","text":"now","unix_time":"soon"}`,
|
||||
`{"type":"custom_emoji","custom_emoji_id":42}`,
|
||||
}
|
||||
for _, raw := range tests {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
if _, err := UnmarshalRichText([]byte(raw)); err == nil {
|
||||
t.Fatal("expected malformed rich text to be rejected")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,635 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
const (
|
||||
maximumRichJSONDepth = 64
|
||||
maximumRichJSONNodes = 10_000
|
||||
)
|
||||
|
||||
var errInvalidUnknownRichJSON = errors.New("invalid JSON in unknown rich object")
|
||||
|
||||
var knownRichTextTypes = map[string]bool{
|
||||
"url": true, "email_address": true, "phone_number": true,
|
||||
"bank_card_number": true, "mention": true, "hashtag": true,
|
||||
"cashtag": true, "bot_command": true, "anchor_link": true,
|
||||
"reference": true, "reference_link": true, "date_time": true,
|
||||
"text_mention": true, "custom_emoji": true,
|
||||
"mathematical_expression": true, "anchor": true, "button": true,
|
||||
}
|
||||
|
||||
// UnmarshalRichText parses a RichText tree from JSON: a string, an array, or
|
||||
// a typed object. Unknown object types are preserved as RichTextUnknown without
|
||||
// discarding fields.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
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")) {
|
||||
return nil, fmt.Errorf("richtext: null is not a rich text value")
|
||||
}
|
||||
// 1. string
|
||||
var s string
|
||||
if err := json.Unmarshal(data, &s); err == nil {
|
||||
return RichTextPlain(s), nil
|
||||
}
|
||||
// 2. array
|
||||
var raw []json.RawMessage
|
||||
if err := json.Unmarshal(data, &raw); err == nil {
|
||||
arr := make(RichTextArray, len(raw))
|
||||
for i, it := range raw {
|
||||
rt, err := unmarshalRichText(it)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
arr[i] = rt
|
||||
}
|
||||
return arr, nil
|
||||
}
|
||||
// 3. object -> dispatch on type, grabbing the raw text along the way
|
||||
var head struct {
|
||||
Type string `json:"type"`
|
||||
Text json.RawMessage `json:"text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &head); err != nil {
|
||||
return nil, fmt.Errorf("richtext: not a string, array or object: %w", err)
|
||||
}
|
||||
if head.Type == "" {
|
||||
return nil, errors.New("richtext: object type is required")
|
||||
}
|
||||
if !richTextWrapTags[head.Type] && !knownRichTextTypes[head.Type] {
|
||||
return RichTextUnknown{Raw: cloneRawJSON(data)}, nil
|
||||
}
|
||||
|
||||
// Recursively parse the nested text, if any.
|
||||
var inner RichText
|
||||
if len(head.Text) > 0 {
|
||||
var err error
|
||||
if inner, err = unmarshalRichText(head.Text); err != nil {
|
||||
return nil, fmt.Errorf("richtext %q: bad text: %w", head.Type, err)
|
||||
}
|
||||
}
|
||||
|
||||
if richTextWrapTags[head.Type] {
|
||||
return RichTextWrap{Tag: head.Type, Text: inner}, nil
|
||||
}
|
||||
|
||||
switch head.Type {
|
||||
case "url":
|
||||
var v struct {
|
||||
URL string `json:"url"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextURL{inner, v.URL}, nil
|
||||
case "email_address":
|
||||
var v struct {
|
||||
V string `json:"email_address"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextEmailAddress{inner, v.V}, nil
|
||||
case "phone_number":
|
||||
var v struct {
|
||||
V string `json:"phone_number"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextPhoneNumber{inner, v.V}, nil
|
||||
case "bank_card_number":
|
||||
var v struct {
|
||||
V string `json:"bank_card_number"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextBankCardNumber{inner, v.V}, nil
|
||||
case "mention":
|
||||
var v struct {
|
||||
V string `json:"username"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextMention{inner, v.V}, nil
|
||||
case "hashtag":
|
||||
var v struct {
|
||||
V string `json:"hashtag"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextHashtag{inner, v.V}, nil
|
||||
case "cashtag":
|
||||
var v struct {
|
||||
V string `json:"cashtag"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextCashtag{inner, v.V}, nil
|
||||
case "bot_command":
|
||||
var v struct {
|
||||
V string `json:"bot_command"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextBotCommand{inner, v.V}, nil
|
||||
case "anchor_link":
|
||||
var v struct {
|
||||
V string `json:"anchor_name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextAnchorLink{inner, v.V}, nil
|
||||
case "reference":
|
||||
var v struct {
|
||||
V string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextReference{inner, v.V}, nil
|
||||
case "reference_link":
|
||||
var v struct {
|
||||
V string `json:"reference_name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextReferenceLink{inner, v.V}, nil
|
||||
case "date_time":
|
||||
var v struct {
|
||||
UnixTime int64 `json:"unix_time"`
|
||||
DateTimeFormat string `json:"date_time_format"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextDateTime{inner, v.UnixTime, v.DateTimeFormat}, nil
|
||||
case "text_mention":
|
||||
var v struct {
|
||||
User User `json:"user"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextTextMention{inner, v.User}, nil
|
||||
|
||||
// --- leaves without text ---
|
||||
case "custom_emoji":
|
||||
var v struct {
|
||||
ID string `json:"custom_emoji_id"`
|
||||
Alt string `json:"alternative_text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextCustomEmoji{v.ID, v.Alt}, nil
|
||||
case "mathematical_expression":
|
||||
var v struct {
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextMathematicalExpression{v.Expression}, nil
|
||||
case "anchor":
|
||||
var v struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextAnchor{v.Name}, nil
|
||||
case "button":
|
||||
var raw struct {
|
||||
Button RichMessageButton `json:"button"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextButton{Button: raw.Button}, nil
|
||||
|
||||
default:
|
||||
return nil, fmt.Errorf("richtext: unsupported type %q", head.Type)
|
||||
}
|
||||
}
|
||||
|
||||
// UnmarshalRichBlock parses a single RichBlock from JSON, dispatching on the
|
||||
// type tag. Unknown object types are preserved as RichBlockUnknown without
|
||||
// discarding fields.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
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 {
|
||||
Type string `json:"type"`
|
||||
Text json.RawMessage `json:"text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &head); err != nil {
|
||||
return nil, fmt.Errorf("richblock: %w", err)
|
||||
}
|
||||
if head.Type == "" {
|
||||
return nil, errors.New("richblock: object type is required")
|
||||
}
|
||||
|
||||
if richBlockWrapTags[head.Type] {
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockWrap{Tag: head.Type, Text: text}, nil
|
||||
}
|
||||
|
||||
switch head.Type {
|
||||
case "heading":
|
||||
var v struct {
|
||||
Size int `json:"size"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockSectionHeading{text, v.Size}, nil
|
||||
|
||||
case "pre":
|
||||
var v struct {
|
||||
Language string `json:"language"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockPreformatted{text, v.Language}, nil
|
||||
|
||||
case "blockquote":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: credit: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockQuotation{blocks, credit}, nil
|
||||
|
||||
case "expandable_blockquote", "pullquote":
|
||||
var raw struct {
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: credit: %w", head.Type, err)
|
||||
}
|
||||
if head.Type == "expandable_blockquote" {
|
||||
return RichBlockExpandableBlockQuotation{text, credit}, nil
|
||||
}
|
||||
return RichBlockPullQuotation{text, credit}, nil
|
||||
|
||||
case "list":
|
||||
var v struct {
|
||||
Items []RichBlockListItem `json:"items"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockList{v.Items}, nil
|
||||
|
||||
case "collage":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockCollage{blocks, raw.Caption}, nil
|
||||
|
||||
case "slideshow":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockSlideshow{blocks, raw.Caption}, nil
|
||||
|
||||
case "details":
|
||||
var raw struct {
|
||||
Summary json.RawMessage `json:"summary"`
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
IsOpen bool `json:"is_open"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
summary, err := parseOptRichText(raw.Summary)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: summary: %w", head.Type, err)
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockDetails{summary, blocks, raw.IsOpen}, nil
|
||||
|
||||
case "table":
|
||||
var raw struct {
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
IsBordered bool `json:"is_bordered"`
|
||||
IsStriped bool `json:"is_striped"`
|
||||
IsCompact bool `json:"is_compact"`
|
||||
Caption json.RawMessage `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
caption, err := parseOptRichText(raw.Caption)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: caption: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockTable{raw.Cells, raw.IsBordered, raw.IsStriped, raw.IsCompact, caption}, nil
|
||||
|
||||
case "map":
|
||||
var v struct {
|
||||
Location Location `json:"location"`
|
||||
Zoom int `json:"zoom"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockMap{v.Location, v.Zoom, v.Width, v.Height, v.Caption}, nil
|
||||
|
||||
case "buttons":
|
||||
var block RichBlockButtons
|
||||
if err := json.Unmarshal(data, &block); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return block, nil
|
||||
case "document":
|
||||
var block RichBlockDocument
|
||||
if err := json.Unmarshal(data, &block); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return block, nil
|
||||
case "photo":
|
||||
var v struct {
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockPhoto{v.Photo, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "video":
|
||||
var v struct {
|
||||
Video Video `json:"video"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockVideo{v.Video, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "audio":
|
||||
var v struct {
|
||||
Audio Audio `json:"audio"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAudio{v.Audio, v.Caption}, nil
|
||||
|
||||
case "animation":
|
||||
var v struct {
|
||||
Animation Animation `json:"animation"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAnimation{v.Animation, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "voice_note":
|
||||
var v struct {
|
||||
VoiceNote Voice `json:"voice_note"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockVoiceNote{v.VoiceNote, v.Caption}, nil
|
||||
|
||||
case "divider":
|
||||
return RichBlockDivider{}, nil
|
||||
|
||||
case "mathematical_expression":
|
||||
var v struct {
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockMathematicalExpression{v.Expression}, nil
|
||||
|
||||
case "anchor":
|
||||
var v struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAnchor{v.Name}, nil
|
||||
|
||||
default:
|
||||
return RichBlockUnknown{Raw: cloneRawJSON(data)}, nil
|
||||
}
|
||||
}
|
||||
|
||||
// UnmarshalRichMessage parses a RichMessage and requires a non-null blocks array.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func UnmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||
return unmarshalRichMessageStrict(data)
|
||||
}
|
||||
|
||||
func unmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
IsRTL bool `json:"is_rtl"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return RichMessage{}, fmt.Errorf("richmessage: %w", err)
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return RichMessage{}, err
|
||||
}
|
||||
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) {
|
||||
return unmarshalRichMessageStrict(data)
|
||||
}
|
||||
|
||||
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.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (m *RichMessage) UnmarshalJSON(data []byte) error {
|
||||
parsed, err := UnmarshalRichMessage(data)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*m = parsed
|
||||
return nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Internal helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// Optional RichText fields treat absent and null values as nil.
|
||||
func parseOptRichText(raw json.RawMessage) (RichText, error) {
|
||||
if len(raw) == 0 || string(raw) == "null" {
|
||||
return nil, nil
|
||||
}
|
||||
return unmarshalRichText(raw)
|
||||
}
|
||||
|
||||
func cloneRawJSON(raw []byte) json.RawMessage {
|
||||
return append(json.RawMessage(nil), raw...)
|
||||
}
|
||||
|
||||
func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
||||
if len(raw) == 0 || string(raw) == "null" {
|
||||
return nil, nil
|
||||
}
|
||||
var raws []json.RawMessage
|
||||
if err := json.Unmarshal(raw, &raws); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks := make([]RichBlock, len(raws))
|
||||
for i, r := range raws {
|
||||
b, err := unmarshalRichBlock(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks[i] = b
|
||||
}
|
||||
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--
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,372 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func roundtripRichBlock(t *testing.T, in RichBlock) {
|
||||
t.Helper()
|
||||
b, err := json.Marshal(in)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
out, err := UnmarshalRichBlock(b)
|
||||
if err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", b, err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
|
||||
func par(s string) RichBlockWrap { return RichBlockWrap{"paragraph", RichTextPlain(s)} }
|
||||
|
||||
func TestRichBlockRoundtrip(t *testing.T) {
|
||||
cases := []RichBlock{
|
||||
// wrap blocks
|
||||
par("Hello, world"),
|
||||
RichBlockWrap{"footer", RichTextPlain("© 2024")},
|
||||
RichBlockWrap{"thinking", RichTextPlain("Let me reason step by step.")},
|
||||
|
||||
// heading
|
||||
RichBlockSectionHeading{RichTextWrap{"bold", RichTextPlain("Chapter 1")}, 1},
|
||||
RichBlockSectionHeading{RichTextPlain("smallest"), 6},
|
||||
|
||||
// preformatted
|
||||
RichBlockPreformatted{RichTextPlain(`fmt.Println("hi")`), "go"},
|
||||
RichBlockPreformatted{Text: RichTextPlain("no language")},
|
||||
|
||||
// quotations
|
||||
RichBlockQuotation{[]RichBlock{par("To be or not to be")}, RichTextPlain("Shakespeare")},
|
||||
RichBlockQuotation{Blocks: []RichBlock{par("anonymous"), par("second block")}},
|
||||
RichBlockPullQuotation{Text: RichTextPlain("Pull me")},
|
||||
RichBlockPullQuotation{RichTextPlain("Wisdom"), RichTextWrap{"italic", RichTextPlain("someone")}},
|
||||
|
||||
// list: label is the ready-made marker, numbering lives on the items
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "c.", Blocks: []RichBlock{par("item 3")}, Value: 3, Type: "a"},
|
||||
{Label: "vii.", Blocks: []RichBlock{par("item 7")}, Value: 7, Type: "i"},
|
||||
},
|
||||
},
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "•", Blocks: []RichBlock{par("todo")}, HasCheckbox: true},
|
||||
{Label: "•", Blocks: []RichBlock{par("done")}, HasCheckbox: true, IsChecked: true},
|
||||
},
|
||||
},
|
||||
|
||||
// collage and slideshow
|
||||
RichBlockCollage{
|
||||
Blocks: []RichBlock{RichBlockPhoto{Photo: []PhotoSize{{FileID: "abc123", Width: 100, Height: 100}}}},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("A photo")},
|
||||
},
|
||||
RichBlockSlideshow{
|
||||
Blocks: []RichBlock{
|
||||
RichBlockVideo{Video: Video{FileID: "vid1", Width: 640, Height: 480, Duration: 10}},
|
||||
},
|
||||
},
|
||||
|
||||
// details
|
||||
RichBlockDetails{
|
||||
Summary: RichTextPlain("Spoiler"),
|
||||
Blocks: []RichBlock{par("Hidden content")},
|
||||
},
|
||||
RichBlockDetails{
|
||||
Summary: RichTextWrap{"bold", RichTextPlain("Open details")},
|
||||
Blocks: []RichBlock{RichBlockDivider{}, par("content")},
|
||||
IsOpen: true,
|
||||
},
|
||||
|
||||
// table: text cells, headers, spans, alignment, invisible cell
|
||||
RichBlockTable{
|
||||
Cells: [][]RichBlockTableCell{
|
||||
{
|
||||
{Text: RichTextPlain("Name"), IsHeader: true, Align: "center"},
|
||||
{Text: RichTextPlain("Score"), IsHeader: true, VAlign: "middle"},
|
||||
},
|
||||
{
|
||||
{Text: RichTextPlain("Alice"), ColSpan: 2},
|
||||
},
|
||||
{
|
||||
{}, // invisible cell
|
||||
{Text: RichTextPlain("42"), RowSpan: 2},
|
||||
},
|
||||
},
|
||||
IsBordered: true,
|
||||
Caption: RichTextPlain("Results"),
|
||||
},
|
||||
|
||||
// map
|
||||
RichBlockMap{
|
||||
Location: Location{Latitude: 55.7558, Longitude: 37.6173},
|
||||
Zoom: 13, Width: 800, Height: 400,
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Moscow"), Credit: RichTextPlain("OpenStreetMap")},
|
||||
},
|
||||
|
||||
// media
|
||||
RichBlockPhoto{
|
||||
Photo: []PhotoSize{{FileID: "p1", Width: 1280, Height: 720}},
|
||||
HasSpoiler: true,
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("A cat"), Credit: RichTextWrap{"italic", RichTextPlain("photographer")}},
|
||||
},
|
||||
RichBlockVideo{Video: Video{FileID: "v1", Width: 1920, Height: 1080, Duration: 30}, HasSpoiler: true},
|
||||
RichBlockAudio{
|
||||
Audio: Audio{FileID: "a1", Duration: 60},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Podcast ep. 1")},
|
||||
},
|
||||
RichBlockAnimation{Animation: Animation{FileID: "g1", Width: 320, Height: 240, Duration: 2}},
|
||||
RichBlockVoiceNote{VoiceNote: Voice{FileID: "vn1", Duration: 5}},
|
||||
|
||||
// leaves
|
||||
RichBlockDivider{},
|
||||
RichBlockMathematicalExpression{Expression: "E = mc^2"},
|
||||
RichBlockAnchor{Name: "section-2"},
|
||||
}
|
||||
for _, c := range cases {
|
||||
roundtripRichBlock(t, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichMessageRoundtrip(t *testing.T) {
|
||||
for _, msg := range []RichMessage{
|
||||
{
|
||||
Blocks: []RichBlock{
|
||||
RichBlockSectionHeading{RichTextPlain("Title"), 1},
|
||||
RichBlockWrap{"paragraph", RichTextArray{RichTextPlain("Some "), RichTextWrap{"bold", RichTextPlain("bold")}, RichTextPlain(" text")}},
|
||||
RichBlockDivider{},
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "1.", Blocks: []RichBlock{par("First")}, Value: 1, Type: "1"},
|
||||
{Label: "2.", Blocks: []RichBlock{par("Second")}, Value: 2, Type: "1"},
|
||||
},
|
||||
},
|
||||
RichBlockPhoto{
|
||||
Photo: []PhotoSize{{FileID: "img1", Width: 10, Height: 10}},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Fig. 1")},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Blocks: []RichBlock{par("שלום")},
|
||||
IsRTL: true,
|
||||
},
|
||||
} {
|
||||
b, err := json.Marshal(msg)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
var out RichMessage
|
||||
if err := json.Unmarshal(b, &out); err != nil {
|
||||
t.Fatalf("unmarshal: %v", err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockTags(t *testing.T) {
|
||||
// tags per spec: heading, pre, blockquote, pullquote
|
||||
cases := map[string]RichBlock{
|
||||
"heading": RichBlockSectionHeading{RichTextPlain("h"), 2},
|
||||
"pre": RichBlockPreformatted{Text: RichTextPlain("x")},
|
||||
"blockquote": RichBlockQuotation{Blocks: []RichBlock{par("q")}},
|
||||
"pullquote": RichBlockPullQuotation{Text: RichTextPlain("p")},
|
||||
}
|
||||
for want, block := range cases {
|
||||
b, _ := json.Marshal(block)
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if m["type"] != want {
|
||||
t.Fatalf("expected type %q, got %s", want, b)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockOptionalFieldsOmitted(t *testing.T) {
|
||||
// nil credit/caption and false flags must not appear in the JSON
|
||||
for _, c := range []struct {
|
||||
block RichBlock
|
||||
bad []string
|
||||
}{
|
||||
{RichBlockQuotation{Blocks: []RichBlock{par("q")}}, []string{"credit"}},
|
||||
{RichBlockPullQuotation{Text: RichTextPlain("p")}, []string{"credit"}},
|
||||
{RichBlockPhoto{Photo: []PhotoSize{{FileID: "p"}}}, []string{"caption", "has_spoiler"}},
|
||||
{RichBlockTable{Cells: [][]RichBlockTableCell{}}, []string{"caption", "is_bordered", "is_striped"}},
|
||||
{RichBlockDetails{Summary: RichTextPlain("s")}, []string{"is_open"}},
|
||||
} {
|
||||
b, _ := json.Marshal(c.block)
|
||||
for _, key := range c.bad {
|
||||
if strings.Contains(string(b), `"`+key+`"`) {
|
||||
t.Fatalf("%T: %q must be omitted: %s", c.block, key, b)
|
||||
}
|
||||
}
|
||||
}
|
||||
// same for RichMessage.is_rtl
|
||||
b, _ := json.Marshal(RichMessage{Blocks: []RichBlock{par("x")}})
|
||||
if strings.Contains(string(b), "is_rtl") {
|
||||
t.Fatalf("is_rtl must be omitted: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockDividerHasNoContent(t *testing.T) {
|
||||
b, _ := json.Marshal(RichBlockDivider{})
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if len(m) != 1 {
|
||||
t.Fatalf("divider must only have type field: %s", b)
|
||||
}
|
||||
if m["type"] != "divider" {
|
||||
t.Fatalf("unexpected type: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnknownRichObjectsRoundTripLosslessly(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
raw string
|
||||
parse func([]byte) (any, error)
|
||||
}{
|
||||
{
|
||||
name: "text",
|
||||
raw: `{"type":"future_text","text":"hello","metadata":{"flag":true},"items":[1,2]}`,
|
||||
parse: func(data []byte) (any, error) {
|
||||
return UnmarshalRichText(data)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "block",
|
||||
raw: `{"type":"future_block","value":42,"metadata":{"flag":true},"items":[1,2]}`,
|
||||
parse: func(data []byte) (any, error) {
|
||||
return UnmarshalRichBlock(data)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
input := []byte(tt.raw)
|
||||
value, err := tt.parse(input)
|
||||
if err != nil {
|
||||
t.Fatalf("parse failed: %v", err)
|
||||
}
|
||||
for i := range input {
|
||||
input[i] = ' '
|
||||
}
|
||||
encoded, err := json.Marshal(value)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal failed: %v", err)
|
||||
}
|
||||
var got, want any
|
||||
if err := json.Unmarshal(encoded, &got); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := json.Unmarshal([]byte(tt.raw), &want); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Fatalf("unknown object changed: got %s want %s", encoded, tt.raw)
|
||||
}
|
||||
switch v := value.(type) {
|
||||
case RichTextUnknown:
|
||||
if len(v.Raw) == 0 {
|
||||
t.Fatal("empty preserved rich text")
|
||||
}
|
||||
case RichBlockUnknown:
|
||||
if len(v.Raw) == 0 {
|
||||
t.Fatal("empty preserved rich block")
|
||||
}
|
||||
default:
|
||||
t.Fatalf("unexpected fallback type %T", value)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnknownRichObjectsRoundTripInsideMessage(t *testing.T) {
|
||||
raw := []byte(`{"blocks":[{"type":"future_block","metadata":{"version":2}},{"type":"paragraph","text":{"type":"future_text","payload":[1,2,3]}}],"is_rtl":true}`)
|
||||
message, err := UnmarshalRichMessage(raw)
|
||||
if err != nil {
|
||||
t.Fatalf("UnmarshalRichMessage failed: %v", err)
|
||||
}
|
||||
if _, ok := message.Blocks[0].(RichBlockUnknown); !ok {
|
||||
t.Fatalf("first block type = %T, want RichBlockUnknown", message.Blocks[0])
|
||||
}
|
||||
paragraph, ok := message.Blocks[1].(RichBlockWrap)
|
||||
if !ok {
|
||||
t.Fatalf("second block type = %T, want RichBlockWrap", message.Blocks[1])
|
||||
}
|
||||
if _, ok := paragraph.Text.(RichTextUnknown); !ok {
|
||||
t.Fatalf("paragraph text type = %T, want RichTextUnknown", paragraph.Text)
|
||||
}
|
||||
|
||||
encoded, err := json.Marshal(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal failed: %v", err)
|
||||
}
|
||||
var got, want any
|
||||
if err := json.Unmarshal(encoded, &got); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := json.Unmarshal(raw, &want); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Fatalf("message changed: got %s want %s", encoded, raw)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichBlockRejectsMalformedFields(t *testing.T) {
|
||||
tests := []string{
|
||||
`{"type":"heading","size":"large","text":"hello"}`,
|
||||
`{"type":"blockquote","blocks":[],"credit":{"type":"date_time","text":"now","unix_time":"soon"}}`,
|
||||
`{"type":"table","cells":[],"caption":{"type":"date_time","text":"now","unix_time":"soon"}}`,
|
||||
}
|
||||
for _, raw := range tests {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
if _, err := UnmarshalRichBlock([]byte(raw)); err == nil {
|
||||
t.Fatal("expected malformed rich block to be rejected")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichMessageStrict(t *testing.T) {
|
||||
for _, raw := range []string{`null`, `{}`, `{"blocks":null}`, `{"blocks":{}}`} {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
for _, parse := range []func([]byte) (RichMessage, error){UnmarshalRichMessage, UnmarshalRichMessageStrict} {
|
||||
if _, err := parse([]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)
|
||||
}
|
||||
}
|
||||
+22
-12
@@ -6,8 +6,11 @@ import "context"
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#getstartransactions
|
||||
type GetStarTransactions struct {
|
||||
// Offset Optional. Number of transactions to skip in the response
|
||||
Offset int `json:"offset,omitempty"`
|
||||
Limit int `json:"limit,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"`
|
||||
}
|
||||
|
||||
// GetMyStarBalance returns the bot's Telegram Star balance.
|
||||
@@ -15,7 +18,7 @@ type GetStarTransactions struct {
|
||||
// See https://core.telegram.org/bots/api#getmystarbalance
|
||||
func (api *API) GetMyStarBalance() (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getMyStarBalance", NoParams)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetMyStarBalanceWithContext is the context-aware variant of GetMyStarBalance.
|
||||
@@ -24,7 +27,7 @@ func (api *API) GetMyStarBalance() (StarAmount, error) {
|
||||
// See https://core.telegram.org/bots/api#getmystarbalance
|
||||
func (api *API) GetMyStarBalanceWithContext(ctx context.Context) (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getMyStarBalance", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetStarTransactions returns Telegram Star transactions for the bot.
|
||||
@@ -32,7 +35,7 @@ func (api *API) GetMyStarBalanceWithContext(ctx context.Context) (StarAmount, er
|
||||
// See https://core.telegram.org/bots/api#getstartransactions
|
||||
func (api *API) GetStarTransactions(params GetStarTransactions) (StarTransactions, error) {
|
||||
req := NewRequest[StarTransactions]("getStarTransactions", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetStarTransactionsWithContext is the context-aware variant of GetStarTransactions.
|
||||
@@ -41,14 +44,16 @@ func (api *API) GetStarTransactions(params GetStarTransactions) (StarTransaction
|
||||
// See https://core.telegram.org/bots/api#getstartransactions
|
||||
func (api *API) GetStarTransactionsWithContext(ctx context.Context, params GetStarTransactions) (StarTransactions, error) {
|
||||
req := NewRequest[StarTransactions]("getStarTransactions", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// RefundStarPayment holds parameters for the refundStarPayment method.
|
||||
// Since: Bot API 7.4
|
||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||
type RefundStarPayment struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Identifier of the user whose payment will be refunded
|
||||
UserID int64 `json:"user_id"`
|
||||
// TelegramPaymentChargeID Required. Telegram payment identifier
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
}
|
||||
|
||||
@@ -58,7 +63,7 @@ type RefundStarPayment struct {
|
||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||
func (api *API) RefundStarPayment(params RefundStarPayment) (bool, error) {
|
||||
req := NewRequest[bool]("refundStarPayment", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// RefundStarPaymentWithContext is the context-aware variant of RefundStarPayment.
|
||||
@@ -67,16 +72,21 @@ func (api *API) RefundStarPayment(params RefundStarPayment) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||
func (api *API) RefundStarPaymentWithContext(ctx context.Context, params RefundStarPayment) (bool, error) {
|
||||
req := NewRequest[bool]("refundStarPayment", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// EditUserStarSubscription holds parameters for the editUserStarSubscription method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||
type EditUserStarSubscription struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Identifier of the user whose subscription will be edited
|
||||
UserID int64 `json:"user_id"`
|
||||
// TelegramPaymentChargeID Required. Telegram payment identifier for the subscription
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
IsCanceled bool `json:"is_canceled"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// EditUserStarSubscription cancels or re-enables a user star subscription extension.
|
||||
@@ -85,7 +95,7 @@ type EditUserStarSubscription struct {
|
||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||
func (api *API) EditUserStarSubscription(params EditUserStarSubscription) (bool, error) {
|
||||
req := NewRequest[bool]("editUserStarSubscription", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// EditUserStarSubscriptionWithContext is the context-aware variant of EditUserStarSubscription.
|
||||
@@ -94,5 +104,5 @@ func (api *API) EditUserStarSubscription(params EditUserStarSubscription) (bool,
|
||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||
func (api *API) EditUserStarSubscriptionWithContext(ctx context.Context, params EditUserStarSubscription) (bool, error) {
|
||||
req := NewRequest[bool]("editUserStarSubscription", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+18
-6
@@ -4,17 +4,29 @@ package tgapi
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#startransaction
|
||||
type StarTransaction struct {
|
||||
ID string `json:"id"`
|
||||
Amount int `json:"amount"`
|
||||
NanostarAmount int `json:"nanostar_amount,omitempty"`
|
||||
Date int `json:"date"`
|
||||
Source map[string]any `json:"source,omitempty"`
|
||||
Receiver map[string]any `json:"receiver,omitempty"`
|
||||
// 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"`
|
||||
// Amount Integer amount of Telegram Stars transferred by the transaction
|
||||
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"`
|
||||
// Date Date the transaction was created in Unix time
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// StarTransactions contains a list of Telegram Star transactions.
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#startransactions
|
||||
type StarTransactions struct {
|
||||
// Transactions The list of transactions
|
||||
Transactions []StarTransaction `json:"transactions"`
|
||||
}
|
||||
|
||||
+152
-68
@@ -6,21 +6,50 @@ import "context"
|
||||
// Since: Bot API 1.3
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
type SendSticker struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
Sticker string `json:"sticker"`
|
||||
Emoji string `json:"emoji,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// 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"`
|
||||
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendSticker sends a static .WEBP, animated .TGS, or video .WEBM sticker.
|
||||
@@ -28,7 +57,7 @@ type SendSticker struct {
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
func (api *API) SendSticker(params SendSticker) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SendStickerWithContext is the context-aware variant of SendSticker.
|
||||
@@ -37,13 +66,14 @@ func (api *API) SendSticker(params SendSticker) (Message, error) {
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
func (api *API) SendStickerWithContext(ctx context.Context, params SendSticker) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetStickerSet holds parameters for the getStickerSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
type GetStickerSet struct {
|
||||
// Name Required. Name of the sticker set
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
@@ -52,7 +82,7 @@ type GetStickerSet struct {
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
func (api *API) GetStickerSet(params GetStickerSet) (StickerSet, error) {
|
||||
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetStickerSetWithContext is the context-aware variant of GetStickerSet.
|
||||
@@ -61,13 +91,15 @@ func (api *API) GetStickerSet(params GetStickerSet) (StickerSet, error) {
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
func (api *API) GetStickerSetWithContext(ctx context.Context, params GetStickerSet) (StickerSet, error) {
|
||||
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickers holds parameters for the getCustomEmojiStickers method.
|
||||
// Since: Bot API 6.2
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -76,7 +108,7 @@ type GetCustomEmojiStickers struct {
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickers) ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickersWithContext is the context-aware variant of GetCustomEmojiStickers.
|
||||
@@ -85,14 +117,16 @@ func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickers) ([]Sticker
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
func (api *API) GetCustomEmojiStickersWithContext(ctx context.Context, params GetCustomEmojiStickers) ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadStickerFile holds parameters for the uploadStickerFile method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||
type UploadStickerFile struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. User identifier of sticker file owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// StickerFormat Required. Format of the sticker, must be one of “static”, “animated”, “video”
|
||||
StickerFormat InputStickerFormat `json:"sticker_format"`
|
||||
}
|
||||
|
||||
@@ -106,7 +140,7 @@ func (api *API) UploadStickerFile(params UploadStickerFile, sticker UploaderFile
|
||||
_ = uploader.Close()
|
||||
}()
|
||||
req := NewUploaderRequest[File]("uploadStickerFile", params, sticker.SetType(UploaderStickerType))
|
||||
return req.Do(uploader)
|
||||
return uploader.Do(req)
|
||||
}
|
||||
|
||||
// UploadStickerFileWithContext is the context-aware variant of UploadStickerFile.
|
||||
@@ -119,20 +153,31 @@ func (api *API) UploadStickerFileWithContext(ctx context.Context, params UploadS
|
||||
_ = uploader.Close()
|
||||
}()
|
||||
req := NewUploaderRequest[File]("uploadStickerFile", params, sticker.SetType(UploaderStickerType))
|
||||
return req.DoWithContext(ctx, uploader)
|
||||
return uploader.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// CreateNewStickerSet holds parameters for the createNewStickerSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
type CreateNewStickerSet struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
// UserID Required. User identifier of created sticker set owner
|
||||
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"`
|
||||
// Title Required. Sticker set title, 1-64 characters
|
||||
Title string `json:"title"`
|
||||
|
||||
Stickers []InputSticker `json:"stickers"`
|
||||
StickerType StickerType `json:"sticker_type,omitempty"`
|
||||
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||
// Stickers Required. A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// CreateNewStickerSet creates a new sticker set owned by a user.
|
||||
@@ -141,7 +186,7 @@ type CreateNewStickerSet struct {
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
func (api *API) CreateNewStickerSet(params CreateNewStickerSet) (bool, error) {
|
||||
req := NewRequest[bool]("createNewStickerSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// CreateNewStickerSetWithContext is the context-aware variant of CreateNewStickerSet.
|
||||
@@ -150,15 +195,19 @@ func (api *API) CreateNewStickerSet(params CreateNewStickerSet) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
func (api *API) CreateNewStickerSetWithContext(ctx context.Context, params CreateNewStickerSet) (bool, error) {
|
||||
req := NewRequest[bool]("createNewStickerSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// AddStickerToSet holds parameters for the addStickerToSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
type AddStickerToSet struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
// UserID Required. User identifier of sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Name Required. Sticker set 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"`
|
||||
}
|
||||
|
||||
@@ -168,7 +217,7 @@ type AddStickerToSet struct {
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
func (api *API) AddStickerToSet(params AddStickerToSet) (bool, error) {
|
||||
req := NewRequest[bool]("addStickerToSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// AddStickerToSetWithContext is the context-aware variant of AddStickerToSet.
|
||||
@@ -177,15 +226,17 @@ func (api *API) AddStickerToSet(params AddStickerToSet) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
func (api *API) AddStickerToSetWithContext(ctx context.Context, params AddStickerToSet) (bool, error) {
|
||||
req := NewRequest[bool]("addStickerToSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerPositionInSet holds parameters for the setStickerPositionInSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
type SetStickerPositionInSet struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Position int `json:"position"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// Position Required. New sticker position in the set, zero-based
|
||||
Position int `json:"position"`
|
||||
}
|
||||
|
||||
// SetStickerPositionInSet moves a sticker in a set to a specific position.
|
||||
@@ -194,7 +245,7 @@ type SetStickerPositionInSet struct {
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
func (api *API) SetStickerPositionInSet(params SetStickerPositionInSet) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerPositionInSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerPositionInSetWithContext is the context-aware variant of SetStickerPositionInSet.
|
||||
@@ -203,13 +254,14 @@ func (api *API) SetStickerPositionInSet(params SetStickerPositionInSet) (bool, e
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
func (api *API) SetStickerPositionInSetWithContext(ctx context.Context, params SetStickerPositionInSet) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerPositionInSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteStickerFromSet holds parameters for the deleteStickerFromSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
type DeleteStickerFromSet struct {
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
}
|
||||
|
||||
@@ -219,7 +271,7 @@ type DeleteStickerFromSet struct {
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
func (api *API) DeleteStickerFromSet(params DeleteStickerFromSet) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerFromSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteStickerFromSetWithContext is the context-aware variant of DeleteStickerFromSet.
|
||||
@@ -228,17 +280,22 @@ func (api *API) DeleteStickerFromSet(params DeleteStickerFromSet) (bool, error)
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
func (api *API) DeleteStickerFromSetWithContext(ctx context.Context, params DeleteStickerFromSet) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerFromSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// ReplaceStickerInSet holds parameters for the replaceStickerInSet method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
type ReplaceStickerInSet struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
OldSticker string `json:"old_sticker"`
|
||||
Sticker InputSticker `json:"sticker"`
|
||||
// UserID Required. User identifier of the sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// OldSticker Required. File identifier of the replaced 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"`
|
||||
}
|
||||
|
||||
// ReplaceStickerInSet replaces an existing sticker in a set with a new one.
|
||||
@@ -247,7 +304,7 @@ type ReplaceStickerInSet struct {
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
func (api *API) ReplaceStickerInSet(params ReplaceStickerInSet) (bool, error) {
|
||||
req := NewRequest[bool]("replaceStickerInSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// ReplaceStickerInSetWithContext is the context-aware variant of ReplaceStickerInSet.
|
||||
@@ -256,14 +313,16 @@ func (api *API) ReplaceStickerInSet(params ReplaceStickerInSet) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
func (api *API) ReplaceStickerInSetWithContext(ctx context.Context, params ReplaceStickerInSet) (bool, error) {
|
||||
req := NewRequest[bool]("replaceStickerInSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerEmojiList holds parameters for the setStickerEmojiList method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
type SetStickerEmojiList struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// EmojiList Required. A JSON-serialized list of 1-20 emoji associated with the sticker
|
||||
EmojiList []string `json:"emoji_list"`
|
||||
}
|
||||
|
||||
@@ -273,7 +332,7 @@ type SetStickerEmojiList struct {
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
func (api *API) SetStickerEmojiList(params SetStickerEmojiList) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerEmojiList", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerEmojiListWithContext is the context-aware variant of SetStickerEmojiList.
|
||||
@@ -282,14 +341,17 @@ func (api *API) SetStickerEmojiList(params SetStickerEmojiList) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
func (api *API) SetStickerEmojiListWithContext(ctx context.Context, params SetStickerEmojiList) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerEmojiList", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerKeywords holds parameters for the setStickerKeywords method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
type SetStickerKeywords struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the 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"`
|
||||
}
|
||||
|
||||
@@ -299,7 +361,7 @@ type SetStickerKeywords struct {
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
func (api *API) SetStickerKeywords(params SetStickerKeywords) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerKeywords", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerKeywordsWithContext is the context-aware variant of SetStickerKeywords.
|
||||
@@ -308,14 +370,17 @@ func (api *API) SetStickerKeywords(params SetStickerKeywords) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
func (api *API) SetStickerKeywordsWithContext(ctx context.Context, params SetStickerKeywords) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerKeywords", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerMaskPosition holds parameters for the setStickerMaskPosition method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
type SetStickerMaskPosition struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the 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"`
|
||||
}
|
||||
|
||||
@@ -325,7 +390,7 @@ type SetStickerMaskPosition struct {
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
func (api *API) SetStickerMaskPosition(params SetStickerMaskPosition) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerMaskPosition", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerMaskPositionWithContext is the context-aware variant of SetStickerMaskPosition.
|
||||
@@ -334,14 +399,16 @@ func (api *API) SetStickerMaskPosition(params SetStickerMaskPosition) (bool, err
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
func (api *API) SetStickerMaskPositionWithContext(ctx context.Context, params SetStickerMaskPosition) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerMaskPosition", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerSetTitle holds parameters for the setStickerSetTitle method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
type SetStickerSetTitle struct {
|
||||
Name string `json:"name"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// Title Required. Sticker set title, 1-64 characters
|
||||
Title string `json:"title"`
|
||||
}
|
||||
|
||||
@@ -351,7 +418,7 @@ type SetStickerSetTitle struct {
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
func (api *API) SetStickerSetTitle(params SetStickerSetTitle) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetTitle", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerSetTitleWithContext is the context-aware variant of SetStickerSetTitle.
|
||||
@@ -360,17 +427,30 @@ func (api *API) SetStickerSetTitle(params SetStickerSetTitle) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
func (api *API) SetStickerSetTitleWithContext(ctx context.Context, params SetStickerSetTitle) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetTitle", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnail holds parameters for the setStickerSetThumbnail method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
type SetStickerSetThumbnail struct {
|
||||
Name string `json:"name"`
|
||||
UserID int64 `json:"user_id"`
|
||||
Thumbnail string `json:"thumbnail"`
|
||||
Format InputStickerFormat `json:"format"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// UserID Required. User identifier of the sticker set owner
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnail sets the thumbnail of a sticker set.
|
||||
@@ -379,7 +459,7 @@ type SetStickerSetThumbnail struct {
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnail) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetThumbnail", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnailWithContext is the context-aware variant of SetStickerSetThumbnail.
|
||||
@@ -388,14 +468,17 @@ func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnail) (bool, err
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
func (api *API) SetStickerSetThumbnailWithContext(ctx context.Context, params SetStickerSetThumbnail) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetThumbnail", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnail holds parameters for the setCustomEmojiStickerSetThumbnail method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
type SetCustomEmojiStickerSetThumbnail struct {
|
||||
Name string `json:"name"`
|
||||
// Name Required. Sticker set 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"`
|
||||
}
|
||||
|
||||
@@ -405,7 +488,7 @@ type SetCustomEmojiStickerSetThumbnail struct {
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
func (api *API) SetCustomEmojiStickerSetThumbnail(params SetCustomEmojiStickerSetThumbnail) (bool, error) {
|
||||
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnailWithContext is the context-aware variant of SetCustomEmojiStickerSetThumbnail.
|
||||
@@ -414,13 +497,14 @@ func (api *API) SetCustomEmojiStickerSetThumbnail(params SetCustomEmojiStickerSe
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
func (api *API) SetCustomEmojiStickerSetThumbnailWithContext(ctx context.Context, params SetCustomEmojiStickerSetThumbnail) (bool, error) {
|
||||
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// DeleteStickerSet holds parameters for the deleteStickerSet method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
type DeleteStickerSet struct {
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
@@ -430,7 +514,7 @@ type DeleteStickerSet struct {
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
func (api *API) DeleteStickerSet(params DeleteStickerSet) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerSet", params)
|
||||
return req.Do(api)
|
||||
return api.Do(req)
|
||||
}
|
||||
|
||||
// DeleteStickerSetWithContext is the context-aware variant of DeleteStickerSet.
|
||||
@@ -439,5 +523,5 @@ func (api *API) DeleteStickerSet(params DeleteStickerSet) (bool, error) {
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
func (api *API) DeleteStickerSetWithContext(ctx context.Context, params DeleteStickerSet) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerSet", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
return api.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
+64
-26
@@ -18,10 +18,17 @@ const (
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#maskposition
|
||||
type MaskPosition struct {
|
||||
Point MaskPositionPoint `json:"point"`
|
||||
XShift float32 `json:"x_shift"`
|
||||
YShift float32 `json:"y_shift"`
|
||||
Scale float32 `json:"scale"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// Scale Mask scaling coefficient. For example, 2.0 means double size.
|
||||
Scale float32 `json:"scale"`
|
||||
}
|
||||
|
||||
// StickerType represents the type of a sticker.
|
||||
@@ -40,32 +47,53 @@ const (
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sticker
|
||||
type Sticker struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
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"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
// Width Sticker width
|
||||
Width int `json:"width"`
|
||||
// Height Sticker height
|
||||
Height int `json:"height"`
|
||||
|
||||
Type StickerType `json:"type"` // Since: Bot API 6.2
|
||||
IsAnimated bool `json:"is_animated"` // Since: Bot API 4.4
|
||||
IsVideo bool `json:"is_video"` // Since: Bot API 5.7
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Since: Bot API 6.6
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
SetName *string `json:"set_name,omitempty"` // Since: Bot API 3.2
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"` // Since: Bot API 3.2
|
||||
CustomEmojiID *string `json:"custom_emoji_id,omitempty"` // Since: Bot API 6.2
|
||||
NeedRepainting *bool `json:"need_repainting,omitempty"` // Since: Bot API 6.6
|
||||
FileSize *int64 `json:"file_size,omitempty"`
|
||||
// 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
|
||||
// IsAnimated True, if the sticker is animated
|
||||
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
|
||||
// Thumbnail Optional. Sticker thumbnail in the .WEBP or .JPG format
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Since: Bot API 6.6
|
||||
// Emoji Optional. Emoji associated with the sticker
|
||||
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
|
||||
// MaskPosition Optional. For mask stickers, the position where the mask should be placed
|
||||
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
|
||||
// NeedRepainting reports whether Telegram must recolor the custom emoji sticker.
|
||||
NeedRepainting *bool `json:"need_repainting,omitempty"` // Since: Bot API 6.6
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize *int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// StickerSet represents a sticker set.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#stickerset
|
||||
type StickerSet struct {
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
// Name Sticker set name
|
||||
Name string `json:"name"`
|
||||
// Title Sticker set title
|
||||
Title string `json:"title"`
|
||||
// StickerType Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
|
||||
StickerType StickerType `json:"sticker_type"`
|
||||
Stickers []Sticker `json:"stickers"`
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// Stickers List of all set stickers
|
||||
Stickers []Sticker `json:"stickers"`
|
||||
// Thumbnail Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// InputStickerFormat represents the format of an input sticker.
|
||||
@@ -84,9 +112,19 @@ const (
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#inputsticker
|
||||
type InputSticker struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Format InputStickerFormat `json:"format"`
|
||||
EmojiList []string `json:"emoji_list"`
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||
Keywords []string `json:"keywords,omitempty"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EmojiList List of 1-20 emoji associated with the sticker
|
||||
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"`
|
||||
// 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"`
|
||||
}
|
||||
|
||||
+604
-202
File diff suppressed because it is too large
Load Diff
@@ -72,6 +72,18 @@ func TestUpdateUnmarshalSetsType(t *testing.T) {
|
||||
}`,
|
||||
want: UpdateTypeManagedBot,
|
||||
},
|
||||
{
|
||||
name: "subscription",
|
||||
body: `{
|
||||
"update_id": 6,
|
||||
"subscription": {
|
||||
"user": {"id": 13, "is_bot": false, "first_name": "Subscriber"},
|
||||
"invoice_payload": "monthly",
|
||||
"state": "active"
|
||||
}
|
||||
}`,
|
||||
want: UpdateTypeSubscription,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
@@ -89,6 +101,9 @@ func TestUpdateUnmarshalSetsType(t *testing.T) {
|
||||
if tt.want == UpdateTypeManagedBot && update.ManagedBot.Bot.ID != 12 {
|
||||
t.Fatalf("unexpected managed bot id: got %d want %d", update.ManagedBot.Bot.ID, 12)
|
||||
}
|
||||
if tt.want == UpdateTypeSubscription && update.Subscription.User.ID != 13 {
|
||||
t.Fatalf("unexpected subscription user id: got %d want %d", update.Subscription.User.ID, 13)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
+72
-54
@@ -4,13 +4,14 @@ import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"mime/multipart"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/v2/utils"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
@@ -61,6 +62,15 @@ func (f UploaderFile) SetType(t UploaderFileType) UploaderFile {
|
||||
return f
|
||||
}
|
||||
|
||||
// SetAttachName sets the multipart field name used by an attach:// reference.
|
||||
// The name must match the suffix of the corresponding InputMedia.Media value.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (f UploaderFile) SetAttachName(name string) UploaderFile {
|
||||
f.field = UploaderFileType(name)
|
||||
return f
|
||||
}
|
||||
|
||||
// Uploader is a Telegram Bot API client specialized for multipart file uploads.
|
||||
//
|
||||
// Use Uploader methods when you need to upload binary files directly
|
||||
@@ -79,6 +89,7 @@ func NewUploader(api *API) *Uploader {
|
||||
"UPLOADER", utils.GetLoggerLevel(),
|
||||
api.logFormat, api.logFormatter,
|
||||
)
|
||||
logger.AddReplacer(api.token, "<TOKEN>")
|
||||
return &Uploader{api, logger}
|
||||
}
|
||||
|
||||
@@ -114,39 +125,38 @@ func NewUploaderRequestWithChatID[R, P any](method string, params P, chatID int6
|
||||
return UploaderRequest[R, P]{method: method, files: files, params: params, chatID: chatID}
|
||||
}
|
||||
|
||||
func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R, error) {
|
||||
func (u *Uploader) doRequest[R, P any](ctx context.Context, r UploaderRequest[R, P]) (R, error) {
|
||||
var zero R
|
||||
|
||||
methodPrefix := ""
|
||||
if up.api.useTestServer {
|
||||
if u.api.useTestServer {
|
||||
methodPrefix = "/test"
|
||||
}
|
||||
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", u.api.apiURL, u.api.token, methodPrefix, r.method)
|
||||
|
||||
retries := 0
|
||||
for {
|
||||
if up.api.Limiter != nil {
|
||||
if err := up.api.Limiter.Check(ctx, up.api.dropOverflowLimit, r.chatID); err != nil {
|
||||
if u.api.Limiter != nil {
|
||||
if err := u.api.Limiter.Check(ctx, u.api.dropOverflowLimit, r.chatID); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
}
|
||||
|
||||
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 {
|
||||
return zero, err
|
||||
}
|
||||
req, err := http.NewRequestWithContext(ctx, "POST", url, buf)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
_ = requestBody.Close()
|
||||
return zero, fmt.Errorf("failed to create upload request: %w", err)
|
||||
}
|
||||
req.Header.Set("Content-Type", contentType)
|
||||
req.Header.Set("Accept", "application/json")
|
||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||
req.ContentLength = int64(buf.Len())
|
||||
|
||||
up.logger.Debugln("UPLOADER REQ", r.method)
|
||||
resp, err := up.api.client.Do(req)
|
||||
u.logger.Debugln("UPLOADER REQ", url)
|
||||
resp, err := u.api.client.Do(req)
|
||||
_ = requestBody.Close()
|
||||
if err != nil {
|
||||
return zero, err
|
||||
return zero, fmt.Errorf("HTTP upload request failed: %w", redactHTTPError(err, u.api.token))
|
||||
}
|
||||
|
||||
body, err := readBody(resp.Body)
|
||||
@@ -154,7 +164,7 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
||||
u.logger.Debugln("UPLOADER RES", responseLogSummary(r.method, len(body)))
|
||||
|
||||
response, err := parseBody[R](body)
|
||||
if err != nil {
|
||||
@@ -162,29 +172,34 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
}
|
||||
|
||||
if !response.Ok {
|
||||
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||
after := *response.Parameters.RetryAfter
|
||||
up.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatID)
|
||||
if up.api.Limiter != nil {
|
||||
if r.chatID > 0 {
|
||||
up.api.Limiter.SetChatLock(r.chatID, after)
|
||||
} else {
|
||||
up.api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
}
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
continue
|
||||
}
|
||||
}
|
||||
return zero, &ResponseError{
|
||||
responseErr := &ResponseError{
|
||||
Code: response.ErrorCode,
|
||||
Description: response.Description,
|
||||
Parameters: response.Parameters,
|
||||
}
|
||||
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||
after := *response.Parameters.RetryAfter
|
||||
u.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatID)
|
||||
if u.api.Limiter != nil {
|
||||
if r.chatID != 0 {
|
||||
u.api.Limiter.SetChatLock(r.chatID, after)
|
||||
} else {
|
||||
u.api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
}
|
||||
if retries >= u.api.maxRetries {
|
||||
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||
}
|
||||
retries++
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(retryDelay(after)):
|
||||
continue
|
||||
}
|
||||
}
|
||||
return zero, responseErr
|
||||
}
|
||||
return response.Result, nil
|
||||
}
|
||||
@@ -192,11 +207,11 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
|
||||
// DoWithContext executes the upload request asynchronously via the worker pool.
|
||||
// Returns the result or error. Respects context cancellation.
|
||||
func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader) (R, error) {
|
||||
func (u *Uploader) DoWithContext[R, P any](ctx context.Context, r UploaderRequest[R, P]) (R, error) {
|
||||
var zero R
|
||||
|
||||
result, err := up.api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||
return r.doRequest(ctx, up)
|
||||
result, err := u.api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||
return u.doRequest(ctx, r)
|
||||
})
|
||||
if err != nil {
|
||||
return zero, err
|
||||
@@ -218,40 +233,43 @@ func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader)
|
||||
|
||||
// Do executes the upload request synchronously with a background context.
|
||||
// Use only for simple, non-critical uploads.
|
||||
func (r UploaderRequest[R, P]) Do(up *Uploader) (R, error) {
|
||||
return r.DoWithContext(context.Background(), up)
|
||||
func (u *Uploader) Do[R, P any](r UploaderRequest[R, P]) (R, error) {
|
||||
return u.DoWithContext(context.Background(), r)
|
||||
}
|
||||
|
||||
func prepareMultipart[P any](files []UploaderFile, params P) (*bytes.Buffer, string, error) {
|
||||
buf := bytes.NewBuffer(nil)
|
||||
w := multipart.NewWriter(buf)
|
||||
func prepareMultipartStream[P any](files []UploaderFile, params P) (io.ReadCloser, string) {
|
||||
reader, writer := io.Pipe()
|
||||
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 {
|
||||
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return nil, "", err
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = fw.Write(file.data)
|
||||
_, err = io.Copy(fw, bytes.NewReader(file.data))
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return nil, "", err
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
err := utils.Encode(w, params)
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return nil, "", err
|
||||
return err
|
||||
}
|
||||
|
||||
err = w.Close()
|
||||
if err != nil {
|
||||
return nil, "", err
|
||||
}
|
||||
|
||||
return buf, w.FormDataContentType(), nil
|
||||
return w.Close()
|
||||
}
|
||||
|
||||
func uploaderTypeByExt(filename string) UploaderFileType {
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
@@ -105,6 +107,77 @@ func TestUploaderEncodesJSONFieldsAndLeavesAcceptEncodingToHTTPTransport(t *test
|
||||
}
|
||||
}
|
||||
|
||||
func TestUploaderEditEphemeralMessageMediaUploadsAttachment(t *testing.T) {
|
||||
var (
|
||||
gotPath string
|
||||
gotFields map[string]string
|
||||
gotFileName string
|
||||
gotFileData []byte
|
||||
roundTripErr error
|
||||
)
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
gotPath = req.URL.Path
|
||||
gotFields, gotFileName, gotFileData, roundTripErr = readMultipartRequest(req)
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||
}, nil
|
||||
}),
|
||||
}
|
||||
api := NewAPI(NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
uploader := NewUploader(api)
|
||||
defer func() { _ = uploader.Close() }()
|
||||
|
||||
ok, err := uploader.EditEphemeralMessageMedia(
|
||||
EditEphemeralMessageMedia{
|
||||
ChatID: 42,
|
||||
ReceiverUserID: 7,
|
||||
EphemeralMessageID: 9,
|
||||
Media: InputMedia{
|
||||
Type: InputMediaTypePhoto,
|
||||
Media: "attach://replacement",
|
||||
},
|
||||
},
|
||||
NewUploaderFile("replacement.jpg", []byte("image")).SetAttachName("replacement"),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("EditEphemeralMessageMedia returned error: %v", err)
|
||||
}
|
||||
if !ok {
|
||||
t.Fatal("EditEphemeralMessageMedia returned false")
|
||||
}
|
||||
if roundTripErr != nil {
|
||||
t.Fatalf("multipart parse failed: %v", roundTripErr)
|
||||
}
|
||||
if gotPath != "/bottoken/editEphemeralMessageMedia" {
|
||||
t.Fatalf("unexpected request path: %q", gotPath)
|
||||
}
|
||||
var media InputMedia
|
||||
if err := json.Unmarshal([]byte(gotFields["media"]), &media); err != nil {
|
||||
t.Fatalf("decode media field: %v", err)
|
||||
}
|
||||
if media.Type != InputMediaTypePhoto || media.Media != "attach://replacement" {
|
||||
t.Fatalf("unexpected media field: %q", gotFields["media"])
|
||||
}
|
||||
if gotFileName != "replacement.jpg" || string(gotFileData) != "image" {
|
||||
t.Fatalf("unexpected upload: filename=%q data=%q", gotFileName, gotFileData)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUploaderRejectsDirectRichMessageDraftUpload(t *testing.T) {
|
||||
uploader := &Uploader{}
|
||||
_, err := uploader.SendRichMessageDraft(
|
||||
SendRichMessageDraft{ChatID: 42, DraftID: 1},
|
||||
NewUploaderFile("photo.jpg", []byte("photo")),
|
||||
)
|
||||
if !errors.Is(err, ErrRichMessageDraftUploadUnsupported) {
|
||||
t.Fatalf("expected ErrRichMessageDraftUploadUnsupported, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUploaderSurfacesResponseErrorForTelegramFailure(t *testing.T) {
|
||||
const responseBody = `{"ok":false,"error_code":400,"description":"Bad Request: chat not found"}`
|
||||
|
||||
@@ -177,6 +250,176 @@ func TestNewUploaderFileDetectsFileTypeCaseInsensitively(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestUploaderSendLivePhotoUsesRequiredMultipartFields(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
send func(*Uploader) (Message, error)
|
||||
}{
|
||||
{
|
||||
name: "background context",
|
||||
send: func(uploader *Uploader) (Message, error) {
|
||||
return uploader.SendLivePhoto(
|
||||
UploadLivePhoto{ChatID: 42},
|
||||
NewUploaderFile("live.mp4", []byte("video")),
|
||||
NewUploaderFile("photo.jpg", []byte("image")),
|
||||
)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "explicit context",
|
||||
send: func(uploader *Uploader) (Message, error) {
|
||||
return uploader.SendLivePhotoWithContext(
|
||||
context.Background(),
|
||||
UploadLivePhoto{ChatID: 42},
|
||||
NewUploaderFile("live.mp4", []byte("video")),
|
||||
NewUploaderFile("photo.jpg", []byte("image")),
|
||||
)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var (
|
||||
gotPath string
|
||||
gotFiles map[string]multipartFile
|
||||
parseErr error
|
||||
)
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
gotPath = req.URL.Path
|
||||
gotFiles, parseErr = readMultipartFiles(req)
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":5,"date":1}}`)),
|
||||
}, nil
|
||||
}),
|
||||
}
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
if err := api.Close(); err != nil {
|
||||
t.Errorf("Close API returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
uploader := NewUploader(api)
|
||||
defer func() {
|
||||
if err := uploader.Close(); err != nil {
|
||||
t.Errorf("Close uploader returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
if _, err := tt.send(uploader); err != nil {
|
||||
t.Fatalf("SendLivePhoto returned error: %v", err)
|
||||
}
|
||||
if parseErr != nil {
|
||||
t.Fatalf("multipart parse failed: %v", parseErr)
|
||||
}
|
||||
if gotPath != "/bottoken/sendLivePhoto" {
|
||||
t.Fatalf("unexpected request path: %q", gotPath)
|
||||
}
|
||||
assertMultipartFile(t, gotFiles, "live_photo", "live.mp4", "video")
|
||||
assertMultipartFile(t, gotFiles, "photo", "photo.jpg", "image")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPrepareMultipartRichMessageUsesAttachName(t *testing.T) {
|
||||
params := SendRichMessage{
|
||||
ChatID: 42,
|
||||
RichMessage: InputRichMessage{Blocks: []InputRichBlock{
|
||||
InputRichBlockAnimation{
|
||||
Type: InputRichTypeAnimation,
|
||||
Animation: InputMedia{Type: InputMediaTypeAnimation, Media: "attach://animation"},
|
||||
},
|
||||
}},
|
||||
}
|
||||
|
||||
body, contentType := prepareMultipartStream(
|
||||
[]UploaderFile{NewUploaderFile("animation.mp4", []byte("animation")).SetAttachName("animation")},
|
||||
params,
|
||||
)
|
||||
defer func() { _ = body.Close() }()
|
||||
|
||||
_, contentTypeParams, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMediaType returned error: %v", err)
|
||||
}
|
||||
reader := multipart.NewReader(body, contentTypeParams["boundary"])
|
||||
|
||||
parts := make(map[string]string)
|
||||
var fileData []byte
|
||||
for {
|
||||
part, err := reader.NextPart()
|
||||
if err == io.EOF {
|
||||
break
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("NextPart returned error: %v", err)
|
||||
}
|
||||
data, err := io.ReadAll(part)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadAll returned error: %v", err)
|
||||
}
|
||||
if part.FileName() != "" {
|
||||
if part.FormName() != "animation" {
|
||||
t.Errorf("file form name = %q, want animation", part.FormName())
|
||||
}
|
||||
fileData = data
|
||||
continue
|
||||
}
|
||||
parts[part.FormName()] = string(data)
|
||||
}
|
||||
|
||||
if string(fileData) != "animation" {
|
||||
t.Errorf("file data = %q, want animation", fileData)
|
||||
}
|
||||
if got := parts["rich_message"]; !strings.Contains(got, `"media":"attach://animation"`) {
|
||||
t.Errorf("rich_message = %s, want attach reference", got)
|
||||
}
|
||||
}
|
||||
|
||||
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) {
|
||||
_, params, err := mime.ParseMediaType(req.Header.Get("Content-Type"))
|
||||
if err != nil {
|
||||
@@ -209,3 +452,48 @@ func readMultipartRequest(req *http.Request) (map[string]string, string, []byte,
|
||||
fields[part.FormName()] = string(data)
|
||||
}
|
||||
}
|
||||
|
||||
type multipartFile struct {
|
||||
name string
|
||||
data string
|
||||
}
|
||||
|
||||
func readMultipartFiles(req *http.Request) (map[string]multipartFile, error) {
|
||||
_, params, err := mime.ParseMediaType(req.Header.Get("Content-Type"))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
reader := multipart.NewReader(req.Body, params["boundary"])
|
||||
files := make(map[string]multipartFile)
|
||||
for {
|
||||
part, err := reader.NextPart()
|
||||
if err == io.EOF {
|
||||
return files, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if part.FileName() == "" {
|
||||
continue
|
||||
}
|
||||
data, err := io.ReadAll(part)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
files[part.FormName()] = multipartFile{name: part.FileName(), data: string(data)}
|
||||
}
|
||||
}
|
||||
|
||||
func assertMultipartFile(t *testing.T, files map[string]multipartFile, field, name, data string) {
|
||||
t.Helper()
|
||||
file, ok := files[field]
|
||||
if !ok {
|
||||
t.Fatalf("multipart field %q is missing", field)
|
||||
}
|
||||
if file.name != name {
|
||||
t.Errorf("multipart field %q filename = %q, want %q", field, file.name, name)
|
||||
}
|
||||
if file.data != data {
|
||||
t.Errorf("multipart field %q data = %q, want %q", field, file.data, data)
|
||||
}
|
||||
}
|
||||
|
||||
+489
-147
@@ -2,29 +2,118 @@ package tgapi
|
||||
|
||||
import "context"
|
||||
|
||||
// SendRichMessage uploads files referenced by attach:// names in params.RichMessage
|
||||
// and sends the rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (u *Uploader) SendRichMessage(params SendRichMessage, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendRichMessage", params, params.ChatID, files...)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendRichMessageWithContext uploads files referenced by attach:// names in params.RichMessage
|
||||
// and sends the rich message using ctx for cancellation and deadlines.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (u *Uploader) SendRichMessageWithContext(ctx context.Context, params SendRichMessage, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendRichMessage", params, params.ChatID, files...)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// EditEphemeralMessageMedia edits ephemeral media and uploads files referenced through attach:// names.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (u *Uploader) EditEphemeralMessageMedia(params EditEphemeralMessageMedia, files ...UploaderFile) (bool, error) {
|
||||
req := NewUploaderRequestWithChatID[bool]("editEphemeralMessageMedia", params, params.ChatID, files...)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// EditEphemeralMessageMediaWithContext is the context-aware variant of EditEphemeralMessageMedia.
|
||||
//
|
||||
// Since: Bot API 10.3
|
||||
func (u *Uploader) EditEphemeralMessageMediaWithContext(
|
||||
ctx context.Context, params EditEphemeralMessageMedia, files ...UploaderFile,
|
||||
) (bool, error) {
|
||||
req := NewUploaderRequestWithChatID[bool]("editEphemeralMessageMedia", params, params.ChatID, files...)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// SendRichMessageDraft streams a rich-message draft without direct file uploads.
|
||||
// It returns ErrRichMessageDraftUploadUnsupported when files is non-empty.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (u *Uploader) SendRichMessageDraft(params SendRichMessageDraft, files ...UploaderFile) (bool, error) {
|
||||
if len(files) > 0 {
|
||||
return false, ErrRichMessageDraftUploadUnsupported
|
||||
}
|
||||
return u.api.SendRichMessageDraft(params)
|
||||
}
|
||||
|
||||
// SendRichMessageDraftWithContext is the context-aware variant of SendRichMessageDraft.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (u *Uploader) SendRichMessageDraftWithContext(ctx context.Context, params SendRichMessageDraft, files ...UploaderFile) (bool, error) {
|
||||
if len(files) > 0 {
|
||||
return false, ErrRichMessageDraftUploadUnsupported
|
||||
}
|
||||
return u.api.SendRichMessageDraftWithContext(ctx, params)
|
||||
}
|
||||
|
||||
// UploadPhoto holds parameters for uploading a photo using the Uploader.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
type UploadPhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// 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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the photo caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendPhoto uploads a photo via multipart and sends it as a message.
|
||||
@@ -33,7 +122,7 @@ type UploadPhoto struct {
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (u *Uploader) SendPhoto(params UploadPhoto, file UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||
@@ -42,34 +131,66 @@ func (u *Uploader) SendPhoto(params UploadPhoto, file UploaderFile) (Message, er
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (u *Uploader) SendPhotoWithContext(ctx context.Context, params UploadPhoto, file UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadAudio holds parameters for uploading an audio file using the Uploader.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
type UploadAudio struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Audio caption, 0-1024 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Duration Optional. Duration of the audio in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Performer Optional. Performer
|
||||
Performer string `json:"performer,omitempty"`
|
||||
Title string `json:"title,omitempty"`
|
||||
// Title Optional. Track name
|
||||
Title string `json:"title,omitempty"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendAudio uploads an audio file via multipart and sends it as a message.
|
||||
@@ -78,7 +199,7 @@ type UploadAudio struct {
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (u *Uploader) SendAudio(params UploadAudio, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||
@@ -87,31 +208,63 @@ func (u *Uploader) SendAudio(params UploadAudio, files ...UploaderFile) (Message
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (u *Uploader) SendAudioWithContext(ctx context.Context, params UploadAudio, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadDocument holds parameters for uploading a document using the Uploader.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
type UploadDocument struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the document caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendDocument uploads a document via multipart and sends it as a message.
|
||||
@@ -120,7 +273,7 @@ type UploadDocument struct {
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (u *Uploader) SendDocument(params UploadDocument, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendDocument", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||
@@ -129,38 +282,75 @@ func (u *Uploader) SendDocument(params UploadDocument, files ...UploaderFile) (M
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (u *Uploader) SendDocumentWithContext(ctx context.Context, params UploadDocument, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendDocument", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadVideo holds parameters for uploading a video using the Uploader.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
type UploadVideo struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Width Optional. Video width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Video height
|
||||
Height int `json:"height,omitempty"`
|
||||
|
||||
StartTimestamp int64 `json:"start_timestamp,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||
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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
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"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVideo uploads a video via multipart and sends it as a message.
|
||||
@@ -169,7 +359,7 @@ type UploadVideo struct {
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (u *Uploader) SendVideo(params UploadVideo, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVideo", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||
@@ -178,36 +368,71 @@ func (u *Uploader) SendVideo(params UploadVideo, files ...UploaderFile) (Message
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (u *Uploader) SendVideoWithContext(ctx context.Context, params UploadVideo, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVideo", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadAnimation holds parameters for uploading an animation using the Uploader.
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
type UploadAnimation struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// Duration Optional. Duration of sent animation in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Width Optional. Animation width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Animation height
|
||||
Height int `json:"height,omitempty"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the animation caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendAnimation uploads an animation via multipart and sends it as a message.
|
||||
@@ -216,7 +441,7 @@ type UploadAnimation struct {
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (u *Uploader) SendAnimation(params UploadAnimation, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendAnimation", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||
@@ -225,31 +450,61 @@ func (u *Uploader) SendAnimation(params UploadAnimation, files ...UploaderFile)
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (u *Uploader) SendAnimationWithContext(ctx context.Context, params UploadAnimation, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendAnimation", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadVoice holds parameters for uploading a voice note using the Uploader.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
type UploadVoice struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Voice message caption, 0-1024 characters after entities parsing
|
||||
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"`
|
||||
// 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"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Duration Optional. Duration of the voice message in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVoice uploads a voice note via multipart and sends it as a message.
|
||||
@@ -258,7 +513,7 @@ type UploadVoice struct {
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (u *Uploader) SendVoice(params UploadVoice, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVoice", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||
@@ -267,29 +522,55 @@ func (u *Uploader) SendVoice(params UploadVoice, files ...UploaderFile) (Message
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (u *Uploader) SendVoiceWithContext(ctx context.Context, params UploadVoice, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVoice", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadVideoNote holds parameters for uploading a video note (rounded video) using the Uploader.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
type UploadVideoNote struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Length int `json:"length,omitempty"`
|
||||
// Length Optional. Video width and height, i.e. diameter of the video message
|
||||
Length int `json:"length,omitempty"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendVideoNote uploads a video note via multipart and sends it as a message.
|
||||
@@ -298,7 +579,7 @@ type UploadVideoNote struct {
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (u *Uploader) SendVideoNote(params UploadVideoNote, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVideoNote", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||
@@ -307,13 +588,15 @@ func (u *Uploader) SendVideoNote(params UploadVideoNote, files ...UploaderFile)
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (u *Uploader) SendVideoNoteWithContext(ctx context.Context, params UploadVideoNote, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendVideoNote", params, params.ChatID, files...)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadChatPhoto holds parameters for uploading a chat photo using the Uploader.
|
||||
// Since: Bot API 3.1
|
||||
// See https://core.telegram.org/bots/api#setchatphoto
|
||||
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"`
|
||||
}
|
||||
|
||||
@@ -323,7 +606,7 @@ type UploadChatPhoto struct {
|
||||
// See https://core.telegram.org/bots/api#setchatphoto
|
||||
func (u *Uploader) SetChatPhoto(params UploadChatPhoto, photo UploaderFile) (bool, error) {
|
||||
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo)
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SetChatPhotoWithContext is the context-aware variant of SetChatPhoto.
|
||||
@@ -332,7 +615,7 @@ func (u *Uploader) SetChatPhoto(params UploadChatPhoto, photo UploaderFile) (boo
|
||||
// See https://core.telegram.org/bots/api#setchatphoto
|
||||
func (u *Uploader) SetChatPhotoWithContext(ctx context.Context, params UploadChatPhoto, photo UploaderFile) (bool, error) {
|
||||
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo)
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadSetWebhook holds multipart parameters for the setWebhook method.
|
||||
@@ -340,12 +623,29 @@ func (u *Uploader) SetChatPhotoWithContext(ctx context.Context, params UploadCha
|
||||
// Use this type when uploading a self-signed certificate file.
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
type UploadSetWebhook struct {
|
||||
URL string `json:"url"`
|
||||
IPAddress string `json:"ip_address,omitempty"`
|
||||
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||
SecretToken string `json:"secret_token,omitempty"`
|
||||
// URL Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetWebhook uploads a certificate and sets a webhook URL.
|
||||
@@ -354,7 +654,7 @@ type UploadSetWebhook struct {
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
func (u *Uploader) SetWebhook(params UploadSetWebhook, certificate UploaderFile) (bool, error) {
|
||||
req := NewUploaderRequest[bool]("setWebhook", params, certificate.SetType(UploaderCertificateType))
|
||||
return req.Do(u)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SetWebhookWithContext is the context-aware variant of SetWebhook.
|
||||
@@ -363,48 +663,90 @@ func (u *Uploader) SetWebhook(params UploadSetWebhook, certificate UploaderFile)
|
||||
// See https://core.telegram.org/bots/api#setwebhook
|
||||
func (u *Uploader) SetWebhookWithContext(ctx context.Context, params UploadSetWebhook, certificate UploaderFile) (bool, error) {
|
||||
req := NewUploaderRequest[bool]("setWebhook", params, certificate.SetType(UploaderCertificateType))
|
||||
return req.DoWithContext(ctx, u)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
// UploadLivePhoto holds parameters for uploading a live photo using the Uploader.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
type UploadLivePhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// EphemeralMessageParameters configures an ephemeral response.
|
||||
EphemeralMessageParameters *EphemeralMessageParameters `json:"ephemeral_message_parameters,omitempty"` // Since: Bot API 10.3
|
||||
// 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"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
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"`
|
||||
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
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"`
|
||||
// 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"`
|
||||
// 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"`
|
||||
|
||||
// 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"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
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"`
|
||||
}
|
||||
|
||||
// SendLivePhoto uploads a live photo via multipart and sends it as a message.
|
||||
// SendLivePhoto uploads a live-photo video and its static image via multipart.
|
||||
// livePhoto is sent in the live_photo field and photo in the photo field.
|
||||
// Since: Bot API 10.0
|
||||
// file is the live photo file to upload.
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (u *Uploader) SendLivePhoto(params UploadLivePhoto, file UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID, file.SetType(UploaderLivePhotoType))
|
||||
return req.Do(u)
|
||||
func (u *Uploader) SendLivePhoto(params UploadLivePhoto, livePhoto, photo UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message](
|
||||
"sendLivePhoto", params, params.ChatID,
|
||||
livePhoto.SetType(UploaderLivePhotoType),
|
||||
photo.SetType(UploaderPhotoType),
|
||||
)
|
||||
return u.Do(req)
|
||||
}
|
||||
|
||||
// SendLivePhotoWithContext is the context-aware variant of SendLivePhoto.
|
||||
// SendLivePhotoWithContext uploads a live-photo video and its static image via
|
||||
// multipart using ctx for cancellation and deadlines.
|
||||
// Since: Bot API 10.0
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (u *Uploader) SendLivePhotoWithContext(ctx context.Context, params UploadLivePhoto, file UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID, file.SetType(UploaderLivePhotoType))
|
||||
return req.DoWithContext(ctx, u)
|
||||
func (u *Uploader) SendLivePhotoWithContext(
|
||||
ctx context.Context, params UploadLivePhoto, livePhoto, photo UploaderFile,
|
||||
) (Message, error) {
|
||||
req := NewUploaderRequestWithChatID[Message](
|
||||
"sendLivePhoto", params, params.ChatID,
|
||||
livePhoto.SetType(UploaderLivePhotoType),
|
||||
photo.SetType(UploaderPhotoType),
|
||||
)
|
||||
return u.DoWithContext(ctx, req)
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user