telego

package module
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 10, 2026 License: MIT Imports: 19 Imported by: 194

README

Telego • Go Telegram Bot API

Go Reference Telego Docs Go Version Telegram Bot API Version
Mentioned in Awesome Go Ask DeepWiki Discussions Telegram Chat

CI Status Race Testing Quality Gate Status Go Report
Coverage Code Smells Lines of Code

Telego logo

Telego is a Telegram Bot API library for Golang with full API implementation (one-to-one)

The goal of this library was to create API with the same types and methods as actual Telegram Bot API. Every type and method have been represented in types.go and methods.go files with mostly all documentation from Telegram.

For more detailed documentation, see docs at telego.pixelbox.dev.

Note: Telego uses fasthttp instead of net/http and go-json instead of encoding/json by default (both can be changed).

📋 Table Of Content
Click to show • hide

⚡ Getting Started

How to get the library:

go get github.com/mymmrac/telego

Make sure you get the latest version to have all new features and fixes.

More examples can be seen here:

Click to show • hide

Note: Error handling may be missing in examples, but I strongly recommend handling all errors.

Generally, useful information about Telegram Bots and their features:

Click to show • hide
🧩 Basic setup

▲ Go Up ▲

For start, you need to create an instance of your bot and specify token.

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/mymmrac/telego"
)

func main() {
	// Get Bot token from environment variables
	botToken := os.Getenv("TOKEN")

	// Create bot and enable debugging info
	// Note: Please keep in mind that default logger may expose sensitive information,
	// use in development only
	// (more on configuration in examples/configuration/main.go)
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Call method getMe (https://core.telegram.org/bots/api#getme)
	botUser, err := bot.GetMe(context.Background())
	if err != nil {
		fmt.Println("Error:", err)
	}

	// Print Bot information
	fmt.Printf("Bot user: %+v\n", botUser)
}
📩 Getting updates

▲ Go Up ▲

To receive updates, you can use one of two methods:

  • using long polling (bot.UpdatesViaLongPolling)
  • using webhook (bot.UpdatesViaWebhook, recommended way)

Let's start from long polling (easier for local testing):

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/mymmrac/telego"
)

func main() {
	botToken := os.Getenv("TOKEN")

	// Note: Please keep in mind that default logger may expose sensitive information,
	// use in development only
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Get updates channel
	// (more on configuration in examples/updates_long_polling/main.go)
	updates, _ := bot.UpdatesViaLongPolling(context.Background(), nil)

	// Loop through all updates when they came
	for update := range updates {
		fmt.Printf("Update: %+v\n", update)
	}
}

Webhook example (recommended way):

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"

	"github.com/mymmrac/telego"
)

func main() {
	ctx := context.Background()
	botToken := os.Getenv("TOKEN")

	// Note: Please keep in mind that default logger may expose sensitive information,
	// use in development only
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Set up a webhook on Telegram side
	_ = bot.SetWebhook(ctx, &telego.SetWebhookParams{
		URL:         "https://example.com/bot",
		SecretToken: bot.SecretToken(),
	})

	// Receive information about webhook
	info, _ := bot.GetWebhookInfo(ctx)
	fmt.Printf("Webhook Info: %+v\n", info)

	// Create http serve mux
	mux := http.NewServeMux()

	// Get an update channel from webhook.
	// (more on configuration in examples/updates_webhook/main.go)
	updates, _ := bot.UpdatesViaWebhook(ctx, telego.WebhookHTTPServeMux(mux, "/bot", bot.SecretToken()))

	// Start server for receiving requests from the Telegram
	go func() {
		_ = http.ListenAndServe(":443", mux)
	}()

	// Loop through all updates when they came
	for update := range updates {
		fmt.Printf("Update: %+v\n", update)
	}
}

For running multiple bots from a single server, see this example.

Tip: For testing webhooks locally, you can use Ngrok to make a tunnel to your localhost, and get a random domain available from the Internet. It's as simple as ngrok http 8080. Or follow Telego + Ngrok example using ngrok/ngrok-go for most convenient bot testing.

Tip: You may wish to use Let's Encrypt in order to generate your free TLS certificate.

🪁 Using Telegram methods

▲ Go Up ▲

All Telegram Bot API methods described in documentation can be used by the library. They have the same names and the same parameters, parameters represented by struct with name: <methodName> + Params. If method doesn't have required parameters nil value can be used as a parameter.

Note: types.go and methods.go were automatically generated from documentation, and it's possible that they have errors or missing parts both in comments and actual code. Feel free to report such things.

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/mymmrac/telego"
	tu "github.com/mymmrac/telego/telegoutil"
)

func main() {
	ctx := context.Background()
	botToken := os.Getenv("TOKEN")

	// Note: Please keep in mind that default logger may expose sensitive information,
	// use in development only
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Call method getMe
	botUser, _ := bot.GetMe(ctx)
	fmt.Printf("Bot User: %+v\n", botUser)

	updates, _ := bot.UpdatesViaLongPolling(ctx, nil)

	for update := range updates {
		if update.Message != nil {
			// Retrieve chat ID
			chatID := update.Message.Chat.ID

			// Call method sendMessage.
			// Send a message to sender with the same text (echo bot).
			// (https://core.telegram.org/bots/api#sendmessage)
			sentMessage, _ := bot.SendMessage(ctx,
				tu.Message(
					tu.ID(chatID),
					update.Message.Text,
				),
			)

			fmt.Printf("Sent Message: %v\n", sentMessage)
		}
	}
}
🧼 Utility methods

▲ Go Up ▲

In Telego even though you have all types and methods available, it's often not so convenient to use them directly. To solve this issues telegoutil package was created. It contains utility-helper function that will make your life a bit easier.

I suggest including it with alias to get cleaner code:

import tu "github.com/mymmrac/telego/telegoutil"

The package contains couple methods for creating send parameters with all required parameters like:

  • Message(chatID, text) => SendMessageParams
  • Photo(chatID, photoFile) => SendPhotoParams
  • Location(chatID, latitude, longitude) => SendLocationParams
  • ...

Or other useful methods like:

  • ID(intID) => ChatID
  • File(namedReader) => InputFile
  • ...

Utils related to methods can be found in telegoutil/methods, for types in telegoutil/types, for handlers in telegoutil/handler, for api in telegoutil/api.

Note: If you think that something can be added to telegoutil package fill free to create an issue or pull request with desired changes.

🦾 Helper With... methods

▲ Go Up ▲

Creating method parameters is sometimes bulky and not convenient, so you can use with methods in combination with utility methods.

Here is a simple example of creating a message with a keyboard that has 4 buttons with different parameters.

package main

import (
	"github.com/mymmrac/telego"
	tu "github.com/mymmrac/telego/telegoutil"
)

func main() {
	// ... initializing bot (full example in examples/keyboard/main.go)

	// Creating keyboard
	keyboard := tu.Keyboard(
		tu.KeyboardRow( // Row 1
			// Column 1
			tu.KeyboardButton("Button"),

			// Column 2, `with` method
			tu.KeyboardButton("Poll Regular").
				WithRequestPoll(tu.PollTypeRegular()),
		),
		tu.KeyboardRow( // Row 2
			// Column 1, `with` method 
			tu.KeyboardButton("Contact").WithRequestContact(),

			// Column 2, `with` method 
			tu.KeyboardButton("Location").WithRequestLocation(),
		),
	).WithResizeKeyboard().WithInputFieldPlaceholder("Select something")
	// Multiple `with` methods can be chained

	// Creating message
	msg := tu.Message(
		tu.ID(123),
		"Hello World",
	).WithReplyMarkup(keyboard).WithProtectContent() // Multiple `with` method 

	bot.SendMessage(ctx, msg)
}

Those methods allow you to modify values without directly accessing them, also as you saw with methods can be staked one to another to update multiple values.

🌥 Bot handlers

▲ Go Up ▲

Processing updates just in for loop is not the most pleasing thing to do, so Telego provides net/http like handlers, but instead of the path, you provide predicates.

One update will only match to the first handler whose predicates are satisfied, predicates checked in order of handler registration (it's useful to first specify the most specific predicates and then more general).

Also, all handlers (but not their predicates) are processed in parallel.

I suggest including it with alias to get cleaner code:

import th "github.com/mymmrac/telego/telegohandler"

Here is an example of using handlers with long polling updates. You can see the full list of available predicates in telegohandler/predicates, or define your own.

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/mymmrac/telego"
	th "github.com/mymmrac/telego/telegohandler"
	tu "github.com/mymmrac/telego/telegoutil"
)

func main() {
	ctx := context.Background()
	botToken := os.Getenv("TOKEN")

	// Note: Please keep in mind that default logger may expose sensitive information,
	// use in development only
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Get updates channel
	updates, _ := bot.UpdatesViaLongPolling(ctx, nil)

	// Create bot handler and specify from where to get updates
	bh, _ := th.NewBotHandler(bot, updates)

	// Stop handling updates
	defer func() { _ = bh.Stop() }()

	// Register new handler with match on command `/start`
	bh.Handle(func(ctx *th.Context, update telego.Update) error {
		// Send message
		_, _ = ctx.Bot().SendMessage(ctx, tu.Message(
			tu.ID(update.Message.Chat.ID),
			fmt.Sprintf("Hello %s!", update.Message.From.FirstName),
		))
		return nil
	}, th.CommandEqual("start"))

	// Register new handler with match on any command
	// Handlers will match only once and in order of registration, 
	// so this handler will be called on any command except `/start` command
	bh.Handle(func(ctx *th.Context, update telego.Update) error {
		// Send message
		_, _ = ctx.Bot().SendMessage(ctx, tu.Message(
			tu.ID(update.Message.Chat.ID),
			"Unknown command, use /start",
		))
		return nil
	}, th.AnyCommand())

	// Start handling updates
	_ = bh.Start()
}

Just handling updates is useful, but handling specific updates like messages or callback queries in most of the cases is more straightforward and provides cleaner code.

So Telego provides specific handles for all fields of telego.Update. See the list of all available handler types in telegohandler/handlers, or define your own.

package main

import (
	"fmt"

	"github.com/mymmrac/telego"
	th "github.com/mymmrac/telego/telegohandler"
	tu "github.com/mymmrac/telego/telegoutil"
)

func main() {
	// ... initializing bot and bot handler 
	// (full example in examples/handler_specific/main.go)

	// Register new handler with match on command `/start`
	bh.HandleMessage(func(ctx *th.Context, message telego.Message) error {
		// Send a message with inline keyboard
		_, _ = ctx.Bot().SendMessage(ctx, tu.Message(
			tu.ID(message.Chat.ID),
			fmt.Sprintf("Hello %s!", message.From.FirstName),
		).WithReplyMarkup(tu.InlineKeyboard(
			tu.InlineKeyboardRow(
				tu.InlineKeyboardButton("Go!").WithCallbackData("go"),
			)),
		))
		return nil
	}, th.CommandEqual("start"))

	// Register new handler with match on the call back query 
	// with data equal to `go` and non-nil message
	bh.HandleCallbackQuery(func(ctx *th.Context, query telego.CallbackQuery) error {
		// Send message
		_, _ = ctx.Bot().SendMessage(ctx, tu.Message(tu.ID(query.Message.Chat.ID), "GO GO GO"))

		// Answer callback query
		_ = ctx.Bot().AnswerCallbackQuery(ctx, tu.CallbackQuery(query.ID).WithText("Done"))

		return nil
	}, th.AnyCallbackQueryWithMessage(), th.CallbackDataEqual("go"))

	// ... start bot handler
}

One more important part of handlers is groups and middlewares. Telego allows creating groups with and without predicates and attaching middleware to groups.

package main

import (
	"fmt"

	"github.com/mymmrac/telego"
	th "github.com/mymmrac/telego/telegohandler"
)

func main() {
	// Init ...

	// Add global middleware, it will be applied in order of addition
	bh.Use(func(ctx *th.Context, update telego.Update) error {
		fmt.Println("Global middleware") // Will be called first
		return ctx.Next(update)
	})

	// Create any groups with or without predicates
	// Note: Updates first checked by groups and only then by handlers 
	// (group -> ... -> group -> handler)
	task := bh.Group(th.TextContains("task"))

	// Add middleware to groups
	task.Use(func(ctx *th.Context, update telego.Update) error {
		fmt.Println("Group-based middleware") // Will be called second

		if len(update.Message.Text) < 10 {
			return ctx.Next(update)
		}

		return nil
	})

	// Handle updates on a group
	task.HandleMessage(func(ctx *th.Context, message telego.Message) error {
		fmt.Println("Task...") // Will be called third
		return nil
	})
}
⚙ Build configuration

▲ Go Up ▲

Telego supports multiple build configurations via Go's build tags (right now only to change JSON encoding/decoding library):

Note: Use sonic only on supported platforms as it has its own limitations, more here.

If you wish to set JSON encoding/decoding methods to something custom, there are global methods SetJSONMarshal and SetJSONUnmarshal that can be used.

🎨 Contribution

Contribution guidelines listed here.

⭐ Stargazers over time

Stargazers over time

Powered by caarlos0/starcharts

🔐 License

Telego is distributed under MIT licence.

Documentation

Overview

Package telego provides one-to-one Telegram Bot API method and types.

Telego features all methods and types described in official Telegram documentation (https://core.telegram.org/bots/api). It achieves this by generating methods and types from docs (generation is in internal/generator package).

The main goal was and is to create a one-to-one library, so that if you know how Telegram bots work, you will immediately know how to implement that in Go using Telego.

One-to-one implementation

All types named and contain the same information as documented by Telegram, for methods it's exactly the same. However, some minor differences may be present (like use of interfaces or combined types). Also, all generated codes have the same description as in Telegram docs, so there is actually no need to go to docs (but still, be careful as it is not a full copy of docs due to text-only limitation).

Telego was also created to simplify work with a Telegram API, so some additional methods for more convenient usage located in long_polling.go and webhook.go and telegoutil package.

When you are working with things like chat ID which can be an integer or string, Telego provides combined types: 

type ChatID struct {
	ID       int64
	Username string
}

or input files that can be URL, file ID or actual file data: 

type InputFile struct {
	File telegoapi.NamedReader
	FileID string
	URL string
}

you will specify only one of the fields and Telego will figure out what to do with that.

For more flexibility, file data for InputFile are provided via simple interface: 

type NamedReader interface {
	io.Reader
	Name() string
}

os.File already implements this interface, so you can use it directly.

Example

Most of the examples can be seen in the examples folder.

Simple echo bot: 

package main

import (
	"fmt"
	"os"

	"github.com/mymmrac/telego"
	tu "github.com/mymmrac/telego/telegoutil"
)

func main() {
	ctx := context.Background()
	botToken := os.Getenv("TOKEN")

	// Create Bot with debug on
	bot, err := telego.NewBot(botToken, telego.WithDefaultDebugLogger())
	if err != nil {
		fmt.Println(err)
		return
	}

	// Get updates channel
	updates, _ := bot.UpdatesViaLongPolling(ctx, nil)

	// Loop through all updates when they came
	for update := range updates {
		// Check if update contains message
		if update.Message != nil {
			// Get chat ID from message
			chatID := tu.ID(update.Message.Chat.ID)

			// Copy sent message back to user
			_, _ = bot.CopyMessage(ctx, &telego.CopyMessageParams{
				ChatID:     chatID,
				FromChatID: chatID,
				MessageID:  update.Message.MessageID,
			})
		}
	}
}

This bot will send the same messages as you sent to him.

Index

Constants

View Source 
const (
	MessageUpdates                 = "message"
	EditedMessageUpdates           = "edited_message"
	ChannelPostUpdates             = "channel_post"
	EditedChannelPostUpdates       = "edited_channel_post"
	BusinessConnectionUpdates      = "business_connection"
	BusinessMessageUpdates         = "business_message"
	EditedBusinessMessageUpdates   = "edited_business_message"
	DeletedBusinessMessagesUpdates = "deleted_business_messages"
	MessageReactionUpdates         = "message_reaction"
	MessageReactionCountUpdates    = "message_reaction_count"
	InlineQueryUpdates             = "inline_query"
	ChosenInlineResultUpdates      = "chosen_inline_result"
	CallbackQueryUpdates           = "callback_query"
	ShippingQueryUpdates           = "shipping_query"
	PreCheckoutQueryUpdates        = "pre_checkout_query"
	PurchasedPaidMediaUpdates      = "purchased_paid_media"
	PollUpdates                    = "poll"
	PollAnswerUpdates              = "poll_answer"
	MyChatMemberUpdates            = "my_chat_member"
	ChatMemberUpdates              = "chat_member"
	ChatJoinRequestUpdates         = "chat_join_request"
	ChatBoostUpdates               = "chat_boost"
	RemovedChatBoostUpdates        = "removed_chat_boost"
)

Update types you want your bot to receive

View Source 
const (
	ModeHTML       = "HTML"
	ModeMarkdown   = "Markdown"
	ModeMarkdownV2 = "MarkdownV2"
)

Parse modes

View Source 
const (
	ChatActionTyping          = "typing"
	ChatActionUploadPhoto     = "upload_photo"
	ChatActionRecordVideo     = "record_video"
	ChatActionUploadVideo     = "upload_video"
	ChatActionRecordVoice     = "record_voice"
	ChatActionUploadVoice     = "upload_voice"
	ChatActionUploadDocument  = "upload_document"
	ChatActionChooseSticker   = "choose_sticker"
	ChatActionFindLocation    = "find_location"
	ChatActionRecordVideoNote = "record_video_note"
	ChatActionUploadVideoNote = "upload_video_note"
)

Chat actions

View Source 
const (
	StickerFormatStatic   = "static"
	StickerFormatAnimated = "animated"
	StickerFormatVideo    = "video"
)

Sticker formats

View Source 
const (
	ChatTypeSender     = "sender"
	ChatTypePrivate    = "private"
	ChatTypeGroup      = "group"
	ChatTypeSupergroup = "supergroup"
	ChatTypeChannel    = "channel"
)

Chat types

View Source 
const (
	EntityTypeMention              = "mention"
	EntityTypeHashtag              = "hashtag"
	EntityTypeCashtag              = "cashtag"
	EntityTypeBotCommand           = "bot_command"
	EntityTypeURL                  = "url"
	EntityTypeEmail                = "email"
	EntityTypePhoneNumber          = "phone_number"
	EntityTypeBold                 = "bold"
	EntityTypeItalic               = "italic"
	EntityTypeUnderline            = "underline"
	EntityTypeStrikethrough        = "strikethrough"
	EntityTypeSpoiler              = "spoiler"
	EntityTypeBlockquote           = "blockquote"
	EntityTypeExpandableBlockquote = "expandable_blockquote"
	EntityTypeCode                 = "code"
	EntityTypePre                  = "pre"
	EntityTypeTextLink             = "text_link"
	EntityTypeTextMention          = "text_mention"
	EntityTypeCustomEmoji          = "custom_emoji"
)

MessageEntity types

View Source 
const (
	OriginTypeUser       = "user"
	OriginTypeHiddenUser = "hidden_user"
	OriginTypeChat       = "chat"
	OriginTypeChannel    = "channel"
)

Message origin types

View Source 
const (
	PaidMediaTypePreview = "preview"
	PaidMediaTypePhoto   = "photo"
	PaidMediaTypeVideo   = "video"
)

Paid media types

View Source 
const (
	EmojiDice        = "🎲"
	EmojiDarts       = "🎯"
	EmojiBowling     = "🎳"
	EmojiBasketball  = "🏀"
	EmojiSoccer      = "⚽"
	EmojiSlotMachine = "🎰"
)

Dice emojis

View Source 
const (
	PollTypeRegular = "regular"
	PollTypeQuiz    = "quiz"
)

Poll types

View Source 
const (
	BackgroundFilledSolid            = "solid"
	BackgroundFilledGradient         = "gradient"
	BackgroundFilledFreeformGradient = "freeform_gradient"
)

Background fill types

View Source 
const (
	BackgroundTypeNameFill      = "fill"
	BackgroundTypeNameWallpaper = "wallpaper"
	BackgroundTypeNamePattern   = "pattern"
	BackgroundTypeNameChatTheme = "chat_theme"
)

Background type names

View Source 
const (
	MarkupTypeReplyKeyboard       = "ReplyKeyboardMarkup"
	MarkupTypeReplyKeyboardRemove = "ReplyKeyboardRemove"
	MarkupTypeInlineKeyboard      = "InlineKeyboardMarkup"
	MarkupTypeForceReply          = "ForceReply"
)

ReplyMarkup types

View Source 
const (
	MemberStatusCreator       = "creator"
	MemberStatusAdministrator = "administrator"
	MemberStatusMember        = "member"
	MemberStatusRestricted    = "restricted"
	MemberStatusLeft          = "left"
	MemberStatusBanned        = "kicked"
)

ChatMember statuses

View Source 
const (
	StoryAreaLocation          = "location"
	StoryAreaSuggestedReaction = "suggested_reaction"
	StoryAreaLink              = "link"
	StoryAreaWeather           = "weather"
	StoryAreaUniqueGift        = "unique_gift"
)

Story area types

View Source 
const (
	ReactionEmoji       = "emoji"
	ReactionCustomEmoji = "custom_emoji"
	ReactionPaid        = "paid"
)

Reaction types

View Source 
const (
	GiftOriginUpgrade  = "upgrade"
	GiftOriginTransfer = "transfer"
	GiftOriginResale   = "resale"
)

Gift origins

View Source 
const (
	GiftTypeRegular = "regular"
	GiftTypeUnique  = "unique"
)

Gift types

View Source 
const (
	ScopeTypeDefault               = "default"
	ScopeTypeAllPrivateChats       = "all_private_chats"
	ScopeTypeAllGroupChats         = "all_group_chats"
	ScopeTypeAllChatAdministrators = "all_chat_administrators"
	ScopeTypeChat                  = "chat"
	ScopeTypeChatAdministrators    = "chat_administrators"
	ScopeTypeChatMember            = "chat_member"
)

BotCommandScope types

View Source 
const (
	ButtonTypeCommands = "commands"
	ButtonTypeWebApp   = "web_app"
	ButtonTypeDefault  = "default"
)

MenuButton types

View Source 
const (
	BoostSourcePremium  = "premium"
	BoostSourceGiftCode = "gift_code"
	BoostSourceGiveaway = "giveaway"
)

Boost sources

View Source 
const (
	MediaTypePhoto     = "photo"
	MediaTypeVideo     = "video"
	MediaTypeAnimation = "animation"
	MediaTypeAudio     = "audio"
	MediaTypeDocument  = "document"
)

InputMedia types

View Source 
const (
	PhotoTypeStatic   = "static"
	PhotoTypeAnimated = "animated"
)

Input profile photo types

View Source 
const (
	StoryTypePhoto = "photo"
	StoryTypeVideo = "video"
)

Story types

View Source 
const (
	StickerTypeRegular     = "regular"
	StickerTypeMask        = "mask"
	StickerTypeCustomEmoji = "custom_emoji"
)

Sticker types

View Source 
const (
	PointForehead = "forehead"
	PointEyes     = "eyes"
	PointMouth    = "mouth"
	PointChin     = "chin"
)

MaskPosition points

View Source 
const (
	StickerStatic   = "static"
	StickerAnimated = "animated"
	StickerVideo    = "video"
)

Sticker formats

View Source 
const (
	ResultTypeArticle  = "article"
	ResultTypePhoto    = "photo"
	ResultTypeGif      = "gif"
	ResultTypeMpeg4Gif = "mpeg4_gif"
	ResultTypeVideo    = "video"
	ResultTypeAudio    = "audio"
	ResultTypeVoice    = "voice"
	ResultTypeDocument = "document"
	ResultTypeLocation = "location"
	ResultTypeVenue    = "venue"
	ResultTypeContact  = "contact"
	ResultTypeGame     = "game"
	ResultTypeSticker  = "sticker"
)

InlineQueryResult types

View Source 
const (
	MimeTypeImageJpeg      = "image/jpeg"
	MimeTypeImageGif       = "image/gif"
	MimeTypeVideoMp4       = "video/mp4"
	MimeTypeTextHTML       = "text/html"
	MimeTypeApplicationPDF = "application/pdf"
	MimeTypeApplicationZip = "application/zip"
)

ThumbMimeType types

View Source 
const (
	ContentTypeText     = "InputTextMessage"
	ContentTypeLocation = "InputLocationMessage"
	ContentTypeVenue    = "InputVenueMessage"
	ContentTypeContact  = "InputContactMessage"
	ContentTypeInvoice  = "InputInvoiceMessage"
)

InputMessageContent types

View Source 
const (
	WithdrawalStatePending   = "pending"
	WithdrawalStateSucceeded = "succeeded"
	WithdrawalStateFailed    = "failed"
)

Revenue withdrawal state types

View Source 
const (
	PartnerTypeUser             = "user"
	PartnerTypeChat             = "chat"
	PartnerTypeAffiliateProgram = "affiliate_program"
	PartnerTypeFragment         = "fragment"
	PartnerTypeTelegramAds      = "telegram_ads"
	PartnerTypeTelegramApi      = "telegram_api" //nolint:revive
	PartnerTypeOther            = "other"
)

Transaction partner types

View Source 
const (
	TransactionTypeInvoicePayment          = "invoice_payment"
	TransactionTypePaidMediaPayment        = "paid_media_payment"
	TransactionTypeGiftPurchase            = "gift_purchase"
	TransactionTypePremiumPurchase         = "premium_purchase"
	TransactionTypeBusinessAccountTransfer = "business_account_transfer"
)

Transaction types

View Source 
const (
	ElementTypePersonalDetails       = "personal_details"
	ElementTypePassport              = "passport"
	ElementTypeDriverLicense         = "driver_license"
	ElementTypeIdentityCard          = "identity_card"
	ElementTypeInternalPassport      = "internal_passport"
	ElementTypeAddress               = "address"
	ElementTypeUtilityBill           = "utility_bill"
	ElementTypeBankStatement         = "bank_statement"
	ElementTypeRentalAgreement       = "rental_agreement"
	ElementTypePassportRegistration  = "passport_registration"
	ElementTypeTemporaryRegistration = "temporary_registration"
	ElementTypePhoneNumber           = "phone_number"
	ElementTypeEmail                 = "email"
)

EncryptedPassportElement types

View Source 
const (
	ErrorSourceDataField        = "data"
	ErrorSourceFrontSide        = "front_side"
	ErrorSourceReverseSide      = "reverse_side"
	ErrorSourceSelfie           = "selfie"
	ErrorSourceFile             = "file"
	ErrorSourceFiles            = "files"
	ErrorSourceTranslationFile  = "translation_file"
	ErrorSourceTranslationFiles = "translation_files"
	ErrorSourceUnspecified      = "unspecified"
)

PassportElementError sources

View Source 
const DefaultLoggerTokenReplacement = "BOT_TOKEN"

DefaultLoggerTokenReplacement used to replace bot token in logs when using default logger

View Source 
const WebhookSecretTokenHeader = "X-Telegram-Bot-Api-Secret-Token" //nolint:gosec

WebhookSecretTokenHeader represents secret token header name, see [SetWebhookParams.SecretToken] for more details

Variables

View Source 
var ErrEmptyToken = errors.New("telego: empty token")

ErrEmptyToken bot token is empty

View Source 
var ErrInvalidToken = errors.New("telego: invalid token format")

ErrInvalidToken bot token is invalid according to token regexp

Functions

func SetJSONMarshal added in v0.31.4 

func SetJSONMarshal(marshal func(v any) ([]byte, error))

SetJSONMarshal set JSON marshal func used in Telego

Warning: Panics if passed func is nil

Warning: This method is not concurrently-safe, do not call if bot is already running

func SetJSONUnmarshal added in v0.31.4 

func SetJSONUnmarshal(unmarshal func(data []byte, v any) error)

SetJSONUnmarshal set JSON unmarshal func used in Telego Note: Unmarshal func should support unmarshalling into interface types if the struct field is populated with the correct type, not all libraries support this

Warning: Panics if passed func is nil

Warning: This method is not concurrently-safe, do not call if bot is already running

func ToPtr added in v0.21.0 

func ToPtr[T any](value T) *T

ToPtr converts value into a pointer to value

func WebhookFastHTTP added in v1.0.0 

func WebhookFastHTTP(server *fasthttp.Server, path string, secretToken ...string) func(handler WebhookHandler) error

WebhookFastHTTP registers new POST handler for the desired path with optional secret token, replacing the original fasthttp handler for the server

func WebhookHTTPServeMux added in v1.0.0 

func WebhookHTTPServeMux(mux *http.ServeMux, pattern string, secretToken ...string) func(handler WebhookHandler) error

WebhookHTTPServeMux registers new handler for the desired pattern with optional secret token

func WebhookHTTPServer added in v1.0.0 

func WebhookHTTPServer(server *http.Server, path string, secretToken ...string) func(handler WebhookHandler) error

WebhookHTTPServer registers new POST handler for the desired path with optional secret token, replacing the original http handler for the server

Types

type AcceptedGiftTypes added in v1.1.0 

type AcceptedGiftTypes struct {
	// UnlimitedGifts - True, if unlimited regular gifts are accepted
	UnlimitedGifts bool `json:"unlimited_gifts"`

	// LimitedGifts - True, if limited regular gifts are accepted
	LimitedGifts bool `json:"limited_gifts"`

	// UniqueGifts - True, if unique gifts or gifts that can be upgraded to unique for free are accepted
	UniqueGifts bool `json:"unique_gifts"`

	// PremiumSubscription - True, if a Telegram Premium subscription is accepted
	PremiumSubscription bool `json:"premium_subscription"`

	// GiftsFromChannels - True, if transfers of unique gifts from channels are accepted
	GiftsFromChannels bool `json:"gifts_from_channels"`
}

AcceptedGiftTypes - This object describes the types of gifts that can be gifted to a user or a chat.

type AddStickerToSetParams 

type AddStickerToSetParams struct {
	// UserID - User identifier of sticker set owner
	UserID int64 `json:"user_id"`

	// Name - Sticker set name
	Name string `json:"name"`

	// Sticker - 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"`
}

AddStickerToSetParams - Represents parameters of addStickerToSet method.

func (*AddStickerToSetParams) WithName added in v0.10.0 

func (p *AddStickerToSetParams) WithName(name string) *AddStickerToSetParams

WithName adds name parameter

func (*AddStickerToSetParams) WithSticker added in v0.22.0 

func (p *AddStickerToSetParams) WithSticker(sticker InputSticker) *AddStickerToSetParams

WithSticker adds sticker parameter

func (*AddStickerToSetParams) WithUserID added in v1.1.0 

func (p *AddStickerToSetParams) WithUserID(userID int64) *AddStickerToSetParams

WithUserID adds user ID parameter

type AffiliateInfo added in v0.32.0 

type AffiliateInfo struct {
	// AffiliateUser - Optional. The bot or the user that received an affiliate commission if it was received by
	// a bot or a user
	AffiliateUser *User `json:"affiliate_user,omitempty"`

	// AffiliateChat - Optional. The chat that received an affiliate commission if it was received by a chat
	AffiliateChat *Chat `json:"affiliate_chat,omitempty"`

	// CommissionPerMille - The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars
	// received by the bot from referred users
	CommissionPerMille int `json:"commission_per_mille"`

	// Amount - Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0;
	// can be negative for refunds
	Amount int `json:"amount"`

	// NanostarAmount - Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate;
	// from -999999999 to 999999999; can be negative for refunds
	NanostarAmount int `json:"nanostar_amount,omitempty"`
}

AffiliateInfo - Contains information about the affiliate that received a commission via this transaction.

type Animation 

type Animation struct {
	// 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 - 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 - Optional. Original animation 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"`
}

Animation - This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

type AnswerCallbackQueryParams 

type AnswerCallbackQueryParams struct {
	// CallbackQueryID - Unique identifier for the query to be answered
	CallbackQueryID string `json:"callback_query_id"`

	// Text - Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200
	// characters
	Text string `json:"text,omitempty"`

	// ShowAlert - Optional. If True, an alert will be shown by the client instead of a notification at the top
	// of the chat screen. Defaults to false.
	ShowAlert bool `json:"show_alert,omitempty"`

	// URL - Optional. URL that will be opened by the user's client. If you have created a Game
	// (https://core.telegram.org/bots/api#game) and accepted the conditions via @BotFather
	// (https://t.me/botfather), specify the URL that opens your game - note that this will only work if the query
	// comes from a callback_game (https://core.telegram.org/bots/api#inlinekeyboardbutton) button.
	// Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
	URL string `json:"url,omitempty"`

	// CacheTime - Optional. The maximum amount of time in seconds that the result of the callback query may be
	// cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
	CacheTime int `json:"cache_time,omitempty"`
}

AnswerCallbackQueryParams - Represents parameters of answerCallbackQuery method.

func (*AnswerCallbackQueryParams) WithCacheTime added in v0.10.0 

func (p *AnswerCallbackQueryParams) WithCacheTime(cacheTime int) *AnswerCallbackQueryParams

WithCacheTime adds cache time parameter

func (*AnswerCallbackQueryParams) WithCallbackQueryID added in v0.10.0 

func (p *AnswerCallbackQueryParams) WithCallbackQueryID(callbackQueryID string) *AnswerCallbackQueryParams

WithCallbackQueryID adds callback query ID parameter

func (*AnswerCallbackQueryParams) WithShowAlert added in v0.10.0 

func (p *AnswerCallbackQueryParams) WithShowAlert() *AnswerCallbackQueryParams

WithShowAlert adds show alert parameter

func (*AnswerCallbackQueryParams) WithText added in v0.10.0 

func (p *AnswerCallbackQueryParams) WithText(text string) *AnswerCallbackQueryParams

WithText adds text parameter

func (*AnswerCallbackQueryParams) WithURL added in v0.10.0 

func (p *AnswerCallbackQueryParams) WithURL(url string) *AnswerCallbackQueryParams

WithURL adds URL parameter

type AnswerInlineQueryParams 

type AnswerInlineQueryParams struct {
	// InlineQueryID - Unique identifier for the answered query
	InlineQueryID string `json:"inline_query_id"`

	// Results - 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"`
}

AnswerInlineQueryParams - Represents parameters of answerInlineQuery method.

func (*AnswerInlineQueryParams) WithButton added in v0.22.1 

func (p *AnswerInlineQueryParams) WithButton(button *InlineQueryResultsButton) *AnswerInlineQueryParams

WithButton adds button parameter

func (*AnswerInlineQueryParams) WithCacheTime added in v0.10.0 

func (p *AnswerInlineQueryParams) WithCacheTime(cacheTime int) *AnswerInlineQueryParams

WithCacheTime adds cache time parameter

func (*AnswerInlineQueryParams) WithInlineQueryID added in v0.10.0 

func (p *AnswerInlineQueryParams) WithInlineQueryID(inlineQueryID string) *AnswerInlineQueryParams

WithInlineQueryID adds inline query ID parameter

func (*AnswerInlineQueryParams) WithIsPersonal added in v0.10.0 

func (p *AnswerInlineQueryParams) WithIsPersonal() *AnswerInlineQueryParams

WithIsPersonal adds is personal parameter

func (*AnswerInlineQueryParams) WithNextOffset added in v0.10.0 

func (p *AnswerInlineQueryParams) WithNextOffset(nextOffset string) *AnswerInlineQueryParams

WithNextOffset adds next offset parameter

func (*AnswerInlineQueryParams) WithResults added in v0.10.0 

func (p *AnswerInlineQueryParams) WithResults(results ...InlineQueryResult) *AnswerInlineQueryParams

WithResults adds results parameter

type AnswerPreCheckoutQueryParams 

type AnswerPreCheckoutQueryParams struct {
	// PreCheckoutQueryID - Unique identifier for the query to be answered
	PreCheckoutQueryID string `json:"pre_checkout_query_id"`

	// Ok - 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"`
}

AnswerPreCheckoutQueryParams - Represents parameters of answerPreCheckoutQuery method.

func (*AnswerPreCheckoutQueryParams) WithErrorMessage added in v0.10.0 

func (p *AnswerPreCheckoutQueryParams) WithErrorMessage(errorMessage string) *AnswerPreCheckoutQueryParams

WithErrorMessage adds error message parameter

func (*AnswerPreCheckoutQueryParams) WithOk added in v0.10.0 

func (p *AnswerPreCheckoutQueryParams) WithOk() *AnswerPreCheckoutQueryParams

WithOk adds ok parameter

func (*AnswerPreCheckoutQueryParams) WithPreCheckoutQueryID added in v0.10.0 

func (p *AnswerPreCheckoutQueryParams) WithPreCheckoutQueryID(preCheckoutQueryID string) *AnswerPreCheckoutQueryParams

WithPreCheckoutQueryID adds pre checkout query ID parameter

type AnswerShippingQueryParams 

type AnswerShippingQueryParams struct {
	// ShippingQueryID - Unique identifier for the query to be answered
	ShippingQueryID string `json:"shipping_query_id"`

	// Ok - 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 - 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"`
}

AnswerShippingQueryParams - Represents parameters of answerShippingQuery method.

func (*AnswerShippingQueryParams) WithErrorMessage added in v0.10.0 

func (p *AnswerShippingQueryParams) WithErrorMessage(errorMessage string) *AnswerShippingQueryParams

WithErrorMessage adds error message parameter

func (*AnswerShippingQueryParams) WithOk added in v0.10.0 

func (p *AnswerShippingQueryParams) WithOk() *AnswerShippingQueryParams

WithOk adds ok parameter

func (*AnswerShippingQueryParams) WithShippingOptions added in v0.10.0 

func (p *AnswerShippingQueryParams) WithShippingOptions(shippingOptions ...ShippingOption) *AnswerShippingQueryParams

WithShippingOptions adds shipping options parameter

func (*AnswerShippingQueryParams) WithShippingQueryID added in v0.10.0 

func (p *AnswerShippingQueryParams) WithShippingQueryID(shippingQueryID string) *AnswerShippingQueryParams

WithShippingQueryID adds shipping query ID parameter

type AnswerWebAppQueryParams added in v0.11.0 

type AnswerWebAppQueryParams struct {
	// WebAppQueryID - Unique identifier for the query to be answered
	WebAppQueryID string `json:"web_app_query_id"`

	// Result - A JSON-serialized object describing the message to be sent
	Result InlineQueryResult `json:"result"`
}

AnswerWebAppQueryParams - Represents parameters of answerWebAppQuery method.

func (*AnswerWebAppQueryParams) WithResult added in v0.11.0 

func (p *AnswerWebAppQueryParams) WithResult(result InlineQueryResult) *AnswerWebAppQueryParams

WithResult adds result parameter

func (*AnswerWebAppQueryParams) WithWebAppQueryID added in v0.11.0 

func (p *AnswerWebAppQueryParams) WithWebAppQueryID(webAppQueryID string) *AnswerWebAppQueryParams

WithWebAppQueryID adds web app query ID parameter

type ApproveChatJoinRequestParams added in v0.5.0 

type ApproveChatJoinRequestParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

ApproveChatJoinRequestParams - Represents parameters of approveChatJoinRequest method.

func (*ApproveChatJoinRequestParams) WithChatID added in v0.10.0 

func (p *ApproveChatJoinRequestParams) WithChatID(chatID ChatID) *ApproveChatJoinRequestParams

WithChatID adds chat ID parameter

func (*ApproveChatJoinRequestParams) WithUserID added in v1.1.0 

func (p *ApproveChatJoinRequestParams) WithUserID(userID int64) *ApproveChatJoinRequestParams

WithUserID adds user ID parameter

type ApproveSuggestedPostParams added in v1.3.0 

type ApproveSuggestedPostParams struct {
	// ChatID - Unique identifier for the target direct messages chat
	ChatID int64 `json:"chat_id"`

	// MessageID - Identifier of a suggested post message to approve
	MessageID int `json:"message_id"`

	// SendDate - Optional. Point in time (Unix timestamp) when the post is expected to be published; omit if
	// the date has already been specified when the suggested post was created. If specified, then the date must be
	// not more than 2678400 seconds (30 days) in the future
	SendDate int64 `json:"send_date,omitempty"`
}

ApproveSuggestedPostParams - Represents parameters of approveSuggestedPost method.

func (*ApproveSuggestedPostParams) WithChatID added in v1.3.0 

func (p *ApproveSuggestedPostParams) WithChatID(chatID int64) *ApproveSuggestedPostParams

WithChatID adds chat ID parameter

func (*ApproveSuggestedPostParams) WithMessageID added in v1.3.0 

func (p *ApproveSuggestedPostParams) WithMessageID(messageID int) *ApproveSuggestedPostParams

WithMessageID adds message ID parameter

func (*ApproveSuggestedPostParams) WithSendDate added in v1.3.0 

func (p *ApproveSuggestedPostParams) WithSendDate(sendDate int64) *ApproveSuggestedPostParams

WithSendDate adds send date parameter

type Audio 

type Audio struct {
	// 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 - Duration of the audio in seconds as defined by the sender
	Duration int `json:"duration"`

	// 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"`

	// 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"`
}

Audio - This object represents an audio file to be treated as music by the Telegram clients.

type BackgroundFill added in v0.30.1 

type BackgroundFill interface {
	// BackgroundFilled returns BackgroundFill type
	BackgroundFilled() string
	// contains filtered or unexported methods
}

BackgroundFill - This object describes the way a background is filled based on the selected colors. Currently, it can be one of BackgroundFillSolid (https://core.telegram.org/bots/api#backgroundfillsolid) BackgroundFillGradient (https://core.telegram.org/bots/api#backgroundfillgradient) BackgroundFillFreeformGradient (https://core.telegram.org/bots/api#backgroundfillfreeformgradient)

type BackgroundFillFreeformGradient added in v0.30.1 

type BackgroundFillFreeformGradient struct {
	// Type - Type of the background fill, always “freeform_gradient”
	Type string `json:"type"`

	// Colors - A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24
	// format
	Colors []int `json:"colors"`
}

BackgroundFillFreeformGradient - The background is a freeform gradient that rotates after every message in the chat.

func (*BackgroundFillFreeformGradient) BackgroundFilled added in v0.30.1 

func (b *BackgroundFillFreeformGradient) BackgroundFilled() string

BackgroundFilled returns BackgroundFill type

type BackgroundFillGradient added in v0.30.1 

type BackgroundFillGradient struct {
	// Type - Type of the background fill, always “gradient”
	Type string `json:"type"`

	// TopColor - Top color of the gradient in the RGB24 format
	TopColor int `json:"top_color"`

	// BottomColor - Bottom color of the gradient in the RGB24 format
	BottomColor int `json:"bottom_color"`

	// RotationAngle - Clockwise rotation angle of the background fill in degrees; 0-359
	RotationAngle int `json:"rotation_angle"`
}

BackgroundFillGradient - The background is a gradient fill.

func (*BackgroundFillGradient) BackgroundFilled added in v0.30.1 

func (b *BackgroundFillGradient) BackgroundFilled() string

BackgroundFilled returns BackgroundFill type

type BackgroundFillSolid added in v0.30.1 

type BackgroundFillSolid struct {
	// Type - Type of the background fill, always “solid”
	Type string `json:"type"`

	// Color - The color of the background fill in the RGB24 format
	Color int `json:"color"`
}

BackgroundFillSolid - The background is filled using the selected color.

func (*BackgroundFillSolid) BackgroundFilled added in v0.30.1 

func (b *BackgroundFillSolid) BackgroundFilled() string

BackgroundFilled returns BackgroundFill type

type BackgroundType added in v0.30.1 

type BackgroundType interface {
	// BackgroundType returns BackgroundType type
	BackgroundType() string
	// contains filtered or unexported methods
}

BackgroundType - This object describes the type of a background. Currently, it can be one of BackgroundTypeFill (https://core.telegram.org/bots/api#backgroundtypefill) BackgroundTypeWallpaper (https://core.telegram.org/bots/api#backgroundtypewallpaper) BackgroundTypePattern (https://core.telegram.org/bots/api#backgroundtypepattern) BackgroundTypeChatTheme (https://core.telegram.org/bots/api#backgroundtypechattheme)

type BackgroundTypeChatTheme added in v0.30.1 

type BackgroundTypeChatTheme struct {
	// Type - Type of the background, always “chat_theme”
	Type string `json:"type"`

	// ThemeName - Name of the chat theme, which is usually an emoji
	ThemeName string `json:"theme_name"`
}

BackgroundTypeChatTheme - The background is taken directly from a built-in chat theme.

func (*BackgroundTypeChatTheme) BackgroundType added in v0.30.1 

func (b *BackgroundTypeChatTheme) BackgroundType() string

BackgroundType returns BackgroundType type

type BackgroundTypeFill added in v0.30.1 

type BackgroundTypeFill struct {
	// Type - Type of the background, always “fill”
	Type string `json:"type"`

	// Fill - The background fill
	Fill BackgroundFill `json:"fill"`

	// DarkThemeDimming - Dimming of the background in dark themes, as a percentage; 0-100
	DarkThemeDimming int `json:"dark_theme_dimming"`
}

BackgroundTypeFill - The background is automatically filled based on the selected colors.

func (*BackgroundTypeFill) BackgroundType added in v0.30.1 

func (b *BackgroundTypeFill) BackgroundType() string

BackgroundType returns BackgroundType type

func (*BackgroundTypeFill) UnmarshalJSON added in v0.30.1 

func (b *BackgroundTypeFill) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to BackgroundTypeFill

type BackgroundTypePattern added in v0.30.1 

type BackgroundTypePattern struct {
	// Type - Type of the background, always “pattern”
	Type string `json:"type"`

	// Document - Document with the pattern
	Document Document `json:"document"`

	// Fill - The background fill that is combined with the pattern
	Fill BackgroundFill `json:"fill"`

	// Intensity - Intensity of the pattern when it is shown above the filled background; 0-100
	Intensity int `json:"intensity"`

	// IsInverted - Optional. True, if the background fill must be applied only to the pattern itself. All other
	// pixels are black in this case. For dark themes only
	IsInverted bool `json:"is_inverted,omitempty"`

	// IsMoving - Optional. True, if the background moves slightly when the device is tilted
	IsMoving bool `json:"is_moving,omitempty"`
}

BackgroundTypePattern - The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.

func (*BackgroundTypePattern) BackgroundType added in v0.30.1 

func (b *BackgroundTypePattern) BackgroundType() string

BackgroundType returns BackgroundType type

type BackgroundTypeWallpaper added in v0.30.1 

type BackgroundTypeWallpaper struct {
	// Type - Type of the background, always “wallpaper”
	Type string `json:"type"`

	// Document - Document with the wallpaper
	Document Document `json:"document"`

	// DarkThemeDimming - Dimming of the background in dark themes, as a percentage; 0-100
	DarkThemeDimming int `json:"dark_theme_dimming"`

	// IsBlurred - Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then
	// box-blurred with radius 12
	IsBlurred bool `json:"is_blurred,omitempty"`

	// IsMoving - Optional. True, if the background moves slightly when the device is tilted
	IsMoving bool `json:"is_moving,omitempty"`
}

BackgroundTypeWallpaper - The background is a wallpaper in the JPEG format.

func (*BackgroundTypeWallpaper) BackgroundType added in v0.30.1 

func (b *BackgroundTypeWallpaper) BackgroundType() string

BackgroundType returns BackgroundType type

type BanChatMemberParams 

type BanChatMemberParams struct {
	// ChatID - Unique identifier for the target group or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// UntilDate - Optional. Date when the user will be unbanned; Unix time. If user is banned for more than 366
	// days or less than 30 seconds from the current time they are considered to be banned forever. Applied for
	// supergroups and channels only.
	UntilDate int64 `json:"until_date,omitempty"`

	// RevokeMessages - Optional. Pass True to delete all messages from the chat for the user that is being
	// removed. If False, the user will be able to see messages in the group that were sent before the user was
	// removed. Always True for supergroups and channels.
	RevokeMessages bool `json:"revoke_messages,omitempty"`
}

BanChatMemberParams - Represents parameters of banChatMember method.

func (*BanChatMemberParams) WithChatID added in v0.10.0 

func (p *BanChatMemberParams) WithChatID(chatID ChatID) *BanChatMemberParams

WithChatID adds chat ID parameter

func (*BanChatMemberParams) WithRevokeMessages added in v0.10.0 

func (p *BanChatMemberParams) WithRevokeMessages() *BanChatMemberParams

WithRevokeMessages adds revoke messages parameter

func (*BanChatMemberParams) WithUntilDate added in v1.1.0 

func (p *BanChatMemberParams) WithUntilDate(untilDate int64) *BanChatMemberParams

WithUntilDate adds until date parameter

func (*BanChatMemberParams) WithUserID added in v1.1.0 

func (p *BanChatMemberParams) WithUserID(userID int64) *BanChatMemberParams

WithUserID adds user ID parameter

type BanChatSenderChatParams added in v0.7.2 

type BanChatSenderChatParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// SenderChatID - Unique identifier of the target sender chat
	SenderChatID int64 `json:"sender_chat_id"`
}

BanChatSenderChatParams - Represents parameters of banChatSenderChat method.

func (*BanChatSenderChatParams) WithChatID added in v0.10.0 

func (p *BanChatSenderChatParams) WithChatID(chatID ChatID) *BanChatSenderChatParams

WithChatID adds chat ID parameter

func (*BanChatSenderChatParams) WithSenderChatID added in v1.1.0 

func (p *BanChatSenderChatParams) WithSenderChatID(senderChatID int64) *BanChatSenderChatParams

WithSenderChatID adds sender chat ID parameter

type Birthdate added in v0.29.2 

type Birthdate struct {
	// Day - Day of the user's birth; 1-31
	Day int `json:"day"`

	// Month - Month of the user's birth; 1-12
	Month int `json:"month"`

	// Year - Optional. Year of the user's birth
	Year int `json:"year,omitempty"`
}

Birthdate - Describes the birthdate of a user.

type Bot 

type Bot struct {
	// contains filtered or unexported fields
}

Bot represents Telegram bot

func NewBot 

func NewBot(token string, options ...BotOption) (*Bot, error)

NewBot creates new bots with given options (order is important). If no options are specified, default values are used. Note: Default logger (that logs only errors if not configured) will hide your bot token, but it still may log sensitive information, it's only safe to use default logger in testing environment.

func (*Bot) AddStickerToSet 

func (b *Bot) AddStickerToSet(ctx context.Context, params *AddStickerToSetParams) error

AddStickerToSet - Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

func (*Bot) AnswerCallbackQuery 

func (b *Bot) AnswerCallbackQuery(ctx context.Context, params *AnswerCallbackQueryParams) error

AnswerCallbackQuery - Use this method to send answers to callback queries sent from inline keyboards (https://core.telegram.org/bots/features#inline-keyboards). The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather (https://t.me/botfather) and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

func (*Bot) AnswerInlineQuery 

func (b *Bot) AnswerInlineQuery(ctx context.Context, params *AnswerInlineQueryParams) error

AnswerInlineQuery - Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

func (*Bot) AnswerPreCheckoutQuery 

func (b *Bot) AnswerPreCheckoutQuery(ctx context.Context, params *AnswerPreCheckoutQueryParams) error

AnswerPreCheckoutQuery - Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update (https://core.telegram.org/bots/api#update) with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

func (*Bot) AnswerShippingQuery 

func (b *Bot) AnswerShippingQuery(ctx context.Context, params *AnswerShippingQueryParams) error

AnswerShippingQuery - If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update (https://core.telegram.org/bots/api#update) with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

func (*Bot) AnswerWebAppQuery added in v0.11.0 

func (b *Bot) AnswerWebAppQuery(ctx context.Context, params *AnswerWebAppQueryParams) (*SentWebAppMessage, error)

AnswerWebAppQuery - Use this method to set the result of an interaction with a Web App (https://core.telegram.org/bots/webapps) and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage (https://core.telegram.org/bots/api#sentwebappmessage) object is returned.

func (*Bot) ApproveChatJoinRequest added in v0.5.0 

func (b *Bot) ApproveChatJoinRequest(ctx context.Context, params *ApproveChatJoinRequestParams) error

ApproveChatJoinRequest - Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

func (*Bot) ApproveSuggestedPost added in v1.3.0 

func (b *Bot) ApproveSuggestedPost(ctx context.Context, params *ApproveSuggestedPostParams) error

ApproveSuggestedPost - Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.

func (*Bot) BanChatMember 

func (b *Bot) BanChatMember(ctx context.Context, params *BanChatMemberParams) error

BanChatMember - Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned (https://core.telegram.org/bots/api#unbanchatmember) first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) BanChatSenderChat added in v0.7.2 

func (b *Bot) BanChatSenderChat(ctx context.Context, params *BanChatSenderChatParams) error

BanChatSenderChat - Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned (https://core.telegram.org/bots/api#unbanchatsenderchat), the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) Close 

func (b *Bot) Close(ctx context.Context) error

Close - Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

func (*Bot) CloseForumTopic added in v0.17.1 

func (b *Bot) CloseForumTopic(ctx context.Context, params *CloseForumTopicParams) error

CloseForumTopic - Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Bot) CloseGeneralForumTopic added in v0.18.1 

func (b *Bot) CloseGeneralForumTopic(ctx context.Context, params *CloseGeneralForumTopicParams) error

CloseGeneralForumTopic - Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Bot) ConvertGiftToStars added in v1.1.0 

func (b *Bot) ConvertGiftToStars(ctx context.Context, params *ConvertGiftToStarsParams) error

ConvertGiftToStars - Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

func (*Bot) CopyMessage 

func (b *Bot) CopyMessage(ctx context.Context, params *CopyMessageParams) (*MessageID, error)

CopyMessage - Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll (https://core.telegram.org/bots/api#poll) can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage (https://core.telegram.org/bots/api#forwardmessage), but the copied message doesn't have a link to the original message. Returns the MessageID (https://core.telegram.org/bots/api#messageid) of the sent message on success.

func (*Bot) CopyMessages added in v0.29.0 

func (b *Bot) CopyMessages(ctx context.Context, params *CopyMessagesParams) ([]MessageID, error)

CopyMessages - Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll (https://core.telegram.org/bots/api#poll) can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages (https://core.telegram.org/bots/api#forwardmessages), but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageID (https://core.telegram.org/bots/api#messageid) of the sent messages is returned. 

func (b *Bot) CreateChatInviteLink(ctx context.Context, params *CreateChatInviteLinkParams) (*ChatInviteLink, error)

CreateChatInviteLink - Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink (https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object. 

func (b *Bot) CreateChatSubscriptionInviteLink(ctx context.Context, params *CreateChatSubscriptionInviteLinkParams) (*ChatInviteLink, error)

CreateChatSubscriptionInviteLink - Use this method to create a subscription invite link (https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions) for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink (https://core.telegram.org/bots/api#editchatsubscriptioninvitelink) or revoked using the method revokeChatInviteLink (https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as a ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.

func (*Bot) CreateForumTopic added in v0.17.1 

func (b *Bot) CreateForumTopic(ctx context.Context, params *CreateForumTopicParams) (*ForumTopic, error)

CreateForumTopic - Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic (https://core.telegram.org/bots/api#forumtopic) object. 

func (b *Bot) CreateInvoiceLink(ctx context.Context, params *CreateInvoiceLinkParams) (*string, error)

CreateInvoiceLink - Use this method to create a link for an invoice. Returns the created invoice link as String on success.

func (*Bot) CreateNewStickerSet 

func (b *Bot) CreateNewStickerSet(ctx context.Context, params *CreateNewStickerSetParams) error

CreateNewStickerSet - Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

func (*Bot) DeclineChatJoinRequest added in v0.5.0 

func (b *Bot) DeclineChatJoinRequest(ctx context.Context, params *DeclineChatJoinRequestParams) error

DeclineChatJoinRequest - Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

func (*Bot) DeclineSuggestedPost added in v1.3.0 

func (b *Bot) DeclineSuggestedPost(ctx context.Context, params *DeclineSuggestedPostParams) error

DeclineSuggestedPost - Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.

func (*Bot) DeleteBusinessMessages added in v1.1.0 

func (b *Bot) DeleteBusinessMessages(ctx context.Context, params *DeleteBusinessMessagesParams) error

DeleteBusinessMessages - Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.

func (*Bot) DeleteChatPhoto 

func (b *Bot) DeleteChatPhoto(ctx context.Context, params *DeleteChatPhotoParams) error

DeleteChatPhoto - Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) DeleteChatStickerSet 

func (b *Bot) DeleteChatStickerSet(ctx context.Context, params *DeleteChatStickerSetParams) error

DeleteChatStickerSet - Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat (https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns True on success.

func (*Bot) DeleteForumTopic added in v0.17.1 

func (b *Bot) DeleteForumTopic(ctx context.Context, params *DeleteForumTopicParams) error

DeleteForumTopic - Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

func (*Bot) DeleteMessage 

func (b *Bot) DeleteMessage(ctx context.Context, params *DeleteMessageParams) error

DeleteMessage - Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there. - If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns True on success.

func (*Bot) DeleteMessages added in v0.29.0 

func (b *Bot) DeleteMessages(ctx context.Context, params *DeleteMessagesParams) error

DeleteMessages - Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

func (*Bot) DeleteMyCommands 

func (b *Bot) DeleteMyCommands(ctx context.Context, params *DeleteMyCommandsParams) error

DeleteMyCommands - Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands (https://core.telegram.org/bots/api#determining-list-of-commands) will be shown to affected users. Returns True on success.

func (*Bot) DeleteStickerFromSet 

func (b *Bot) DeleteStickerFromSet(ctx context.Context, params *DeleteStickerFromSetParams) error

DeleteStickerFromSet - Use this method to delete a sticker from a set created by the bot. Returns True on success.

func (*Bot) DeleteStickerSet added in v0.22.0 

func (b *Bot) DeleteStickerSet(ctx context.Context, params *DeleteStickerSetParams) error

DeleteStickerSet - Use this method to delete a sticker set that was created by the bot. Returns True on success.

func (*Bot) DeleteStory added in v1.1.0 

func (b *Bot) DeleteStory(ctx context.Context, params *DeleteStoryParams) error

DeleteStory - Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.

func (*Bot) DeleteWebhook 

func (b *Bot) DeleteWebhook(ctx context.Context, params *DeleteWebhookParams) error

DeleteWebhook - Use this method to remove webhook integration if you decide to switch back to getUpdates (https://core.telegram.org/bots/api#getupdates). Returns True on success. 

func (b *Bot) EditChatInviteLink(ctx context.Context, params *EditChatInviteLinkParams) (*ChatInviteLink, error)

EditChatInviteLink - Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object. 

func (b *Bot) EditChatSubscriptionInviteLink(ctx context.Context, params *EditChatSubscriptionInviteLinkParams) (*ChatInviteLink, error)

EditChatSubscriptionInviteLink - Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.

func (*Bot) EditForumTopic added in v0.17.1 

func (b *Bot) EditForumTopic(ctx context.Context, params *EditForumTopicParams) error

EditForumTopic - Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Bot) EditGeneralForumTopic added in v0.18.1 

func (b *Bot) EditGeneralForumTopic(ctx context.Context, params *EditGeneralForumTopicParams) error

EditGeneralForumTopic - Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Bot) EditMessageCaption 

func (b *Bot) EditMessageCaption(ctx context.Context, params *EditMessageCaptionParams) (*Message, error)

EditMessageCaption - Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Bot) EditMessageChecklist added in v1.2.0 

func (b *Bot) EditMessageChecklist(ctx context.Context, params *EditMessageChecklistParams) (*Message, error)

EditMessageChecklist - Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) EditMessageLiveLocation 

func (b *Bot) EditMessageLiveLocation(ctx context.Context, params *EditMessageLiveLocationParams) (*Message, error)

EditMessageLiveLocation - Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation (https://core.telegram.org/bots/api#stopmessagelivelocation). On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.

func (*Bot) EditMessageMedia 

func (b *Bot) EditMessageMedia(ctx context.Context, params *EditMessageMediaParams) (*Message, error)

EditMessageMedia - Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Bot) EditMessageReplyMarkup 

func (b *Bot) EditMessageReplyMarkup(ctx context.Context, params *EditMessageReplyMarkupParams) (*Message, error)

EditMessageReplyMarkup - Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Bot) EditMessageText 

func (b *Bot) EditMessageText(ctx context.Context, params *EditMessageTextParams) (*Message, error)

EditMessageText - Use this method to edit text and game (https://core.telegram.org/bots/api#games) messages. On success, if the edited message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

func (*Bot) EditStory added in v1.1.0 

func (b *Bot) EditStory(ctx context.Context, params *EditStoryParams) (*Story, error)

EditStory - Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story (https://core.telegram.org/bots/api#story) on success.

func (*Bot) EditUserStarSubscription added in v0.32.0 

func (b *Bot) EditUserStarSubscription(ctx context.Context, params *EditUserStarSubscriptionParams) error

EditUserStarSubscription - Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success. 

func (b *Bot) ExportChatInviteLink(ctx context.Context, params *ExportChatInviteLinkParams) (*string, error)

ExportChatInviteLink - Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

func (*Bot) FileDownloadURL added in v0.22.1 

func (b *Bot) FileDownloadURL(filepath string) string

FileDownloadURL returns URL that can be used to download a file by its file path retrieved from Bot.GetFile method

func (*Bot) ForwardMessage 

func (b *Bot) ForwardMessage(ctx context.Context, params *ForwardMessageParams) (*Message, error)

ForwardMessage - Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) ForwardMessages added in v0.29.0 

func (b *Bot) ForwardMessages(ctx context.Context, params *ForwardMessagesParams) ([]MessageID, error)

ForwardMessages - Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageID (https://core.telegram.org/bots/api#messageid) of the sent messages is returned.

func (*Bot) GetAvailableGifts added in v0.32.0 

func (b *Bot) GetAvailableGifts(ctx context.Context) (*Gifts, error)

GetAvailableGifts - Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts (https://core.telegram.org/bots/api#gifts) object.

func (*Bot) GetBusinessAccountGifts added in v1.1.0 

func (b *Bot) GetBusinessAccountGifts(ctx context.Context, params *GetBusinessAccountGiftsParams) (*OwnedGifts, error)

GetBusinessAccountGifts - Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts (https://core.telegram.org/bots/api#ownedgifts) on success.

func (*Bot) GetBusinessAccountStarBalance added in v1.1.0 

func (b *Bot) GetBusinessAccountStarBalance(ctx context.Context, params *GetBusinessAccountStarBalanceParams) (*StarAmount, error)

GetBusinessAccountStarBalance - Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount (https://core.telegram.org/bots/api#staramount) on success.

func (*Bot) GetBusinessConnection added in v0.29.2 

func (b *Bot) GetBusinessConnection(ctx context.Context, params *GetBusinessConnectionParams) (*BusinessConnection, error)

GetBusinessConnection - Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection (https://core.telegram.org/bots/api#businessconnection) object on success.

func (*Bot) GetChat 

func (b *Bot) GetChat(ctx context.Context, params *GetChatParams) (*ChatFullInfo, error)

GetChat - Use this method to get up-to-date information about the chat. Returns a ChatFullInfo (https://core.telegram.org/bots/api#chatfullinfo) object on success.

func (*Bot) GetChatAdministrators 

func (b *Bot) GetChatAdministrators(ctx context.Context, params *GetChatAdministratorsParams) ([]ChatMember, error)

GetChatAdministrators - Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember (https://core.telegram.org/bots/api#chatmember) objects.

func (*Bot) GetChatGifts added in v1.4.0 

func (b *Bot) GetChatGifts(ctx context.Context, params *GetChatGiftsParams) (*OwnedGifts, error)

GetChatGifts - Returns the gifts owned by a chat. Returns OwnedGifts (https://core.telegram.org/bots/api#ownedgifts) on success.

func (*Bot) GetChatMember 

func (b *Bot) GetChatMember(ctx context.Context, params *GetChatMemberParams) (ChatMember, error)

GetChatMember - Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember (https://core.telegram.org/bots/api#chatmember) object on success.

func (*Bot) GetChatMemberCount 

func (b *Bot) GetChatMemberCount(ctx context.Context, params *GetChatMemberCountParams) (*int, error)

GetChatMemberCount - Use this method to get the number of members in a chat. Returns Int on success.

func (*Bot) GetChatMenuButton added in v0.11.0 

func (b *Bot) GetChatMenuButton(ctx context.Context, params *GetChatMenuButtonParams) (MenuButton, error)

GetChatMenuButton - Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton (https://core.telegram.org/bots/api#menubutton) on success.

func (*Bot) GetCustomEmojiStickers added in v0.16.0 

func (b *Bot) GetCustomEmojiStickers(ctx context.Context, params *GetCustomEmojiStickersParams) ([]Sticker, error)

GetCustomEmojiStickers - Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker (https://core.telegram.org/bots/api#sticker) objects.

func (*Bot) GetFile 

func (b *Bot) GetFile(ctx context.Context, params *GetFileParams) (*File, error)

GetFile - Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File (https://core.telegram.org/bots/api#file) object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile (https://core.telegram.org/bots/api#getfile) again.

func (*Bot) GetForumTopicIconStickers added in v0.17.1 

func (b *Bot) GetForumTopicIconStickers(ctx context.Context) ([]Sticker, error)

GetForumTopicIconStickers - Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker (https://core.telegram.org/bots/api#sticker) objects.

func (*Bot) GetGameHighScores 

func (b *Bot) GetGameHighScores(ctx context.Context, params *GetGameHighScoresParams) ([]GameHighScore, error)

GetGameHighScores - Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore (https://core.telegram.org/bots/api#gamehighscore) objects. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

func (*Bot) GetMe 

func (b *Bot) GetMe(ctx context.Context) (*User, error)

GetMe - A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User (https://core.telegram.org/bots/api#user) object.

func (*Bot) GetMyCommands 

func (b *Bot) GetMyCommands(ctx context.Context, params *GetMyCommandsParams) ([]BotCommand, error)

GetMyCommands - Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand (https://core.telegram.org/bots/api#botcommand) objects. If commands aren't set, an empty list is returned.

func (*Bot) GetMyDefaultAdministratorRights added in v0.11.0 

func (b *Bot) GetMyDefaultAdministratorRights(ctx context.Context, params *GetMyDefaultAdministratorRightsParams) (*ChatAdministratorRights, error)

GetMyDefaultAdministratorRights - Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights (https://core.telegram.org/bots/api#chatadministratorrights) on success.

func (*Bot) GetMyDescription added in v0.22.0 

func (b *Bot) GetMyDescription(ctx context.Context, params *GetMyDescriptionParams) (*BotDescription, error)

GetMyDescription - Use this method to get the current bot description for the given user language. Returns BotDescription (https://core.telegram.org/bots/api#botdescription) on success.

func (*Bot) GetMyName added in v0.22.1 

func (b *Bot) GetMyName(ctx context.Context, params *GetMyNameParams) (*BotName, error)

GetMyName - Use this method to get the current bot name for the given user language. Returns BotName (https://core.telegram.org/bots/api#botname) on success.

func (*Bot) GetMyShortDescription added in v0.22.0 

func (b *Bot) GetMyShortDescription(ctx context.Context, params *GetMyShortDescriptionParams) (*BotShortDescription, error)

GetMyShortDescription - Use this method to get the current bot short description for the given user language. Returns BotShortDescription (https://core.telegram.org/bots/api#botshortdescription) on success.

func (*Bot) GetMyStarBalance added in v1.2.0 

func (b *Bot) GetMyStarBalance(ctx context.Context) (*StarAmount, error)

GetMyStarBalance - A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount (https://core.telegram.org/bots/api#staramount) object.

func (*Bot) GetStarTransactions added in v0.31.0 

func (b *Bot) GetStarTransactions(ctx context.Context, params *GetStarTransactionsParams) (*StarTransactions, error)

GetStarTransactions - Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions (https://core.telegram.org/bots/api#startransactions) object.

func (*Bot) GetStickerSet 

func (b *Bot) GetStickerSet(ctx context.Context, params *GetStickerSetParams) (*StickerSet, error)

GetStickerSet - Use this method to get a sticker set. On success, a StickerSet (https://core.telegram.org/bots/api#stickerset) object is returned.

func (*Bot) GetUpdates 

func (b *Bot) GetUpdates(ctx context.Context, params *GetUpdatesParams) ([]Update, error)

GetUpdates - Use this method to receive incoming updates using long polling (wiki (https://en.wikipedia.org/wiki/Push_technology#Long_polling)). Returns an Array of Update (https://core.telegram.org/bots/api#update) objects.

func (*Bot) GetUserChatBoosts added in v0.29.0 

func (b *Bot) GetUserChatBoosts(ctx context.Context, params *GetUserChatBoostsParams) (*UserChatBoosts, error)

GetUserChatBoosts - Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts (https://core.telegram.org/bots/api#userchatboosts) object.

func (*Bot) GetUserGifts added in v1.4.0 

func (b *Bot) GetUserGifts(ctx context.Context, params *GetUserGiftsParams) (*OwnedGifts, error)

GetUserGifts - Returns the gifts owned and hosted by a user. Returns OwnedGifts (https://core.telegram.org/bots/api#ownedgifts) on success.

func (*Bot) GetUserProfilePhotos 

func (b *Bot) GetUserProfilePhotos(ctx context.Context, params *GetUserProfilePhotosParams) (*UserProfilePhotos, error)

GetUserProfilePhotos - Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos (https://core.telegram.org/bots/api#userprofilephotos) object.

func (*Bot) GetWebhookInfo 

func (b *Bot) GetWebhookInfo(ctx context.Context) (*WebhookInfo, error)

GetWebhookInfo - Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo (https://core.telegram.org/bots/api#webhookinfo) object. If the bot is using getUpdates (https://core.telegram.org/bots/api#getupdates), will return an object with the URL field empty.

func (*Bot) GiftPremiumSubscription added in v1.1.0 

func (b *Bot) GiftPremiumSubscription(ctx context.Context, params *GiftPremiumSubscriptionParams) error

GiftPremiumSubscription - Gifts a Telegram Premium subscription to the given user. Returns True on success.

func (*Bot) HideGeneralForumTopic added in v0.18.1 

func (b *Bot) HideGeneralForumTopic(ctx context.Context, params *HideGeneralForumTopicParams) error

HideGeneralForumTopic - Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

func (*Bot) ID added in v1.0.0 

func (b *Bot) ID() int64

ID returns bot ID by calling Bot.GetMe method once, if error occurs ID will be 0

func (*Bot) LeaveChat 

func (b *Bot) LeaveChat(ctx context.Context, params *LeaveChatParams) error

LeaveChat - Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

func (*Bot) LogOut 

func (b *Bot) LogOut(ctx context.Context) error

LogOut - Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

func (*Bot) Logger added in v0.20.0 

func (b *Bot) Logger() Logger

Logger returns bot logger

func (*Bot) PinChatMessage 

func (b *Bot) PinChatMessage(ctx context.Context, params *PinChatMessageParams) error

PinChatMessage - Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.

func (*Bot) PostStory added in v1.1.0 

func (b *Bot) PostStory(ctx context.Context, params *PostStoryParams) (*Story, error)

PostStory - Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story (https://core.telegram.org/bots/api#story) on success.

func (*Bot) PromoteChatMember 

func (b *Bot) PromoteChatMember(ctx context.Context, params *PromoteChatMemberParams) error

PromoteChatMember - Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

func (*Bot) ReadBusinessMessage added in v1.1.0 

func (b *Bot) ReadBusinessMessage(ctx context.Context, params *ReadBusinessMessageParams) error

ReadBusinessMessage - Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

func (*Bot) RefundStarPayment added in v0.30.2 

func (b *Bot) RefundStarPayment(ctx context.Context, params *RefundStarPaymentParams) error

RefundStarPayment - Refunds a successful payment in Telegram Stars (https://t.me/BotNews/90). Returns True on success.

func (*Bot) RemoveBusinessAccountProfilePhoto added in v1.1.0 

func (b *Bot) RemoveBusinessAccountProfilePhoto(ctx context.Context, params *RemoveBusinessAccountProfilePhotoParams) error

RemoveBusinessAccountProfilePhoto - Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func (*Bot) RemoveChatVerification added in v0.32.0 

func (b *Bot) RemoveChatVerification(ctx context.Context, params *RemoveChatVerificationParams) error

RemoveChatVerification - Removes verification from a chat that is currently verified on behalf of the organization (https://telegram.org/verify#third-party-verification) represented by the bot. Returns True on success.

func (*Bot) RemoveUserVerification added in v0.32.0 

func (b *Bot) RemoveUserVerification(ctx context.Context, params *RemoveUserVerificationParams) error

RemoveUserVerification - Removes verification from a user who is currently verified on behalf of the organization (https://telegram.org/verify#third-party-verification) represented by the bot. Returns True on success.

func (*Bot) ReopenForumTopic added in v0.17.1 

func (b *Bot) ReopenForumTopic(ctx context.Context, params *ReopenForumTopicParams) error

ReopenForumTopic - Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

func (*Bot) ReopenGeneralForumTopic added in v0.18.1 

func (b *Bot) ReopenGeneralForumTopic(ctx context.Context, params *ReopenGeneralForumTopicParams) error

ReopenGeneralForumTopic - Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

func (*Bot) ReplaceStickerInSet added in v0.29.2 

func (b *Bot) ReplaceStickerInSet(ctx context.Context, params *ReplaceStickerInSetParams) error

ReplaceStickerInSet - Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet (https://core.telegram.org/bots/api#deletestickerfromset), then addStickerToSet (https://core.telegram.org/bots/api#addstickertoset), then setStickerPositionInSet (https://core.telegram.org/bots/api#setstickerpositioninset). Returns True on success.

func (*Bot) RepostStory added in v1.4.0 

func (b *Bot) RepostStory(ctx context.Context, params *RepostStoryParams) (*Story, error)

RepostStory - Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story (https://core.telegram.org/bots/api#story) on success.

func (*Bot) RestrictChatMember 

func (b *Bot) RestrictChatMember(ctx context.Context, params *RestrictChatMemberParams) error

RestrictChatMember - Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success. 

func (b *Bot) RevokeChatInviteLink(ctx context.Context, params *RevokeChatInviteLinkParams) (*ChatInviteLink, error)

RevokeChatInviteLink - Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink (https://core.telegram.org/bots/api#chatinvitelink) object.

func (*Bot) SavePreparedInlineMessage added in v0.32.0 

func (b *Bot) SavePreparedInlineMessage(ctx context.Context, params *SavePreparedInlineMessageParams) (*PreparedInlineMessage, error)

SavePreparedInlineMessage - Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage (https://core.telegram.org/bots/api#preparedinlinemessage) object.

func (*Bot) SecretToken added in v1.0.1 

func (b *Bot) SecretToken() string

SecretToken returns a secret token that is HEX encoded SHA-256 hash of your bot's token (this is useful for webhooks as using bot's token directly is a security risk and will not work as it contains forbidden symbols)

func (*Bot) SendAnimation 

func (b *Bot) SendAnimation(ctx context.Context, params *SendAnimationParams) (*Message, error)

SendAnimation - Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

func (*Bot) SendAudio 

func (b *Bot) SendAudio(ctx context.Context, params *SendAudioParams) (*Message, error)

SendAudio - Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice (https://core.telegram.org/bots/api#sendvoice) method instead.

func (*Bot) SendChatAction 

func (b *Bot) SendChatAction(ctx context.Context, params *SendChatActionParams) error

SendChatAction - Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. Example: The ImageBot (https://t.me/imagebot) needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction (https://core.telegram.org/bots/api#sendchataction) with action = upload_photo. The user will see a “sending photo” status for the bot. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

func (*Bot) SendChecklist added in v1.2.0 

func (b *Bot) SendChecklist(ctx context.Context, params *SendChecklistParams) (*Message, error)

SendChecklist - Use this method to send a checklist on behalf of a connected business account. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendContact 

func (b *Bot) SendContact(ctx context.Context, params *SendContactParams) (*Message, error)

SendContact - Use this method to send phone contacts. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendDice 

func (b *Bot) SendDice(ctx context.Context, params *SendDiceParams) (*Message, error)

SendDice - Use this method to send an animated emoji that will display a random value. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendDocument 

func (b *Bot) SendDocument(ctx context.Context, params *SendDocumentParams) (*Message, error)

SendDocument - Use this method to send general files. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

func (*Bot) SendGame 

func (b *Bot) SendGame(ctx context.Context, params *SendGameParams) (*Message, error)

SendGame - Use this method to send a game. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendGift added in v0.32.0 

func (b *Bot) SendGift(ctx context.Context, params *SendGiftParams) error

SendGift - Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.

func (*Bot) SendInvoice 

func (b *Bot) SendInvoice(ctx context.Context, params *SendInvoiceParams) (*Message, error)

SendInvoice - Use this method to send invoices. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendLocation 

func (b *Bot) SendLocation(ctx context.Context, params *SendLocationParams) (*Message, error)

SendLocation - Use this method to send point on the map. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendMediaGroup 

func (b *Bot) SendMediaGroup(ctx context.Context, params *SendMediaGroupParams) ([]Message, error)

SendMediaGroup - Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message (https://core.telegram.org/bots/api#message) objects that were sent is returned.

func (*Bot) SendMessage 

func (b *Bot) SendMessage(ctx context.Context, params *SendMessageParams) (*Message, error)

SendMessage - Use this method to send text messages. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendMessageDraft added in v1.4.0 

func (b *Bot) SendMessageDraft(ctx context.Context, params *SendMessageDraftParams) error

SendMessageDraft - Use this method to stream a partial message to a user while the message is being generated; supported only for bots with forum topic mode enabled. Returns True on success.

func (*Bot) SendPaidMedia added in v0.31.0 

func (b *Bot) SendPaidMedia(ctx context.Context, params *SendPaidMediaParams) (*Message, error)

SendPaidMedia - Use this method to send paid media. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendPhoto 

func (b *Bot) SendPhoto(ctx context.Context, params *SendPhotoParams) (*Message, error)

SendPhoto - Use this method to send photos. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendPoll 

func (b *Bot) SendPoll(ctx context.Context, params *SendPollParams) (*Message, error)

SendPoll - Use this method to send a native poll. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendSticker 

func (b *Bot) SendSticker(ctx context.Context, params *SendStickerParams) (*Message, error)

SendSticker - Use this method to send static .WEBP, animated (https://telegram.org/blog/animated-stickers) .TGS, or video (https://telegram.org/blog/video-stickers-better-reactions) .WEBM stickers. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendVenue 

func (b *Bot) SendVenue(ctx context.Context, params *SendVenueParams) (*Message, error)

SendVenue - Use this method to send information about a venue. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendVideo 

func (b *Bot) SendVideo(ctx context.Context, params *SendVideoParams) (*Message, error)

SendVideo - Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document (https://core.telegram.org/bots/api#document)). On success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

func (*Bot) SendVideoNote 

func (b *Bot) SendVideoNote(ctx context.Context, params *SendVideoNoteParams) (*Message, error)

SendVideoNote - As of v.4.0 (https://telegram.org/blog/video-messages-and-telescope), Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message (https://core.telegram.org/bots/api#message) is returned.

func (*Bot) SendVoice 

func (b *Bot) SendVoice(ctx context.Context, params *SendVoiceParams) (*Message, error)

SendVoice - Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio (https://core.telegram.org/bots/api#audio) or Document (https://core.telegram.org/bots/api#document)). On success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

func (*Bot) SetBusinessAccountBio added in v1.1.0 

func (b *Bot) SetBusinessAccountBio(ctx context.Context, params *SetBusinessAccountBioParams) error

SetBusinessAccountBio - Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

func (*Bot) SetBusinessAccountGiftSettings added in v1.1.0 

func (b *Bot) SetBusinessAccountGiftSettings(ctx context.Context, params *SetBusinessAccountGiftSettingsParams) error

SetBusinessAccountGiftSettings - Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

func (*Bot) SetBusinessAccountName added in v1.1.0 

func (b *Bot) SetBusinessAccountName(ctx context.Context, params *SetBusinessAccountNameParams) error

SetBusinessAccountName - Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

func (*Bot) SetBusinessAccountProfilePhoto added in v1.1.0 

func (b *Bot) SetBusinessAccountProfilePhoto(ctx context.Context, params *SetBusinessAccountProfilePhotoParams) error

SetBusinessAccountProfilePhoto - Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

func (*Bot) SetBusinessAccountUsername added in v1.1.0 

func (b *Bot) SetBusinessAccountUsername(ctx context.Context, params *SetBusinessAccountUsernameParams) error

SetBusinessAccountUsername - Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

func (*Bot) SetChatAdministratorCustomTitle 

func (b *Bot) SetChatAdministratorCustomTitle(ctx context.Context, params *SetChatAdministratorCustomTitleParams) error

SetChatAdministratorCustomTitle - Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

func (*Bot) SetChatDescription 

func (b *Bot) SetChatDescription(ctx context.Context, params *SetChatDescriptionParams) error

SetChatDescription - Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) SetChatMenuButton added in v0.11.0 

func (b *Bot) SetChatMenuButton(ctx context.Context, params *SetChatMenuButtonParams) error

SetChatMenuButton - Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

func (*Bot) SetChatPermissions 

func (b *Bot) SetChatPermissions(ctx context.Context, params *SetChatPermissionsParams) error

SetChatPermissions - Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

func (*Bot) SetChatPhoto 

func (b *Bot) SetChatPhoto(ctx context.Context, params *SetChatPhotoParams) error

SetChatPhoto - Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) SetChatStickerSet 

func (b *Bot) SetChatStickerSet(ctx context.Context, params *SetChatStickerSetParams) error

SetChatStickerSet - Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat (https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns True on success.

func (*Bot) SetChatTitle 

func (b *Bot) SetChatTitle(ctx context.Context, params *SetChatTitleParams) error

SetChatTitle - Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) SetCustomEmojiStickerSetThumbnail added in v0.22.0 

func (b *Bot) SetCustomEmojiStickerSetThumbnail(ctx context.Context, params *SetCustomEmojiStickerSetThumbnailParams) error

SetCustomEmojiStickerSetThumbnail - Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

func (*Bot) SetGameScore 

func (b *Bot) SetGameScore(ctx context.Context, params *SetGameScoreParams) (*Message, error)

SetGameScore - Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

func (*Bot) SetMessageReaction added in v0.29.0 

func (b *Bot) SetMessageReaction(ctx context.Context, params *SetMessageReactionParams) error

SetMessageReaction - Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.

func (*Bot) SetMyCommands 

func (b *Bot) SetMyCommands(ctx context.Context, params *SetMyCommandsParams) error

SetMyCommands - Use this method to change the list of the bot's commands. See this manual (https://core.telegram.org/bots/features#commands) for more details about bot commands. Returns True on success.

func (*Bot) SetMyDefaultAdministratorRights added in v0.11.0 

func (b *Bot) SetMyDefaultAdministratorRights(ctx context.Context, params *SetMyDefaultAdministratorRightsParams) error

SetMyDefaultAdministratorRights - Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

func (*Bot) SetMyDescription added in v0.22.0 

func (b *Bot) SetMyDescription(ctx context.Context, params *SetMyDescriptionParams) error

SetMyDescription - Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

func (*Bot) SetMyName added in v0.22.1 

func (b *Bot) SetMyName(ctx context.Context, params *SetMyNameParams) error

SetMyName - Use this method to change the bot's name. Returns True on success.

func (*Bot) SetMyShortDescription added in v0.22.0 

func (b *Bot) SetMyShortDescription(ctx context.Context, params *SetMyShortDescriptionParams) error

SetMyShortDescription - Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.

func (*Bot) SetPassportDataErrors 

func (b *Bot) SetPassportDataErrors(ctx context.Context, params *SetPassportDataErrorsParams) error

SetPassportDataErrors - Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

func (*Bot) SetStickerEmojiList added in v0.22.0 

func (b *Bot) SetStickerEmojiList(ctx context.Context, params *SetStickerEmojiListParams) error

SetStickerEmojiList - Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

func (*Bot) SetStickerKeywords added in v0.22.0 

func (b *Bot) SetStickerKeywords(ctx context.Context, params *SetStickerKeywordsParams) error

SetStickerKeywords - Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

func (*Bot) SetStickerMaskPosition added in v0.22.0 

func (b *Bot) SetStickerMaskPosition(ctx context.Context, params *SetStickerMaskPositionParams) error

SetStickerMaskPosition - Use this method to change the mask position (https://core.telegram.org/bots/api#maskposition) of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

func (*Bot) SetStickerPositionInSet 

func (b *Bot) SetStickerPositionInSet(ctx context.Context, params *SetStickerPositionInSetParams) error

SetStickerPositionInSet - Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

func (*Bot) SetStickerSetThumbnail added in v0.22.0 

func (b *Bot) SetStickerSetThumbnail(ctx context.Context, params *SetStickerSetThumbnailParams) error

SetStickerSetThumbnail - Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

func (*Bot) SetStickerSetTitle added in v0.22.0 

func (b *Bot) SetStickerSetTitle(ctx context.Context, params *SetStickerSetTitleParams) error

SetStickerSetTitle - Use this method to set the title of a created sticker set. Returns True on success.

func (*Bot) SetUserEmojiStatus added in v0.32.0 

func (b *Bot) SetUserEmojiStatus(ctx context.Context, params *SetUserEmojiStatusParams) error

SetUserEmojiStatus - Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess (https://core.telegram.org/bots/webapps#initializing-mini-apps). Returns True on success.

func (*Bot) SetWebhook 

func (b *Bot) SetWebhook(ctx context.Context, params *SetWebhookParams) error

SetWebhook - Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update (https://core.telegram.org/bots/api#update). In case of an unsuccessful request (a request with response HTTP status code (https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

func (*Bot) StopMessageLiveLocation 

func (b *Bot) StopMessageLiveLocation(ctx context.Context, params *StopMessageLiveLocationParams) (*Message, error)

StopMessageLiveLocation - Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message (https://core.telegram.org/bots/api#message) is returned, otherwise True is returned.

func (*Bot) StopPoll 

func (b *Bot) StopPoll(ctx context.Context, params *StopPollParams) (*Poll, error)

StopPoll - Use this method to stop a poll which was sent by the bot. On success, the stopped Poll (https://core.telegram.org/bots/api#poll) is returned.

func (*Bot) Token 

func (b *Bot) Token() string

Token returns bot token

func (*Bot) TransferBusinessAccountStars added in v1.1.0 

func (b *Bot) TransferBusinessAccountStars(ctx context.Context, params *TransferBusinessAccountStarsParams) error

TransferBusinessAccountStars - Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

func (*Bot) TransferGift added in v1.1.0 

func (b *Bot) TransferGift(ctx context.Context, params *TransferGiftParams) error

TransferGift - Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.

func (*Bot) UnbanChatMember 

func (b *Bot) UnbanChatMember(ctx context.Context, params *UnbanChatMemberParams) error

UnbanChatMember - Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

func (*Bot) UnbanChatSenderChat added in v0.7.2 

func (b *Bot) UnbanChatSenderChat(ctx context.Context, params *UnbanChatSenderChatParams) error

UnbanChatSenderChat - Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

func (*Bot) UnhideGeneralForumTopic added in v0.18.1 

func (b *Bot) UnhideGeneralForumTopic(ctx context.Context, params *UnhideGeneralForumTopicParams) error

UnhideGeneralForumTopic - Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

func (*Bot) UnpinAllChatMessages 

func (b *Bot) UnpinAllChatMessages(ctx context.Context, params *UnpinAllChatMessagesParams) error

UnpinAllChatMessages - Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.

func (*Bot) UnpinAllForumTopicMessages added in v0.17.1 

func (b *Bot) UnpinAllForumTopicMessages(ctx context.Context, params *UnpinAllForumTopicMessagesParams) error

UnpinAllForumTopicMessages - Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

func (*Bot) UnpinAllGeneralForumTopicMessages added in v0.26.1 

func (b *Bot) UnpinAllGeneralForumTopicMessages(ctx context.Context, params *UnpinAllGeneralForumTopicMessagesParams) error

UnpinAllGeneralForumTopicMessages - Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

func (*Bot) UnpinChatMessage 

func (b *Bot) UnpinChatMessage(ctx context.Context, params *UnpinChatMessageParams) error

UnpinChatMessage - Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.

func (*Bot) UpdatesViaLongPolling added in v0.19.0 

func (b *Bot) UpdatesViaLongPolling(
	ctx context.Context, params *GetUpdatesParams, options ...LongPollingOption,
) (<-chan Update, error)

UpdatesViaLongPolling receive updates in chan using the Bot.GetUpdates method. Calling if already running long polling or webhook will return an error.

Warning: If nil is passed as get update parameters, then the default timeout of 8s will be applied, but if a non-nil parameter is passed, you should remember to explicitly specify timeout

Note: After you done with getting updates, you should close context this will close the update chan Note: Value of params is reused to call Bot.GetUpdates method many times, because of this we copy params value

func (*Bot) UpdatesViaWebhook added in v0.9.1 

func (b *Bot) UpdatesViaWebhook(
	ctx context.Context, registerHandler func(handler WebhookHandler) error, options ...WebhookOption,
) (<-chan Update, error)

UpdatesViaWebhook receive updates in chan from webhook. A new handler will be registered on server. Calling if already running webhook or long polling will return an error.

func (*Bot) UpgradeGift added in v1.1.0 

func (b *Bot) UpgradeGift(ctx context.Context, params *UpgradeGiftParams) error

UpgradeGift - Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

func (*Bot) UploadStickerFile 

func (b *Bot) UploadStickerFile(ctx context.Context, params *UploadStickerFileParams) (*File, error)

UploadStickerFile - Use this method to upload a file with a sticker for later use in the createNewStickerSet (https://core.telegram.org/bots/api#createnewstickerset), addStickerToSet (https://core.telegram.org/bots/api#addstickertoset), or replaceStickerInSet (https://core.telegram.org/bots/api#replacestickerinset) methods (the file can be used multiple times). Returns the uploaded File (https://core.telegram.org/bots/api#file) on success.

func (*Bot) Username added in v1.0.0 

func (b *Bot) Username() string

Username returns bot username by calling Bot.GetMe method once, if error occurs username will be empty

func (*Bot) VerifyChat added in v0.32.0 

func (b *Bot) VerifyChat(ctx context.Context, params *VerifyChatParams) error

VerifyChat - Verifies a chat on behalf of the organization (https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns True on success.

func (*Bot) VerifyUser added in v0.32.0 

func (b *Bot) VerifyUser(ctx context.Context, params *VerifyUserParams) error

VerifyUser - Verifies a user on behalf of the organization (https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns True on success.

type BotCommand 

type BotCommand struct {
	// 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"`
}

BotCommand - This object represents a bot command.

type BotCommandScope 

type BotCommandScope interface {
	// ScopeType returns BotCommandScope type
	ScopeType() string
	// contains filtered or unexported methods
}

BotCommandScope - This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: BotCommandScopeDefault (https://core.telegram.org/bots/api#botcommandscopedefault) BotCommandScopeAllPrivateChats (https://core.telegram.org/bots/api#botcommandscopeallprivatechats) BotCommandScopeAllGroupChats (https://core.telegram.org/bots/api#botcommandscopeallgroupchats) BotCommandScopeAllChatAdministrators (https://core.telegram.org/bots/api#botcommandscopeallchatadministrators) BotCommandScopeChat (https://core.telegram.org/bots/api#botcommandscopechat) BotCommandScopeChatAdministrators (https://core.telegram.org/bots/api#botcommandscopechatadministrators) BotCommandScopeChatMember (https://core.telegram.org/bots/api#botcommandscopechatmember)

type BotCommandScopeAllChatAdministrators 

type BotCommandScopeAllChatAdministrators struct {
	// Type - Scope type, must be all_chat_administrators
	Type string `json:"type"`
}

BotCommandScopeAllChatAdministrators - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chat administrators.

func (*BotCommandScopeAllChatAdministrators) ScopeType 

func (b *BotCommandScopeAllChatAdministrators) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeAllGroupChats 

type BotCommandScopeAllGroupChats struct {
	// Type - Scope type, must be all_group_chats
	Type string `json:"type"`
}

BotCommandScopeAllGroupChats - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all group and supergroup chats.

func (*BotCommandScopeAllGroupChats) ScopeType 

func (b *BotCommandScopeAllGroupChats) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeAllPrivateChats 

type BotCommandScopeAllPrivateChats struct {
	// Type - Scope type, must be all_private_chats
	Type string `json:"type"`
}

BotCommandScopeAllPrivateChats - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all private chats.

func (*BotCommandScopeAllPrivateChats) ScopeType 

func (b *BotCommandScopeAllPrivateChats) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeChat 

type BotCommandScopeChat struct {
	// Type - Scope type, must be chat
	Type string `json:"type"`

	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username). Channel direct messages chats and channel chats aren't supported.
	ChatID ChatID `json:"chat_id"`
}

BotCommandScopeChat - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific chat.

func (*BotCommandScopeChat) ScopeType 

func (b *BotCommandScopeChat) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeChatAdministrators 

type BotCommandScopeChatAdministrators struct {
	// Type - Scope type, must be chat_administrators
	Type string `json:"type"`

	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username). Channel direct messages chats and channel chats aren't supported.
	ChatID ChatID `json:"chat_id"`
}

BotCommandScopeChatAdministrators - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering all administrators of a specific group or supergroup chat.

func (*BotCommandScopeChatAdministrators) ScopeType 

func (b *BotCommandScopeChatAdministrators) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeChatMember 

type BotCommandScopeChatMember struct {
	// Type - Scope type, must be chat_member
	Type string `json:"type"`

	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username). Channel direct messages chats and channel chats aren't supported.
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

BotCommandScopeChatMember - Represents the scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands, covering a specific member of a group or supergroup chat.

func (*BotCommandScopeChatMember) ScopeType 

func (b *BotCommandScopeChatMember) ScopeType() string

ScopeType returns BotCommandScope type

type BotCommandScopeDefault 

type BotCommandScopeDefault struct {
	// Type - Scope type, must be default
	Type string `json:"type"`
}

BotCommandScopeDefault - Represents the default scope (https://core.telegram.org/bots/api#botcommandscope) of bot commands. Default commands are used if no commands with a narrower scope (https://core.telegram.org/bots/api#determining-list-of-commands) are specified for the user.

func (*BotCommandScopeDefault) ScopeType 

func (b *BotCommandScopeDefault) ScopeType() string

ScopeType returns BotCommandScope type

type BotDescription added in v0.22.0 

type BotDescription struct {
	// Description - The bot's description
	Description string `json:"description"`
}

BotDescription - This object represents the bot's description.

type BotName added in v0.22.1 

type BotName struct {
	// Name - The bot's name
	Name string `json:"name"`
}

BotName - This object represents the bot's name.

type BotOption 

type BotOption func(bot *Bot) error

BotOption represents an option that can be applied to Bot

func WithAPICaller added in v0.9.2 

func WithAPICaller(caller ta.Caller) BotOption

WithAPICaller sets a custom API caller to use

func WithAPIServer added in v0.9.2 

func WithAPIServer(apiURL string) BotOption

WithAPIServer sets bot API server URL to use

func WithDebugMode added in v1.5.0 

func WithDebugMode() BotOption

WithDebugMode enables debug mode, when bot makes API requests log messages will include request parameters

func WithDefaultDebugLogger added in v0.15.3 

func WithDefaultDebugLogger() BotOption

WithDefaultDebugLogger configures default debug logger. Alias to default logger with debug and error logs. Redefines existing logger. Enables debug mode.

func WithDefaultLogger added in v0.9.2 

func WithDefaultLogger(debugMode, printErrors bool) BotOption

WithDefaultLogger configures default logger. Redefines existing logger. Note: Default logger will hide your bot token, but it still may log sensitive information, it's only safe to use default logger in a testing environment.

func WithDiscardLogger added in v0.9.2 

func WithDiscardLogger() BotOption

WithDiscardLogger configures discard logger. Alias to default logger with disabled logs. Redefines existing logger.

func WithExtendedDefaultLogger added in v0.14.0 

func WithExtendedDefaultLogger(debugMode, printErrors bool, replacer *strings.Replacer) BotOption

WithExtendedDefaultLogger configures default logger, replacer can be nil. Redefines existing loggers. Note: Keep in mind that debug logs will include your bot token. It's only safe to have them enabled in a testing environment or hide sensitive information (like bot token) yourself.

func WithFastHTTPClient added in v0.9.2 

func WithFastHTTPClient(client *fasthttp.Client) BotOption

WithFastHTTPClient sets fasthttp client to use

func WithHTTPClient added in v0.19.0 

func WithHTTPClient(client *http.Client) BotOption

WithHTTPClient sets http client to use

func WithHealthCheck added in v0.15.3 

func WithHealthCheck(ctx context.Context) BotOption

WithHealthCheck enables health check using the Bot.GetMe method on the start

func WithLogger added in v0.9.2 

func WithLogger(log Logger) BotOption

WithLogger sets logger to use. Redefines existing loggers. Note: Keep in mind that debug logs will include your bot token. It's only safe to have them enabled in a testing environment or hide sensitive information (like bot token) yourself.

func WithRequestConstructor added in v0.9.2 

func WithRequestConstructor(constructor ta.RequestConstructor) BotOption

WithRequestConstructor sets custom request constructor to use

func WithTestServerPath added in v0.26.2 

func WithTestServerPath() BotOption

WithTestServerPath use the test server API path instead of the regular API path

Regular API: https://<api-server>/bot<token>/<method-name> Test API: https://<api-server>/bot<token>/test/<method-name>

func WithWarnings added in v0.16.2 

func WithWarnings() BotOption

WithWarnings treat Telegram warnings as an error Note: Any request that has a non-empty error will return both result and error

type BotShortDescription added in v0.22.0 

type BotShortDescription struct {
	// ShortDescription - The bot's short description
	ShortDescription string `json:"short_description"`
}

BotShortDescription - This object represents the bot's short description.

type BusinessBotRights added in v1.1.0 

type BusinessBotRights struct {
	// CanReply - Optional. True, if the bot can send and edit messages in the private chats that had incoming
	// messages in the last 24 hours
	CanReply bool `json:"can_reply,omitempty"`

	// 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 - 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"`
}

BusinessBotRights - Represents the rights of a business bot.

type BusinessConnection added in v0.29.2 

type BusinessConnection struct {
	// 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 int64 `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"`
}

BusinessConnection - Describes the connection of the bot with a business account.

type BusinessIntro added in v0.29.2 

type BusinessIntro struct {
	// 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"`
}

BusinessIntro - Contains information about the start page settings of a Telegram Business account.

type BusinessLocation added in v0.29.2 

type BusinessLocation struct {
	// Address - Address of the business
	Address string `json:"address"`

	// Location - Optional. Location of the business
	Location *Location `json:"location,omitempty"`
}

BusinessLocation - Contains information about the location of a Telegram Business account.

type BusinessMessagesDeleted added in v0.29.2 

type BusinessMessagesDeleted struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Chat - Information about a chat in the business account. The bot may not have access to the chat or the
	// corresponding user.
	Chat Chat `json:"chat"`

	// MessageIDs - The list of identifiers of deleted messages in the chat of the business account
	MessageIDs []int `json:"message_ids"`
}

BusinessMessagesDeleted - This object is received when messages are deleted from a connected business account.

type BusinessOpeningHours added in v0.29.2 

type BusinessOpeningHours struct {
	// 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"`
}

BusinessOpeningHours - Describes the opening hours of a business.

type BusinessOpeningHoursInterval added in v0.29.2 

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"`
}

BusinessOpeningHoursInterval - Describes an interval of time during which a business is open.

type CallbackGame 

type CallbackGame struct{}

CallbackGame - A placeholder, currently holds no information. Use BotFather (https://t.me/botfather) to set up your game.

type CallbackQuery 

type CallbackQuery struct {
	// ID - Unique identifier for this query
	ID string `json:"id"`

	// From - Sender
	From User `json:"from"`

	// Message - Optional. Message sent by the bot with the callback button that originated the query
	Message MaybeInaccessibleMessage `json:"message,omitempty"`

	// InlineMessageID - Optional. Identifier of the message sent via the bot in inline mode, that originated
	// the query.
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// ChatInstance - Global identifier, uniquely corresponding to the chat to which the message with the
	// callback button was sent. Useful for high scores in games (https://core.telegram.org/bots/api#games).
	ChatInstance string `json:"chat_instance"`

	// Data - Optional. Data associated with the callback button. Be aware that the message originated the query
	// can contain no callback buttons with this data.
	Data string `json:"data,omitempty"`

	// GameShortName - Optional. Short name of a Game (https://core.telegram.org/bots/api#games) to be returned,
	// serves as the unique identifier for the game
	GameShortName string `json:"game_short_name,omitempty"`
}

CallbackQuery - This object represents an incoming callback query from a callback button in an inline keyboard (https://core.telegram.org/bots/features#inline-keyboards). If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode (https://core.telegram.org/bots/api#inline-mode)), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

func (*CallbackQuery) UnmarshalJSON added in v0.29.0 

func (q *CallbackQuery) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to CallbackQuery

type Chat 

type Chat struct {
	// ID - Unique identifier for this chat. This number may have more than 32 significant bits and some
	// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
	// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
	// identifier.
	ID int64 `json:"id"`

	// Type - Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
	Type string `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
	// (https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled)
	IsForum bool `json:"is_forum,omitempty"`

	// IsDirectMessages - Optional. True, if the chat is the direct messages chat of a channel
	IsDirectMessages bool `json:"is_direct_messages,omitempty"`
}

Chat - This object represents a chat.

func (Chat) ChatID added in v0.27.2 

func (c Chat) ChatID() ChatID

ChatID returns ChatID of this chat

type ChatAdministratorRights added in v0.11.0 

type ChatAdministratorRights struct {
	// 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 - 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 - 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"`
}

ChatAdministratorRights - Represents the rights of an administrator in a chat.

type ChatBackground added in v0.30.1 

type ChatBackground struct {
	// Type - Type of the background
	Type BackgroundType `json:"type"`
}

ChatBackground - This object represents a chat background.

func (*ChatBackground) UnmarshalJSON added in v0.30.1 

func (c *ChatBackground) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ChatBackground

type ChatBoost added in v0.29.0 

type ChatBoost struct {
	// BoostID - Unique identifier of the boost
	BoostID string `json:"boost_id"`

	// AddDate - Point in time (Unix timestamp) when the chat was boosted
	AddDate int64 `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 int64 `json:"expiration_date"`

	// Source - Source of the added boost
	Source ChatBoostSource `json:"source"`
}

ChatBoost - This object contains information about a chat boost.

func (*ChatBoost) UnmarshalJSON added in v0.29.0 

func (b *ChatBoost) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ChatBoost

type ChatBoostAdded added in v0.29.1 

type ChatBoostAdded struct {
	// BoostCount - Number of boosts added by the user
	BoostCount int `json:"boost_count"`
}

ChatBoostAdded - This object represents a service message about a user boosting a chat.

type ChatBoostRemoved added in v0.29.0 

type ChatBoostRemoved struct {
	// 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 int64 `json:"remove_date"`

	// Source - Source of the removed boost
	Source ChatBoostSource `json:"source"`
}

ChatBoostRemoved - This object represents a boost removed from a chat.

func (*ChatBoostRemoved) UnmarshalJSON added in v0.29.0 

func (b *ChatBoostRemoved) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ChatBoostRemoved

type ChatBoostSource added in v0.29.0 

type ChatBoostSource interface {
	// BoostSource returns boost source
	BoostSource() string
	// contains filtered or unexported methods
}

ChatBoostSource - This object describes the source of a chat boost. It can be one of ChatBoostSourcePremium (https://core.telegram.org/bots/api#chatboostsourcepremium) ChatBoostSourceGiftCode (https://core.telegram.org/bots/api#chatboostsourcegiftcode) ChatBoostSourceGiveaway (https://core.telegram.org/bots/api#chatboostsourcegiveaway)

type ChatBoostSourceGiftCode added in v0.29.0 

type ChatBoostSourceGiftCode struct {
	// Source - Source of the boost, always “gift_code”
	Source string `json:"source"`

	// User - User for which the gift code was created
	User User `json:"user"`
}

ChatBoostSourceGiftCode - The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

func (*ChatBoostSourceGiftCode) BoostSource added in v0.29.0 

func (b *ChatBoostSourceGiftCode) BoostSource() string

BoostSource returns boost source

type ChatBoostSourceGiveaway added in v0.29.0 

type ChatBoostSourceGiveaway struct {
	// Source - Source of the boost, always “giveaway”
	Source string `json:"source"`

	// 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.
	GiveawayMessageID int `json:"giveaway_message_id"`

	// User - Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only
	User *User `json:"user,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"`
}

ChatBoostSourceGiveaway - The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.

func (*ChatBoostSourceGiveaway) BoostSource added in v0.29.0 

func (b *ChatBoostSourceGiveaway) BoostSource() string

BoostSource returns boost source

type ChatBoostSourcePremium added in v0.29.0 

type ChatBoostSourcePremium struct {
	// Source - Source of the boost, always “premium”
	Source string `json:"source"`

	// User - User that boosted the chat
	User User `json:"user"`
}

ChatBoostSourcePremium - The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

func (*ChatBoostSourcePremium) BoostSource added in v0.29.0 

func (b *ChatBoostSourcePremium) BoostSource() string

BoostSource returns boost source

type ChatBoostUpdated added in v0.29.0 

type ChatBoostUpdated struct {
	// Chat - Chat which was boosted
	Chat Chat `json:"chat"`

	// Boost - Information about the chat boost
	Boost ChatBoost `json:"boost"`
}

ChatBoostUpdated - This object represents a boost added to a chat or changed.

type ChatFullInfo added in v0.30.1 

type ChatFullInfo struct {
	// ID - Unique identifier for this chat. This number may have more than 32 significant bits and some
	// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
	// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
	// identifier.
	ID int64 `json:"id"`

	// Type - Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
	Type string `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
	// (https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups) enabled)
	IsForum bool `json:"is_forum,omitempty"`

	// IsDirectMessages - Optional. True, if the chat is the direct messages chat of a channel
	IsDirectMessages bool `json:"is_direct_messages,omitempty"`

	// AccentColorID - Identifier of the accent color for the chat name and backgrounds of the chat photo, reply
	// header, and link preview. See accent colors (https://core.telegram.org/bots/api#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
	// (https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-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 - 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 - Optional. Information about the corresponding channel chat; for direct messages chats only
	ParentChat *Chat `json:"parent_chat,omitempty"`

	// AvailableReactions - Optional. List of available reactions allowed in the chat. If omitted, then all
	// emoji reactions (https://core.telegram.org/bots/api#reactiontypeemoji) are allowed.
	AvailableReactions []ReactionType `json:"available_reactions,omitempty"`

	// BackgroundCustomEmojiID - Optional. Custom emoji identifier of the emoji chosen by the chat for the reply
	// header and link preview background
	BackgroundCustomEmojiID string `json:"background_custom_emoji_id,omitempty"`

	// ProfileAccentColorID - Optional. Identifier of the accent color for the chat's profile background. See
	// profile accent colors (https://core.telegram.org/bots/api#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 - 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 int64 `json:"emoji_status_expiration_date,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 - 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"`

	// 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"`

	// UnrestrictBoostCount - Optional. For supergroups, the minimum number of boosts that a non-administrator
	// user needs to add in order to ignore slow mode and chat permissions
	UnrestrictBoostCount int `json:"unrestrict_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 - 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"`

	// 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"`

	// PaidMessageStarCount - Optional. The number of Telegram Stars a general user have to pay to send a
	// message to the chat
	PaidMessageStarCount int `json:"paid_message_star_count,omitempty"`
}

ChatFullInfo - This object contains full information about a chat.

func (*ChatFullInfo) UnmarshalJSON added in v0.30.1 

func (c *ChatFullInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to Chat

type ChatID 

type ChatID struct {
	// ID - Unique identifier for the target chat
	ID int64

	// Username - Channel or group username of the target chat (in the format @channel_username)
	// Note: User username can't be used here, you have to use integer chat ID
	Username string
}

ChatID - Represents chat ID as int64 or string

func (ChatID) MarshalJSON 

func (c ChatID) MarshalJSON() ([]byte, error)

MarshalJSON returns JSON representation of ChatID

func (ChatID) String added in v0.20.2 

func (c ChatID) String() string

String returns string representation of ChatID

func (*ChatID) UnmarshalJSON added in v0.31.6 

func (c *ChatID) UnmarshalJSON(data []byte) error

UnmarshalJSON parses JSON to ChatID 

type ChatInviteLink struct {
	// InviteLink - The invite link. If the link was created by another chat administrator, then the second part
	// of the link will be replaced with “…”.
	InviteLink string `json:"invite_link"`

	// Creator - Creator of the link
	Creator User `json:"creator"`

	// CreatesJoinRequest - True, if users joining the chat via the link need to be approved by chat
	// administrators
	CreatesJoinRequest 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 - 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 int64 `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 int64 `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"`
}

ChatInviteLink - Represents an invite link for a chat.

type ChatJoinRequest added in v0.5.0 

type ChatJoinRequest struct {
	// Chat - Chat to which the request was sent
	Chat Chat `json:"chat"`

	// From - User that sent the join request
	From User `json:"from"`

	// UserChatID - Identifier of a private chat with the user who sent the join request. This number may have
	// more than 32 significant bits and some programming languages may have difficulty/silent defects in
	// interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type
	// are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until
	// the join request is processed, assuming no other administrator contacted the user.
	UserChatID int64 `json:"user_chat_id"`

	// Date - Date the request was sent in Unix time
	Date int64 `json:"date"`

	// Bio - Optional. Bio of the user.
	Bio string `json:"bio,omitempty"`

	// InviteLink - Optional. Chat invite link that was used by the user to send the join request
	InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
}

ChatJoinRequest - Represents a join request sent to a chat.

type ChatLocation 

type ChatLocation struct {
	// Location - The location to which the supergroup is connected. Can't be a live location.
	Location Location `json:"location"`

	// Address - Location address; 1-64 characters, as defined by the chat owner
	Address string `json:"address"`
}

ChatLocation - Represents a location to which a chat is connected.

type ChatMember 

type ChatMember interface {
	// MemberStatus returns ChatMember status
	MemberStatus() string
	// MemberUser returns ChatMember User
	MemberUser() User
	// MemberIsMember returns true if ChatMember is member
	MemberIsMember() bool
	// contains filtered or unexported methods
}

ChatMember - This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: ChatMemberOwner (https://core.telegram.org/bots/api#chatmemberowner) ChatMemberAdministrator (https://core.telegram.org/bots/api#chatmemberadministrator) ChatMemberMember (https://core.telegram.org/bots/api#chatmembermember) ChatMemberRestricted (https://core.telegram.org/bots/api#chatmemberrestricted) ChatMemberLeft (https://core.telegram.org/bots/api#chatmemberleft) ChatMemberBanned (https://core.telegram.org/bots/api#chatmemberbanned)

type ChatMemberAdministrator 

type ChatMemberAdministrator struct {
	// Status - The member's status in the chat, always “administrator”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`

	// CanBeEdited - True, if the bot is allowed to edit administrator privileges of that user
	CanBeEdited bool `json:"can_be_edited"`

	// 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 - 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 - 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"`

	// CustomTitle - Optional. Custom title for this user
	CustomTitle string `json:"custom_title,omitempty"`
}

ChatMemberAdministrator - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that has some additional privileges.

func (*ChatMemberAdministrator) MemberIsMember added in v0.29.0 

func (c *ChatMemberAdministrator) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberAdministrator) MemberStatus 

func (c *ChatMemberAdministrator) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberAdministrator) MemberUser 

func (c *ChatMemberAdministrator) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberBanned 

type ChatMemberBanned struct {
	// Status - The member's status in the chat, always “kicked”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`

	// UntilDate - Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned
	// forever
	UntilDate int64 `json:"until_date"`
}

ChatMemberBanned - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that was banned in the chat and can't return to the chat or view chat messages.

func (*ChatMemberBanned) MemberIsMember added in v0.29.0 

func (c *ChatMemberBanned) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberBanned) MemberStatus 

func (c *ChatMemberBanned) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberBanned) MemberUser 

func (c *ChatMemberBanned) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberLeft 

type ChatMemberLeft struct {
	// Status - The member's status in the chat, always “left”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`
}

ChatMemberLeft - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that isn't currently a member of the chat, but may join it themselves.

func (*ChatMemberLeft) MemberIsMember added in v0.29.0 

func (c *ChatMemberLeft) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberLeft) MemberStatus 

func (c *ChatMemberLeft) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberLeft) MemberUser 

func (c *ChatMemberLeft) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberMember 

type ChatMemberMember struct {
	// Status - The member's status in the chat, always “member”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`

	// UntilDate - Optional. Date when the user's subscription will expire; Unix time
	UntilDate int64 `json:"until_date,omitempty"`
}

ChatMemberMember - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that has no additional privileges or restrictions.

func (*ChatMemberMember) MemberIsMember added in v0.29.0 

func (c *ChatMemberMember) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberMember) MemberStatus 

func (c *ChatMemberMember) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberMember) MemberUser 

func (c *ChatMemberMember) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberOwner 

type ChatMemberOwner struct {
	// Status - The member's status in the chat, always “creator”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`

	// IsAnonymous - True, if the user's presence in the chat is hidden
	IsAnonymous bool `json:"is_anonymous"`

	// CustomTitle - Optional. Custom title for this user
	CustomTitle string `json:"custom_title,omitempty"`
}

ChatMemberOwner - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that owns the chat and has all administrator privileges.

func (*ChatMemberOwner) MemberIsMember added in v0.29.0 

func (c *ChatMemberOwner) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberOwner) MemberStatus 

func (c *ChatMemberOwner) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberOwner) MemberUser 

func (c *ChatMemberOwner) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberRestricted 

type ChatMemberRestricted struct {
	// Status - The member's status in the chat, always “restricted”
	Status string `json:"status"`

	// User - Information about the user
	User User `json:"user"`

	// IsMember - True, if the user is a member of the chat at the moment of the request
	IsMember bool `json:"is_member"`

	// CanSendMessages - True, if the user is allowed to send text messages, contacts, giveaways, giveaway
	// winners, invoices, locations and venues
	CanSendMessages bool `json:"can_send_messages"`

	// CanSendAudios - True, if the user is allowed to send audios
	CanSendAudios bool `json:"can_send_audios"`

	// CanSendDocuments - True, if the user is allowed to send documents
	CanSendDocuments bool `json:"can_send_documents"`

	// CanSendPhotos - True, if the user is allowed to send photos
	CanSendPhotos bool `json:"can_send_photos"`

	// CanSendVideos - True, if the user is allowed to send videos
	CanSendVideos bool `json:"can_send_videos"`

	// CanSendVideoNotes - True, if the user is allowed to send video notes
	CanSendVideoNotes bool `json:"can_send_video_notes"`

	// CanSendVoiceNotes - True, if the user is allowed to send voice notes
	CanSendVoiceNotes bool `json:"can_send_voice_notes"`

	// CanSendPolls - True, if the user is allowed to send polls and checklists
	CanSendPolls bool `json:"can_send_polls"`

	// CanSendOtherMessages - True, if the user is allowed to send animations, games, stickers and use inline
	// bots
	CanSendOtherMessages bool `json:"can_send_other_messages"`

	// CanAddWebPagePreviews - True, if the user is allowed to add web page previews to their messages
	CanAddWebPagePreviews bool `json:"can_add_web_page_previews"`

	// 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"`

	// CanPinMessages - True, if the user is allowed to pin messages
	CanPinMessages bool `json:"can_pin_messages"`

	// CanManageTopics - True, if the user is allowed to create forum topics
	CanManageTopics bool `json:"can_manage_topics"`

	// UntilDate - Date when restrictions will be lifted for this user; Unix time. If 0, then the user is
	// restricted forever
	UntilDate int64 `json:"until_date"`
}

ChatMemberRestricted - Represents a chat member (https://core.telegram.org/bots/api#chatmember) that is under certain restrictions in the chat. Supergroups only.

func (*ChatMemberRestricted) MemberIsMember added in v0.29.0 

func (c *ChatMemberRestricted) MemberIsMember() bool

MemberIsMember returns true if ChatMember is member

func (*ChatMemberRestricted) MemberStatus 

func (c *ChatMemberRestricted) MemberStatus() string

MemberStatus returns ChatMember status

func (*ChatMemberRestricted) MemberUser 

func (c *ChatMemberRestricted) MemberUser() User

MemberUser returns ChatMember User

type ChatMemberUpdated 

type ChatMemberUpdated struct {
	// Chat - Chat the user belongs to
	Chat Chat `json:"chat"`

	// From - Performer of the action, which resulted in the change
	From User `json:"from"`

	// Date - Date the change was done in Unix time
	Date int64 `json:"date"`

	// OldChatMember - Previous information about the chat member
	OldChatMember ChatMember `json:"old_chat_member"`

	// NewChatMember - New information about the chat member
	NewChatMember ChatMember `json:"new_chat_member"`

	// InviteLink - Optional. Chat invite link, which was used by the user to join the chat; for joining by
	// invite link events only.
	InviteLink *ChatInviteLink `json:"invite_link,omitempty"`

	// ViaJoinRequest - Optional. True, if the user joined the chat after sending a direct join request without
	// using an invite link and being approved by an administrator
	ViaJoinRequest bool `json:"via_join_request,omitempty"`

	// ViaChatFolderInviteLink - Optional. True, if the user joined the chat via a chat folder invite link
	ViaChatFolderInviteLink bool `json:"via_chat_folder_invite_link,omitempty"`
}

ChatMemberUpdated - This object represents changes in the status of a chat member.

func (*ChatMemberUpdated) UnmarshalJSON 

func (c *ChatMemberUpdated) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ChatMemberUpdated

type ChatPermissions 

type ChatPermissions struct {
	// CanSendMessages - Optional. True, if the user is allowed to send text messages, contacts, giveaways,
	// giveaway winners, invoices, locations and venues
	CanSendMessages *bool `json:"can_send_messages,omitempty"`

	// CanSendAudios - Optional. True, if the user is allowed to send audios
	CanSendAudios *bool `json:"can_send_audios,omitempty"`

	// CanSendDocuments - Optional. True, if the user is allowed to send documents
	CanSendDocuments *bool `json:"can_send_documents,omitempty"`

	// CanSendPhotos - Optional. True, if the user is allowed to send photos
	CanSendPhotos *bool `json:"can_send_photos,omitempty"`

	// CanSendVideos - Optional. True, if the user is allowed to send videos
	CanSendVideos *bool `json:"can_send_videos,omitempty"`

	// CanSendVideoNotes - Optional. True, if the user is allowed to send video notes
	CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"`

	// CanSendVoiceNotes - Optional. True, if the user is allowed to send voice notes
	CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"`

	// CanSendPolls - Optional. True, if the user is allowed to send polls and checklists
	CanSendPolls *bool `json:"can_send_polls,omitempty"`

	// CanSendOtherMessages - Optional. True, if the user is allowed to send animations, games, stickers and use
	// inline bots
	CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`

	// CanAddWebPagePreviews - Optional. True, if the user is allowed to add web page previews to their messages
	CanAddWebPagePreviews *bool `json:"can_add_web_page_previews,omitempty"`

	// 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,omitempty"`

	// CanInviteUsers - Optional. True, if the user is allowed to invite new users to the chat
	CanInviteUsers *bool `json:"can_invite_users,omitempty"`

	// CanPinMessages - Optional. True, if the user is allowed to pin messages. Ignored in public supergroups
	CanPinMessages *bool `json:"can_pin_messages,omitempty"`

	// 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,omitempty"`
}

ChatPermissions - Describes actions that a non-administrator user is allowed to take in a chat.

type ChatPhoto 

type ChatPhoto struct {
	// SmallFileID - File identifier of small (160x160) chat photo. This file_id can be used only for photo
	// download and only for as long as the photo is not changed.
	SmallFileID string `json:"small_file_id"`

	// 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 - 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"`
}

ChatPhoto - This object represents a chat photo.

type ChatShared added in v0.20.1 

type ChatShared struct {
	// RequestID - Identifier of the request
	RequestID int `json:"request_id"`

	// ChatID - Identifier of the shared 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 64-bit integer or double-precision float type are safe for storing this identifier.
	// The bot may not have access to the chat and could be unable to use this identifier, unless the chat is
	// already known to the bot by some other means.
	ChatID int64 `json:"chat_id"`

	// Title - Optional. Title of the chat, if the title was requested by the bot.
	Title string `json:"title,omitempty"`

	// Username - Optional. Username of the chat, if the username was requested by the bot and available.
	Username string `json:"username,omitempty"`

	// Photo - Optional. Available sizes of the chat photo, if the photo was requested by the bot
	Photo []PhotoSize `json:"photo,omitempty"`
}

ChatShared - This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat (https://core.telegram.org/bots/api#keyboardbuttonrequestchat) button.

type Checklist added in v1.2.0 

type Checklist struct {
	// 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"`
}

Checklist - Describes a checklist.

type ChecklistTask added in v1.2.0 

type ChecklistTask struct {
	// 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 int64 `json:"completion_date,omitempty"`
}

ChecklistTask - Describes a task in a checklist.

type ChecklistTasksAdded added in v1.2.0 

type ChecklistTasksAdded struct {
	// ChecklistMessage - Optional. Message containing the checklist to which the tasks were added. Note that
	// the Message (https://core.telegram.org/bots/api#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"`
}

ChecklistTasksAdded - Describes a service message about tasks added to a checklist.

type ChecklistTasksDone added in v1.2.0 

type ChecklistTasksDone struct {
	// ChecklistMessage - Optional. Message containing the checklist whose tasks were marked as done or not
	// done. Note that the Message (https://core.telegram.org/bots/api#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"`

	// 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"`
}

ChecklistTasksDone - Describes a service message about checklist tasks marked as done or not done.

type ChosenInlineResult 

type ChosenInlineResult struct {
	// ResultID - The unique identifier for the result that was chosen
	ResultID string `json:"result_id"`

	// From - The user that chose the result
	From User `json:"from"`

	// Location - Optional. Sender location, only for bots that require user location
	Location *Location `json:"location,omitempty"`

	// InlineMessageID - Optional. Identifier of the sent inline message. Available only if there is an inline
	// keyboard (https://core.telegram.org/bots/api#inlinekeyboardmarkup) attached to the message. Will be also
	// received in callback queries (https://core.telegram.org/bots/api#callbackquery) and can be used to edit
	// (https://core.telegram.org/bots/api#updating-messages) the message.
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// Query - The query that was used to obtain the result
	Query string `json:"query"`
}

ChosenInlineResult - Represents a result (https://core.telegram.org/bots/api#inlinequeryresult) of an inline query that was chosen by the user and sent to their chat partner.

type CloseForumTopicParams added in v0.17.1 

type CloseForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Unique identifier for the target message thread of the forum topic
	MessageThreadID int `json:"message_thread_id"`
}

CloseForumTopicParams - Represents parameters of closeForumTopic method.

func (*CloseForumTopicParams) WithChatID added in v0.17.1 

func (p *CloseForumTopicParams) WithChatID(chatID ChatID) *CloseForumTopicParams

WithChatID adds chat ID parameter

func (*CloseForumTopicParams) WithMessageThreadID added in v0.17.1 

func (p *CloseForumTopicParams) WithMessageThreadID(messageThreadID int) *CloseForumTopicParams

WithMessageThreadID adds message thread ID parameter

type CloseGeneralForumTopicParams added in v0.18.1 

type CloseGeneralForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

CloseGeneralForumTopicParams - Represents parameters of closeGeneralForumTopic method.

func (*CloseGeneralForumTopicParams) WithChatID added in v0.18.1 

func (p *CloseGeneralForumTopicParams) WithChatID(chatID ChatID) *CloseGeneralForumTopicParams

WithChatID adds chat ID parameter

type Contact 

type Contact struct {
	// PhoneNumber - Contact's phone number
	PhoneNumber string `json:"phone_number"`

	// 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
	// (https://en.wikipedia.org/wiki/VCard)
	Vcard string `json:"vcard,omitempty"`
}

Contact - This object represents a phone contact.

type ConvertGiftToStarsParams added in v1.1.0 

type ConvertGiftToStarsParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// OwnedGiftID - Unique identifier of the regular gift that should be converted to Telegram Stars
	OwnedGiftID string `json:"owned_gift_id"`
}

ConvertGiftToStarsParams - Represents parameters of convertGiftToStars method.

func (*ConvertGiftToStarsParams) WithBusinessConnectionID added in v1.1.0 

func (p *ConvertGiftToStarsParams) WithBusinessConnectionID(businessConnectionID string) *ConvertGiftToStarsParams

WithBusinessConnectionID adds business connection ID parameter

func (*ConvertGiftToStarsParams) WithOwnedGiftID added in v1.1.0 

func (p *ConvertGiftToStarsParams) WithOwnedGiftID(ownedGiftID string) *ConvertGiftToStarsParams

WithOwnedGiftID adds owned gift ID parameter

type CopyMessageParams 

type CopyMessageParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// FromChatID - Unique identifier for the chat where the original message was sent (or channel username in
	// the format @channel_username)
	FromChatID ChatID `json:"from_chat_id"`

	// MessageID - Message identifier in the chat specified in from_chat_id
	MessageID int `json:"message_id"`

	// VideoStartTimestamp - Optional. New start timestamp for the copied video in the message
	VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`

	// Caption - Optional. New caption for media, 0-1024 characters after entities parsing. If not specified,
	// the original caption is kept
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the new caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `json:"parse_mode,omitempty"`

	// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the new caption,
	// which can be specified instead of parse_mode
	CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`

	// ShowCaptionAboveMedia - Optional. Pass True, if the caption must be shown above the message media.
	// Ignored if a new caption isn't specified.
	ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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; only
	// available when copying to private chats
	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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

CopyMessageParams - Represents parameters of copyMessage method.

func (*CopyMessageParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *CopyMessageParams) WithAllowPaidBroadcast() *CopyMessageParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*CopyMessageParams) WithCaption added in v0.10.0 

func (p *CopyMessageParams) WithCaption(caption string) *CopyMessageParams

WithCaption adds caption parameter

func (*CopyMessageParams) WithCaptionEntities added in v0.10.0 

func (p *CopyMessageParams) WithCaptionEntities(captionEntities ...MessageEntity) *CopyMessageParams

WithCaptionEntities adds caption entities parameter

func (*CopyMessageParams) WithChatID added in v0.10.0 

func (p *CopyMessageParams) WithChatID(chatID ChatID) *CopyMessageParams

WithChatID adds chat ID parameter

func (*CopyMessageParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *CopyMessageParams) WithDirectMessagesTopicID(directMessagesTopicID int) *CopyMessageParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*CopyMessageParams) WithDisableNotification added in v0.10.0 

func (p *CopyMessageParams) WithDisableNotification() *CopyMessageParams

WithDisableNotification adds disable notification parameter

func (*CopyMessageParams) WithFromChatID added in v0.10.0 

func (p *CopyMessageParams) WithFromChatID(fromChatID ChatID) *CopyMessageParams

WithFromChatID adds from chat ID parameter

func (*CopyMessageParams) WithMessageEffectID added in v1.4.0 

func (p *CopyMessageParams) WithMessageEffectID(messageEffectID string) *CopyMessageParams

WithMessageEffectID adds message effect ID parameter

func (*CopyMessageParams) WithMessageID added in v0.10.0 

func (p *CopyMessageParams) WithMessageID(messageID int) *CopyMessageParams

WithMessageID adds message ID parameter

func (*CopyMessageParams) WithMessageThreadID added in v0.17.1 

func (p *CopyMessageParams) WithMessageThreadID(messageThreadID int) *CopyMessageParams

WithMessageThreadID adds message thread ID parameter

func (*CopyMessageParams) WithParseMode added in v0.10.0 

func (p *CopyMessageParams) WithParseMode(parseMode string) *CopyMessageParams

WithParseMode adds parse mode parameter

func (*CopyMessageParams) WithProtectContent added in v0.10.0 

func (p *CopyMessageParams) WithProtectContent() *CopyMessageParams

WithProtectContent adds protect content parameter

func (*CopyMessageParams) WithReplyMarkup added in v0.10.0 

func (p *CopyMessageParams) WithReplyMarkup(replyMarkup ReplyMarkup) *CopyMessageParams

WithReplyMarkup adds reply markup parameter

func (*CopyMessageParams) WithReplyParameters added in v0.29.0 

func (p *CopyMessageParams) WithReplyParameters(replyParameters *ReplyParameters) *CopyMessageParams

WithReplyParameters adds reply parameters parameter

func (*CopyMessageParams) WithShowCaptionAboveMedia added in v0.30.2 

func (p *CopyMessageParams) WithShowCaptionAboveMedia() *CopyMessageParams

WithShowCaptionAboveMedia adds show caption above media parameter

func (*CopyMessageParams) WithSuggestedPostParameters added in v1.3.0 

func (p *CopyMessageParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *CopyMessageParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*CopyMessageParams) WithVideoStartTimestamp added in v1.0.2 

func (p *CopyMessageParams) WithVideoStartTimestamp(videoStartTimestamp int) *CopyMessageParams

WithVideoStartTimestamp adds video start timestamp parameter

type CopyMessagesParams added in v0.29.0 

type CopyMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// FromChatID - Unique identifier for the chat where the original messages were sent (or channel username in
	// the format @channel_username)
	FromChatID ChatID `json:"from_chat_id"`

	// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy.
	// The identifiers must be specified in a strictly increasing order.
	MessageIDs []int `json:"message_ids"`

	// DisableNotification - Optional. Sends the messages silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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"`

	// RemoveCaption - Optional. Pass True to copy the messages without their captions
	RemoveCaption bool `json:"remove_caption,omitempty"`
}

CopyMessagesParams - Represents parameters of copyMessages method.

func (*CopyMessagesParams) WithChatID added in v0.29.0 

func (p *CopyMessagesParams) WithChatID(chatID ChatID) *CopyMessagesParams

WithChatID adds chat ID parameter

func (*CopyMessagesParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *CopyMessagesParams) WithDirectMessagesTopicID(directMessagesTopicID int) *CopyMessagesParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*CopyMessagesParams) WithDisableNotification added in v0.29.0 

func (p *CopyMessagesParams) WithDisableNotification() *CopyMessagesParams

WithDisableNotification adds disable notification parameter

func (*CopyMessagesParams) WithFromChatID added in v0.29.0 

func (p *CopyMessagesParams) WithFromChatID(fromChatID ChatID) *CopyMessagesParams

WithFromChatID adds from chat ID parameter

func (*CopyMessagesParams) WithMessageIDs added in v0.29.0 

func (p *CopyMessagesParams) WithMessageIDs(messageIDs ...int) *CopyMessagesParams

WithMessageIDs adds message ids parameter

func (*CopyMessagesParams) WithMessageThreadID added in v0.29.0 

func (p *CopyMessagesParams) WithMessageThreadID(messageThreadID int) *CopyMessagesParams

WithMessageThreadID adds message thread ID parameter

func (*CopyMessagesParams) WithProtectContent added in v0.29.0 

func (p *CopyMessagesParams) WithProtectContent() *CopyMessagesParams

WithProtectContent adds protect content parameter

func (*CopyMessagesParams) WithRemoveCaption added in v0.29.0 

func (p *CopyMessagesParams) WithRemoveCaption() *CopyMessagesParams

WithRemoveCaption adds remove caption parameter

type CopyTextButton added in v0.32.0 

type CopyTextButton struct {
	// Text - The text to be copied to the clipboard; 1-256 characters
	Text string `json:"text"`
}

CopyTextButton - This object represents an inline keyboard button that copies specified text to the clipboard.

type CreateChatInviteLinkParams 

type CreateChatInviteLinkParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// Name - Optional. Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// ExpireDate - Optional. Point in time (Unix timestamp) when the link will expire
	ExpireDate int64 `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"`

	// CreatesJoinRequest - Optional. True, if users joining the chat via the link need to be approved by chat
	// administrators. If True, member_limit can't be specified
	CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
}

CreateChatInviteLinkParams - Represents parameters of createChatInviteLink method.

func (*CreateChatInviteLinkParams) WithChatID added in v0.10.0 

func (p *CreateChatInviteLinkParams) WithChatID(chatID ChatID) *CreateChatInviteLinkParams

WithChatID adds chat ID parameter

func (*CreateChatInviteLinkParams) WithCreatesJoinRequest added in v0.10.0 

func (p *CreateChatInviteLinkParams) WithCreatesJoinRequest() *CreateChatInviteLinkParams

WithCreatesJoinRequest adds creates join request parameter

func (*CreateChatInviteLinkParams) WithExpireDate added in v1.1.0 

func (p *CreateChatInviteLinkParams) WithExpireDate(expireDate int64) *CreateChatInviteLinkParams

WithExpireDate adds expire date parameter

func (*CreateChatInviteLinkParams) WithMemberLimit added in v0.10.0 

func (p *CreateChatInviteLinkParams) WithMemberLimit(memberLimit int) *CreateChatInviteLinkParams

WithMemberLimit adds member limit parameter

func (*CreateChatInviteLinkParams) WithName added in v0.10.0 

func (p *CreateChatInviteLinkParams) WithName(name string) *CreateChatInviteLinkParams

WithName adds name parameter

type CreateChatSubscriptionInviteLinkParams added in v0.31.2 

type CreateChatSubscriptionInviteLinkParams struct {
	// ChatID - Unique identifier for the target channel chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// Name - Optional. Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// SubscriptionPeriod - The number of seconds the subscription will be active for before the next payment.
	// Currently, it must always be 2592000 (30 days).
	SubscriptionPeriod int64 `json:"subscription_period"`

	// SubscriptionPrice - The amount of Telegram Stars a user must pay initially and after each subsequent
	// subscription period to be a member of the chat; 1-10000
	SubscriptionPrice int `json:"subscription_price"`
}

CreateChatSubscriptionInviteLinkParams - Represents parameters of createChatSubscriptionInviteLink method.

func (*CreateChatSubscriptionInviteLinkParams) WithChatID added in v0.31.2 

func (p *CreateChatSubscriptionInviteLinkParams) WithChatID(chatID ChatID) *CreateChatSubscriptionInviteLinkParams

WithChatID adds chat ID parameter

func (*CreateChatSubscriptionInviteLinkParams) WithName added in v0.31.2 

func (p *CreateChatSubscriptionInviteLinkParams) WithName(name string) *CreateChatSubscriptionInviteLinkParams

WithName adds name parameter

func (*CreateChatSubscriptionInviteLinkParams) WithSubscriptionPeriod added in v1.1.0 

func (p *CreateChatSubscriptionInviteLinkParams) WithSubscriptionPeriod(subscriptionPeriod int64,
) *CreateChatSubscriptionInviteLinkParams

WithSubscriptionPeriod adds subscription period parameter

func (*CreateChatSubscriptionInviteLinkParams) WithSubscriptionPrice added in v0.31.2 

func (p *CreateChatSubscriptionInviteLinkParams) WithSubscriptionPrice(subscriptionPrice int,
) *CreateChatSubscriptionInviteLinkParams

WithSubscriptionPrice adds subscription price parameter

type CreateForumTopicParams added in v0.17.1 

type CreateForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// Name - 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 int `json:"icon_color,omitempty"`

	// IconCustomEmojiID - Optional. Unique identifier of the custom emoji shown as the topic icon. Use
	// getForumTopicIconStickers (https://core.telegram.org/bots/api#getforumtopiciconstickers) to get all allowed
	// custom emoji identifiers.
	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}

CreateForumTopicParams - Represents parameters of createForumTopic method.

func (*CreateForumTopicParams) WithChatID added in v0.17.1 

func (p *CreateForumTopicParams) WithChatID(chatID ChatID) *CreateForumTopicParams

WithChatID adds chat ID parameter

func (*CreateForumTopicParams) WithIconColor added in v0.17.1 

func (p *CreateForumTopicParams) WithIconColor(iconColor int) *CreateForumTopicParams

WithIconColor adds icon color parameter

func (*CreateForumTopicParams) WithIconCustomEmojiID added in v0.17.1 

func (p *CreateForumTopicParams) WithIconCustomEmojiID(iconCustomEmojiID string) *CreateForumTopicParams

WithIconCustomEmojiID adds icon custom emoji ID parameter

func (*CreateForumTopicParams) WithName added in v0.17.1 

func (p *CreateForumTopicParams) WithName(name string) *CreateForumTopicParams

WithName adds name parameter

type CreateInvoiceLinkParams added in v0.13.1 

type CreateInvoiceLinkParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the link
	// will be created. For payments in Telegram Stars (https://t.me/BotNews/90) only.
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Title - Product name, 1-32 characters
	Title string `json:"title"`

	// Description - Product description, 1-255 characters
	Description string `json:"description"`

	// Payload - 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 (https://t.me/botfather). Pass
	// an empty string for payments in Telegram Stars (https://t.me/BotNews/90).
	ProviderToken string `json:"provider_token,omitempty"`

	// Currency - Three-letter ISO 4217 currency code, see more on currencies
	// (https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in Telegram Stars
	// (https://t.me/BotNews/90).
	Currency string `json:"currency"`

	// Prices - 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
	// (https://t.me/BotNews/90).
	Prices []LabeledPrice `json:"prices"`

	// SubscriptionPeriod - Optional. The number of seconds the subscription will be active for before the next
	// payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must
	// always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the
	// same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed
	// 10000 Telegram Stars.
	SubscriptionPeriod int64 `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 (https://core.telegram.org/bots/payments/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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	NeedShippingAddress bool `json:"need_shipping_address,omitempty"`

	// SendPhoneNumberToProvider - Optional. Pass True if the user's phone number should be sent to the
	// provider. Ignored for payments in Telegram Stars (https://t.me/BotNews/90).
	SendPhoneNumberToProvider 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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	IsFlexible bool `json:"is_flexible,omitempty"`
}

CreateInvoiceLinkParams - Represents parameters of createInvoiceLink method.

func (*CreateInvoiceLinkParams) WithBusinessConnectionID added in v0.32.0 

func (p *CreateInvoiceLinkParams) WithBusinessConnectionID(businessConnectionID string) *CreateInvoiceLinkParams

WithBusinessConnectionID adds business connection ID parameter

func (*CreateInvoiceLinkParams) WithCurrency added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithCurrency(currency string) *CreateInvoiceLinkParams

WithCurrency adds currency parameter

func (*CreateInvoiceLinkParams) WithDescription added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithDescription(description string) *CreateInvoiceLinkParams

WithDescription adds description parameter

func (*CreateInvoiceLinkParams) WithIsFlexible added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithIsFlexible() *CreateInvoiceLinkParams

WithIsFlexible adds is flexible parameter

func (*CreateInvoiceLinkParams) WithMaxTipAmount added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithMaxTipAmount(maxTipAmount int) *CreateInvoiceLinkParams

WithMaxTipAmount adds max tip amount parameter

func (*CreateInvoiceLinkParams) WithNeedEmail added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithNeedEmail() *CreateInvoiceLinkParams

WithNeedEmail adds need email parameter

func (*CreateInvoiceLinkParams) WithNeedName added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithNeedName() *CreateInvoiceLinkParams

WithNeedName adds need name parameter

func (*CreateInvoiceLinkParams) WithNeedPhoneNumber added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithNeedPhoneNumber() *CreateInvoiceLinkParams

WithNeedPhoneNumber adds need phone number parameter

func (*CreateInvoiceLinkParams) WithNeedShippingAddress added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithNeedShippingAddress() *CreateInvoiceLinkParams

WithNeedShippingAddress adds need shipping address parameter

func (*CreateInvoiceLinkParams) WithPayload added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPayload(payload string) *CreateInvoiceLinkParams

WithPayload adds payload parameter

func (*CreateInvoiceLinkParams) WithPhotoHeight added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPhotoHeight(photoHeight int) *CreateInvoiceLinkParams

WithPhotoHeight adds photo height parameter

func (*CreateInvoiceLinkParams) WithPhotoSize added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPhotoSize(photoSize int) *CreateInvoiceLinkParams

WithPhotoSize adds photo size parameter

func (*CreateInvoiceLinkParams) WithPhotoURL added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPhotoURL(photoURL string) *CreateInvoiceLinkParams

WithPhotoURL adds photo URL parameter

func (*CreateInvoiceLinkParams) WithPhotoWidth added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPhotoWidth(photoWidth int) *CreateInvoiceLinkParams

WithPhotoWidth adds photo width parameter

func (*CreateInvoiceLinkParams) WithPrices added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithPrices(prices ...LabeledPrice) *CreateInvoiceLinkParams

WithPrices adds prices parameter

func (*CreateInvoiceLinkParams) WithProviderData added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithProviderData(providerData string) *CreateInvoiceLinkParams

WithProviderData adds provider data parameter

func (*CreateInvoiceLinkParams) WithProviderToken added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithProviderToken(providerToken string) *CreateInvoiceLinkParams

WithProviderToken adds provider token parameter

func (*CreateInvoiceLinkParams) WithSendEmailToProvider added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithSendEmailToProvider() *CreateInvoiceLinkParams

WithSendEmailToProvider adds send email to provider parameter

func (*CreateInvoiceLinkParams) WithSendPhoneNumberToProvider added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithSendPhoneNumberToProvider() *CreateInvoiceLinkParams

WithSendPhoneNumberToProvider adds send phone number to provider parameter

func (*CreateInvoiceLinkParams) WithSubscriptionPeriod added in v1.1.0 

func (p *CreateInvoiceLinkParams) WithSubscriptionPeriod(subscriptionPeriod int64) *CreateInvoiceLinkParams

WithSubscriptionPeriod adds subscription period parameter

func (*CreateInvoiceLinkParams) WithSuggestedTipAmounts added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithSuggestedTipAmounts(suggestedTipAmounts ...int) *CreateInvoiceLinkParams

WithSuggestedTipAmounts adds suggested tip amounts parameter

func (*CreateInvoiceLinkParams) WithTitle added in v0.13.1 

func (p *CreateInvoiceLinkParams) WithTitle(title string) *CreateInvoiceLinkParams

WithTitle adds title parameter

type CreateNewStickerSetParams 

type CreateNewStickerSetParams struct {
	// UserID - User identifier of created sticker set owner
	UserID int64 `json:"user_id"`

	// Name - 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 - Sticker set title, 1-64 characters
	Title string `json:"title"`

	// Stickers - 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 string `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"`
}

CreateNewStickerSetParams - Represents parameters of createNewStickerSet method.

func (*CreateNewStickerSetParams) WithName added in v0.10.0 

func (p *CreateNewStickerSetParams) WithName(name string) *CreateNewStickerSetParams

WithName adds name parameter

func (*CreateNewStickerSetParams) WithNeedsRepainting added in v0.22.0 

func (p *CreateNewStickerSetParams) WithNeedsRepainting() *CreateNewStickerSetParams

WithNeedsRepainting adds needs repainting parameter

func (*CreateNewStickerSetParams) WithStickerType added in v0.16.0 

func (p *CreateNewStickerSetParams) WithStickerType(stickerType string) *CreateNewStickerSetParams

WithStickerType adds sticker type parameter

func (*CreateNewStickerSetParams) WithStickers added in v0.22.0 

func (p *CreateNewStickerSetParams) WithStickers(stickers ...InputSticker) *CreateNewStickerSetParams

WithStickers adds stickers parameter

func (*CreateNewStickerSetParams) WithTitle added in v0.10.0 

func (p *CreateNewStickerSetParams) WithTitle(title string) *CreateNewStickerSetParams

WithTitle adds title parameter

func (*CreateNewStickerSetParams) WithUserID added in v1.1.0 

func (p *CreateNewStickerSetParams) WithUserID(userID int64) *CreateNewStickerSetParams

WithUserID adds user ID parameter

type DeclineChatJoinRequestParams added in v0.5.0 

type DeclineChatJoinRequestParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

DeclineChatJoinRequestParams - Represents parameters of declineChatJoinRequest method.

func (*DeclineChatJoinRequestParams) WithChatID added in v0.10.0 

func (p *DeclineChatJoinRequestParams) WithChatID(chatID ChatID) *DeclineChatJoinRequestParams

WithChatID adds chat ID parameter

func (*DeclineChatJoinRequestParams) WithUserID added in v1.1.0 

func (p *DeclineChatJoinRequestParams) WithUserID(userID int64) *DeclineChatJoinRequestParams

WithUserID adds user ID parameter

type DeclineSuggestedPostParams added in v1.3.0 

type DeclineSuggestedPostParams struct {
	// ChatID - Unique identifier for the target direct messages chat
	ChatID int64 `json:"chat_id"`

	// MessageID - Identifier of a suggested post message to decline
	MessageID int `json:"message_id"`

	// Comment - Optional. Comment for the creator of the suggested post; 0-128 characters
	Comment string `json:"comment,omitempty"`
}

DeclineSuggestedPostParams - Represents parameters of declineSuggestedPost method.

func (*DeclineSuggestedPostParams) WithChatID added in v1.3.0 

func (p *DeclineSuggestedPostParams) WithChatID(chatID int64) *DeclineSuggestedPostParams

WithChatID adds chat ID parameter

func (*DeclineSuggestedPostParams) WithComment added in v1.3.0 

func (p *DeclineSuggestedPostParams) WithComment(comment string) *DeclineSuggestedPostParams

WithComment adds comment parameter

func (*DeclineSuggestedPostParams) WithMessageID added in v1.3.0 

func (p *DeclineSuggestedPostParams) WithMessageID(messageID int) *DeclineSuggestedPostParams

WithMessageID adds message ID parameter

type DeleteBusinessMessagesParams added in v1.1.0 

type DeleteBusinessMessagesParams struct {
	// BusinessConnectionID - Unique identifier of the business connection on behalf of which to delete the
	// messages
	BusinessConnectionID string `json:"business_connection_id"`

	// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from
	// the same chat. See deleteMessage (https://core.telegram.org/bots/api#deletemessage) for limitations on which
	// messages can be deleted
	MessageIDs []int `json:"message_ids"`
}

DeleteBusinessMessagesParams - Represents parameters of deleteBusinessMessages method.

func (*DeleteBusinessMessagesParams) WithBusinessConnectionID added in v1.1.0 

func (p *DeleteBusinessMessagesParams) WithBusinessConnectionID(businessConnectionID string,
) *DeleteBusinessMessagesParams

WithBusinessConnectionID adds business connection ID parameter

func (*DeleteBusinessMessagesParams) WithMessageIDs added in v1.1.0 

func (p *DeleteBusinessMessagesParams) WithMessageIDs(messageIDs ...int) *DeleteBusinessMessagesParams

WithMessageIDs adds message ids parameter

type DeleteChatPhotoParams 

type DeleteChatPhotoParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`
}

DeleteChatPhotoParams - Represents parameters of deleteChatPhoto method.

func (*DeleteChatPhotoParams) WithChatID added in v0.10.0 

func (p *DeleteChatPhotoParams) WithChatID(chatID ChatID) *DeleteChatPhotoParams

WithChatID adds chat ID parameter

type DeleteChatStickerSetParams 

type DeleteChatStickerSetParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

DeleteChatStickerSetParams - Represents parameters of deleteChatStickerSet method.

func (*DeleteChatStickerSetParams) WithChatID added in v0.10.0 

func (p *DeleteChatStickerSetParams) WithChatID(chatID ChatID) *DeleteChatStickerSetParams

WithChatID adds chat ID parameter

type DeleteForumTopicParams added in v0.17.1 

type DeleteForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Unique identifier for the target message thread of the forum topic
	MessageThreadID int `json:"message_thread_id"`
}

DeleteForumTopicParams - Represents parameters of deleteForumTopic method.

func (*DeleteForumTopicParams) WithChatID added in v0.17.1 

func (p *DeleteForumTopicParams) WithChatID(chatID ChatID) *DeleteForumTopicParams

WithChatID adds chat ID parameter

func (*DeleteForumTopicParams) WithMessageThreadID added in v0.17.1 

func (p *DeleteForumTopicParams) WithMessageThreadID(messageThreadID int) *DeleteForumTopicParams

WithMessageThreadID adds message thread ID parameter

type DeleteMessageParams 

type DeleteMessageParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageID - Identifier of the message to delete
	MessageID int `json:"message_id"`
}

DeleteMessageParams - Represents parameters of deleteMessage method.

func (*DeleteMessageParams) WithChatID added in v0.10.0 

func (p *DeleteMessageParams) WithChatID(chatID ChatID) *DeleteMessageParams

WithChatID adds chat ID parameter

func (*DeleteMessageParams) WithMessageID added in v0.10.0 

func (p *DeleteMessageParams) WithMessageID(messageID int) *DeleteMessageParams

WithMessageID adds message ID parameter

type DeleteMessagesParams added in v0.29.0 

type DeleteMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage
	// (https://core.telegram.org/bots/api#deletemessage) for limitations on which messages can be deleted
	MessageIDs []int `json:"message_ids"`
}

DeleteMessagesParams - Represents parameters of deleteMessages method.

func (*DeleteMessagesParams) WithChatID added in v0.29.0 

func (p *DeleteMessagesParams) WithChatID(chatID ChatID) *DeleteMessagesParams

WithChatID adds chat ID parameter

func (*DeleteMessagesParams) WithMessageIDs added in v0.29.0 

func (p *DeleteMessagesParams) WithMessageIDs(messageIDs ...int) *DeleteMessagesParams

WithMessageIDs adds message ids parameter

type DeleteMyCommandsParams 

type DeleteMyCommandsParams struct {
	// Scope - Optional. A JSON-serialized object, describing scope of users for which the commands are
	// relevant. Defaults to BotCommandScopeDefault (https://core.telegram.org/bots/api#botcommandscopedefault).
	Scope BotCommandScope `json:"scope,omitempty"`

	// LanguageCode - 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
	LanguageCode string `json:"language_code,omitempty"`
}

DeleteMyCommandsParams - Represents parameters of deleteMyCommands method.

func (*DeleteMyCommandsParams) WithLanguageCode added in v0.10.0 

func (p *DeleteMyCommandsParams) WithLanguageCode(languageCode string) *DeleteMyCommandsParams

WithLanguageCode adds language code parameter

func (*DeleteMyCommandsParams) WithScope added in v0.10.0 

func (p *DeleteMyCommandsParams) WithScope(scope BotCommandScope) *DeleteMyCommandsParams

WithScope adds scope parameter

type DeleteStickerFromSetParams 

type DeleteStickerFromSetParams struct {
	// Sticker - File identifier of the sticker
	Sticker string `json:"sticker"`
}

DeleteStickerFromSetParams - Represents parameters of deleteStickerFromSet method.

func (*DeleteStickerFromSetParams) WithSticker added in v0.10.0 

func (p *DeleteStickerFromSetParams) WithSticker(sticker string) *DeleteStickerFromSetParams

WithSticker adds sticker parameter

type DeleteStickerSetParams added in v0.22.0 

type DeleteStickerSetParams struct {
	// Name - Sticker set name
	Name string `json:"name"`
}

DeleteStickerSetParams - Represents parameters of deleteStickerSet method.

func (*DeleteStickerSetParams) WithName added in v0.22.0 

func (p *DeleteStickerSetParams) WithName(name string) *DeleteStickerSetParams

WithName adds name parameter

type DeleteStoryParams added in v1.1.0 

type DeleteStoryParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// StoryID - Unique identifier of the story to delete
	StoryID int `json:"story_id"`
}

DeleteStoryParams - Represents parameters of deleteStory method.

func (*DeleteStoryParams) WithBusinessConnectionID added in v1.1.0 

func (p *DeleteStoryParams) WithBusinessConnectionID(businessConnectionID string) *DeleteStoryParams

WithBusinessConnectionID adds business connection ID parameter

func (*DeleteStoryParams) WithStoryID added in v1.1.0 

func (p *DeleteStoryParams) WithStoryID(storyID int) *DeleteStoryParams

WithStoryID adds story ID parameter

type DeleteWebhookParams 

type DeleteWebhookParams struct {
	// DropPendingUpdates - Optional. Pass True to drop all pending updates
	DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
}

DeleteWebhookParams - Represents parameters of deleteWebhook method.

func (*DeleteWebhookParams) WithDropPendingUpdates added in v0.10.0 

func (p *DeleteWebhookParams) WithDropPendingUpdates() *DeleteWebhookParams

WithDropPendingUpdates adds drop pending updates parameter

type Dice 

type Dice struct {
	// Emoji - Emoji on which the dice throw animation is based
	Emoji string `json:"emoji"`

	// Value - Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀”
	// and “⚽” base emoji, 1-64 for “🎰” base emoji
	Value int `json:"value"`
}

Dice - This object represents an animated emoji that displays a random value.

type DirectMessagePriceChanged added in v1.2.0 

type DirectMessagePriceChanged struct {
	// AreDirectMessagesEnabled - True, if direct messages are enabled for the channel chat; false otherwise
	AreDirectMessagesEnabled bool `json:"are_direct_messages_enabled"`

	// DirectMessageStarCount - Optional. The new number of Telegram Stars that must be paid by users for each
	// direct message sent to the channel. Does not apply to users who have been exempted by administrators.
	// Defaults to 0.
	DirectMessageStarCount int `json:"direct_message_star_count,omitempty"`
}

DirectMessagePriceChanged - Describes a service message about a change in the price of direct messages sent to a channel chat.

type DirectMessagesTopic added in v1.3.0 

type DirectMessagesTopic struct {
	// TopicID - Unique identifier of the topic. 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.
	TopicID int64 `json:"topic_id"`

	// User - Optional. Information about the user that created the topic. Currently, it is always present
	User *User `json:"user,omitempty"`
}

DirectMessagesTopic - Describes a topic of a direct messages chat.

type Document 

type Document struct {
	// 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,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"`
}

Document - This object represents a general file (as opposed to photos (https://core.telegram.org/bots/api#photosize), voice messages (https://core.telegram.org/bots/api#voice) and audio files (https://core.telegram.org/bots/api#audio)).

type EditChatInviteLinkParams 

type EditChatInviteLinkParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// InviteLink - The invite link to edit
	InviteLink string `json:"invite_link"`

	// Name - Optional. Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`

	// ExpireDate - Optional. Point in time (Unix timestamp) when the link will expire
	ExpireDate int64 `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"`

	// CreatesJoinRequest - Optional. True, if users joining the chat via the link need to be approved by chat
	// administrators. If True, member_limit can't be specified
	CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
}

EditChatInviteLinkParams - Represents parameters of editChatInviteLink method.

func (*EditChatInviteLinkParams) WithChatID added in v0.10.0 

func (p *EditChatInviteLinkParams) WithChatID(chatID ChatID) *EditChatInviteLinkParams

WithChatID adds chat ID parameter

func (*EditChatInviteLinkParams) WithCreatesJoinRequest added in v0.10.0 

func (p *EditChatInviteLinkParams) WithCreatesJoinRequest() *EditChatInviteLinkParams

WithCreatesJoinRequest adds creates join request parameter

func (*EditChatInviteLinkParams) WithExpireDate added in v1.1.0 

func (p *EditChatInviteLinkParams) WithExpireDate(expireDate int64) *EditChatInviteLinkParams

WithExpireDate adds expire date parameter 

func (p *EditChatInviteLinkParams) WithInviteLink(inviteLink string) *EditChatInviteLinkParams

WithInviteLink adds invite link parameter

func (*EditChatInviteLinkParams) WithMemberLimit added in v0.10.0 

func (p *EditChatInviteLinkParams) WithMemberLimit(memberLimit int) *EditChatInviteLinkParams

WithMemberLimit adds member limit parameter

func (*EditChatInviteLinkParams) WithName added in v0.10.0 

func (p *EditChatInviteLinkParams) WithName(name string) *EditChatInviteLinkParams

WithName adds name parameter

type EditChatSubscriptionInviteLinkParams added in v0.31.2 

type EditChatSubscriptionInviteLinkParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// InviteLink - The invite link to edit
	InviteLink string `json:"invite_link"`

	// Name - Optional. Invite link name; 0-32 characters
	Name string `json:"name,omitempty"`
}

EditChatSubscriptionInviteLinkParams - Represents parameters of editChatSubscriptionInviteLink method.

func (*EditChatSubscriptionInviteLinkParams) WithChatID added in v0.31.2 

func (p *EditChatSubscriptionInviteLinkParams) WithChatID(chatID ChatID) *EditChatSubscriptionInviteLinkParams

WithChatID adds chat ID parameter 

func (p *EditChatSubscriptionInviteLinkParams) WithInviteLink(inviteLink string) *EditChatSubscriptionInviteLinkParams

WithInviteLink adds invite link parameter

func (*EditChatSubscriptionInviteLinkParams) WithName added in v0.31.2 

func (p *EditChatSubscriptionInviteLinkParams) WithName(name string) *EditChatSubscriptionInviteLinkParams

WithName adds name parameter

type EditForumTopicParams added in v0.17.1 

type EditForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Unique identifier for the target message thread of the forum topic
	MessageThreadID int `json:"message_thread_id"`

	// 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,omitempty"`

	// IconCustomEmojiID - Optional. New unique identifier of the custom emoji shown as the topic icon. Use
	// getForumTopicIconStickers (https://core.telegram.org/bots/api#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,omitempty"`
}

EditForumTopicParams - Represents parameters of editForumTopic method.

func (*EditForumTopicParams) WithChatID added in v0.17.1 

func (p *EditForumTopicParams) WithChatID(chatID ChatID) *EditForumTopicParams

WithChatID adds chat ID parameter

func (*EditForumTopicParams) WithIconCustomEmojiID added in v0.17.1 

func (p *EditForumTopicParams) WithIconCustomEmojiID(iconCustomEmojiID string) *EditForumTopicParams

WithIconCustomEmojiID adds icon custom emoji ID parameter

func (*EditForumTopicParams) WithMessageThreadID added in v0.17.1 

func (p *EditForumTopicParams) WithMessageThreadID(messageThreadID int) *EditForumTopicParams

WithMessageThreadID adds message thread ID parameter

func (*EditForumTopicParams) WithName added in v0.17.1 

func (p *EditForumTopicParams) WithName(name string) *EditForumTopicParams

WithName adds name parameter

type EditGeneralForumTopicParams added in v0.18.1 

type EditGeneralForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// Name - New topic name, 1-128 characters
	Name string `json:"name"`
}

EditGeneralForumTopicParams - Represents parameters of editGeneralForumTopic method.

func (*EditGeneralForumTopicParams) WithChatID added in v0.18.1 

func (p *EditGeneralForumTopicParams) WithChatID(chatID ChatID) *EditGeneralForumTopicParams

WithChatID adds chat ID parameter

func (*EditGeneralForumTopicParams) WithName added in v0.18.1 

func (p *EditGeneralForumTopicParams) WithName(name string) *EditGeneralForumTopicParams

WithName adds name parameter

type EditMessageCaptionParams 

type EditMessageCaptionParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit
	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"`

	// Caption - Optional. New caption of the message, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the message caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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.
	// Supported only for animation, photo and video messages.
	ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageCaptionParams - Represents parameters of editMessageCaption method.

func (*EditMessageCaptionParams) WithBusinessConnectionID added in v0.31.0 

func (p *EditMessageCaptionParams) WithBusinessConnectionID(businessConnectionID string) *EditMessageCaptionParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageCaptionParams) WithCaption added in v0.10.0 

func (p *EditMessageCaptionParams) WithCaption(caption string) *EditMessageCaptionParams

WithCaption adds caption parameter

func (*EditMessageCaptionParams) WithCaptionEntities added in v0.10.0 

func (p *EditMessageCaptionParams) WithCaptionEntities(captionEntities ...MessageEntity) *EditMessageCaptionParams

WithCaptionEntities adds caption entities parameter

func (*EditMessageCaptionParams) WithChatID added in v0.10.0 

func (p *EditMessageCaptionParams) WithChatID(chatID ChatID) *EditMessageCaptionParams

WithChatID adds chat ID parameter

func (*EditMessageCaptionParams) WithInlineMessageID added in v0.10.0 

func (p *EditMessageCaptionParams) WithInlineMessageID(inlineMessageID string) *EditMessageCaptionParams

WithInlineMessageID adds inline message ID parameter

func (*EditMessageCaptionParams) WithMessageID added in v0.10.0 

func (p *EditMessageCaptionParams) WithMessageID(messageID int) *EditMessageCaptionParams

WithMessageID adds message ID parameter

func (*EditMessageCaptionParams) WithParseMode added in v0.10.0 

func (p *EditMessageCaptionParams) WithParseMode(parseMode string) *EditMessageCaptionParams

WithParseMode adds parse mode parameter

func (*EditMessageCaptionParams) WithReplyMarkup added in v0.10.0 

func (p *EditMessageCaptionParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *EditMessageCaptionParams

WithReplyMarkup adds reply markup parameter

func (*EditMessageCaptionParams) WithShowCaptionAboveMedia added in v0.30.2 

func (p *EditMessageCaptionParams) WithShowCaptionAboveMedia() *EditMessageCaptionParams

WithShowCaptionAboveMedia adds show caption above media parameter

type EditMessageChecklistParams added in v1.2.0 

type EditMessageChecklistParams struct {
	// BusinessConnectionID - Unique identifier of the business connection on behalf of which the message will
	// be sent
	BusinessConnectionID string `json:"business_connection_id"`

	// ChatID - Unique identifier for the target chat
	ChatID int64 `json:"chat_id"`

	// MessageID - Unique identifier for the target message
	MessageID int `json:"message_id"`

	// Checklist - A JSON-serialized object for the new checklist
	Checklist InputChecklist `json:"checklist"`

	// ReplyMarkup - Optional. A JSON-serialized object for the new inline keyboard for the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageChecklistParams - Represents parameters of editMessageChecklist method.

func (*EditMessageChecklistParams) WithBusinessConnectionID added in v1.2.0 

func (p *EditMessageChecklistParams) WithBusinessConnectionID(businessConnectionID string) *EditMessageChecklistParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageChecklistParams) WithChatID added in v1.2.0 

func (p *EditMessageChecklistParams) WithChatID(chatID int64) *EditMessageChecklistParams

WithChatID adds chat ID parameter

func (*EditMessageChecklistParams) WithChecklist added in v1.2.0 

func (p *EditMessageChecklistParams) WithChecklist(checklist InputChecklist) *EditMessageChecklistParams

WithChecklist adds checklist parameter

func (*EditMessageChecklistParams) WithMessageID added in v1.2.0 

func (p *EditMessageChecklistParams) WithMessageID(messageID int) *EditMessageChecklistParams

WithMessageID adds message ID parameter

func (*EditMessageChecklistParams) WithReplyMarkup added in v1.2.0 

func (p *EditMessageChecklistParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *EditMessageChecklistParams

WithReplyMarkup adds reply markup parameter

type EditMessageLiveLocationParams 

type EditMessageLiveLocationParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit
	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"`

	// Latitude - Latitude of new location
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of new location
	Longitude float64 `json:"longitude"`

	// LivePeriod - Optional. New period in seconds during which the location can be updated, starting from the
	// message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new
	// value must not exceed the current live_period by more than a day, and the live location expiration date must
	// remain within the next 90 days. If not specified, then live_period remains unchanged
	LivePeriod int `json:"live_period,omitempty"`

	// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// Heading - Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if
	// specified.
	Heading int `json:"heading,omitempty"`

	// ProximityAlertRadius - Optional. The maximum distance for proximity alerts about approaching another chat
	// member, in meters. Must be between 1 and 100000 if specified.
	ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageLiveLocationParams - Represents parameters of editMessageLiveLocation method.

func (*EditMessageLiveLocationParams) WithBusinessConnectionID added in v0.31.0 

func (p *EditMessageLiveLocationParams) WithBusinessConnectionID(businessConnectionID string,
) *EditMessageLiveLocationParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageLiveLocationParams) WithChatID added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithChatID(chatID ChatID) *EditMessageLiveLocationParams

WithChatID adds chat ID parameter

func (*EditMessageLiveLocationParams) WithHeading added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithHeading(heading int) *EditMessageLiveLocationParams

WithHeading adds heading parameter

func (*EditMessageLiveLocationParams) WithHorizontalAccuracy added in v1.1.0 

func (p *EditMessageLiveLocationParams) WithHorizontalAccuracy(horizontalAccuracy float64,
) *EditMessageLiveLocationParams

WithHorizontalAccuracy adds horizontal accuracy parameter

func (*EditMessageLiveLocationParams) WithInlineMessageID added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithInlineMessageID(inlineMessageID string) *EditMessageLiveLocationParams

WithInlineMessageID adds inline message ID parameter

func (*EditMessageLiveLocationParams) WithLatitude added in v1.1.0 

func (p *EditMessageLiveLocationParams) WithLatitude(latitude float64) *EditMessageLiveLocationParams

WithLatitude adds latitude parameter

func (*EditMessageLiveLocationParams) WithLivePeriod added in v0.30.1 

func (p *EditMessageLiveLocationParams) WithLivePeriod(livePeriod int) *EditMessageLiveLocationParams

WithLivePeriod adds live period parameter

func (*EditMessageLiveLocationParams) WithLongitude added in v1.1.0 

func (p *EditMessageLiveLocationParams) WithLongitude(longitude float64) *EditMessageLiveLocationParams

WithLongitude adds longitude parameter

func (*EditMessageLiveLocationParams) WithMessageID added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithMessageID(messageID int) *EditMessageLiveLocationParams

WithMessageID adds message ID parameter

func (*EditMessageLiveLocationParams) WithProximityAlertRadius added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithProximityAlertRadius(proximityAlertRadius int,
) *EditMessageLiveLocationParams

WithProximityAlertRadius adds proximity alert radius parameter

func (*EditMessageLiveLocationParams) WithReplyMarkup added in v0.10.0 

func (p *EditMessageLiveLocationParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *EditMessageLiveLocationParams

WithReplyMarkup adds reply markup parameter

type EditMessageMediaParams 

type EditMessageMediaParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit
	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"`

	// Media - A JSON-serialized object for a new media content of the message
	Media InputMedia `json:"media"`

	// ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageMediaParams - Represents parameters of editMessageMedia method.

func (*EditMessageMediaParams) WithBusinessConnectionID added in v0.31.0 

func (p *EditMessageMediaParams) WithBusinessConnectionID(businessConnectionID string) *EditMessageMediaParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageMediaParams) WithChatID added in v0.10.0 

func (p *EditMessageMediaParams) WithChatID(chatID ChatID) *EditMessageMediaParams

WithChatID adds chat ID parameter

func (*EditMessageMediaParams) WithInlineMessageID added in v0.10.0 

func (p *EditMessageMediaParams) WithInlineMessageID(inlineMessageID string) *EditMessageMediaParams

WithInlineMessageID adds inline message ID parameter

func (*EditMessageMediaParams) WithMedia added in v0.10.0 

func (p *EditMessageMediaParams) WithMedia(media InputMedia) *EditMessageMediaParams

WithMedia adds media parameter

func (*EditMessageMediaParams) WithMessageID added in v0.10.0 

func (p *EditMessageMediaParams) WithMessageID(messageID int) *EditMessageMediaParams

WithMessageID adds message ID parameter

func (*EditMessageMediaParams) WithReplyMarkup added in v0.10.0 

func (p *EditMessageMediaParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *EditMessageMediaParams

WithReplyMarkup adds reply markup parameter

type EditMessageReplyMarkupParams 

type EditMessageReplyMarkupParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit
	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"`

	// ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageReplyMarkupParams - Represents parameters of editMessageReplyMarkup method.

func (*EditMessageReplyMarkupParams) WithBusinessConnectionID added in v0.31.0 

func (p *EditMessageReplyMarkupParams) WithBusinessConnectionID(businessConnectionID string,
) *EditMessageReplyMarkupParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageReplyMarkupParams) WithChatID added in v0.10.0 

func (p *EditMessageReplyMarkupParams) WithChatID(chatID ChatID) *EditMessageReplyMarkupParams

WithChatID adds chat ID parameter

func (*EditMessageReplyMarkupParams) WithInlineMessageID added in v0.10.0 

func (p *EditMessageReplyMarkupParams) WithInlineMessageID(inlineMessageID string) *EditMessageReplyMarkupParams

WithInlineMessageID adds inline message ID parameter

func (*EditMessageReplyMarkupParams) WithMessageID added in v0.10.0 

func (p *EditMessageReplyMarkupParams) WithMessageID(messageID int) *EditMessageReplyMarkupParams

WithMessageID adds message ID parameter

func (*EditMessageReplyMarkupParams) WithReplyMarkup added in v0.10.0 

func (p *EditMessageReplyMarkupParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *EditMessageReplyMarkupParams

WithReplyMarkup adds reply markup parameter

type EditMessageTextParams 

type EditMessageTextParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message to edit
	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"`

	// Text - New text of the message, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// ParseMode - Optional. Mode for parsing entities in the message text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `json:"parse_mode,omitempty"`

	// Entities - Optional. A JSON-serialized list of special entities that appear in message text, which can be
	// specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`

	// LinkPreviewOptions - Optional. Link preview generation options for the message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

EditMessageTextParams - Represents parameters of editMessageText method.

func (*EditMessageTextParams) WithBusinessConnectionID added in v0.31.0 

func (p *EditMessageTextParams) WithBusinessConnectionID(businessConnectionID string) *EditMessageTextParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditMessageTextParams) WithChatID added in v0.10.0 

func (p *EditMessageTextParams) WithChatID(chatID ChatID) *EditMessageTextParams

WithChatID adds chat ID parameter

func (*EditMessageTextParams) WithEntities added in v0.10.0 

func (p *EditMessageTextParams) WithEntities(entities ...MessageEntity) *EditMessageTextParams

WithEntities adds entities parameter

func (*EditMessageTextParams) WithInlineMessageID added in v0.10.0 

func (p *EditMessageTextParams) WithInlineMessageID(inlineMessageID string) *EditMessageTextParams

WithInlineMessageID adds inline message ID parameter

func (*EditMessageTextParams) WithLinkPreviewOptions added in v0.29.0 

func (p *EditMessageTextParams) WithLinkPreviewOptions(linkPreviewOptions *LinkPreviewOptions) *EditMessageTextParams

WithLinkPreviewOptions adds link preview options parameter

func (*EditMessageTextParams) WithMessageID added in v0.10.0 

func (p *EditMessageTextParams) WithMessageID(messageID int) *EditMessageTextParams

WithMessageID adds message ID parameter

func (*EditMessageTextParams) WithParseMode added in v0.10.0 

func (p *EditMessageTextParams) WithParseMode(parseMode string) *EditMessageTextParams

WithParseMode adds parse mode parameter

func (*EditMessageTextParams) WithReplyMarkup added in v0.10.0 

func (p *EditMessageTextParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *EditMessageTextParams

WithReplyMarkup adds reply markup parameter

func (*EditMessageTextParams) WithText added in v0.10.0 

func (p *EditMessageTextParams) WithText(text string) *EditMessageTextParams

WithText adds text parameter

type EditStoryParams added in v1.1.0 

type EditStoryParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// StoryID - Unique identifier of the story to edit
	StoryID int `json:"story_id"`

	// Content - Content of the story
	Content InputStoryContent `json:"content"`

	// 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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 - Optional. A JSON-serialized list of clickable areas to be shown on the story
	Areas []StoryArea `json:"areas,omitempty"`
}

EditStoryParams - Represents parameters of editStory method.

func (*EditStoryParams) WithAreas added in v1.1.0 

func (p *EditStoryParams) WithAreas(areas ...StoryArea) *EditStoryParams

WithAreas adds areas parameter

func (*EditStoryParams) WithBusinessConnectionID added in v1.1.0 

func (p *EditStoryParams) WithBusinessConnectionID(businessConnectionID string) *EditStoryParams

WithBusinessConnectionID adds business connection ID parameter

func (*EditStoryParams) WithCaption added in v1.1.0 

func (p *EditStoryParams) WithCaption(caption string) *EditStoryParams

WithCaption adds caption parameter

func (*EditStoryParams) WithCaptionEntities added in v1.1.0 

func (p *EditStoryParams) WithCaptionEntities(captionEntities ...MessageEntity) *EditStoryParams

WithCaptionEntities adds caption entities parameter

func (*EditStoryParams) WithContent added in v1.1.0 

func (p *EditStoryParams) WithContent(content InputStoryContent) *EditStoryParams

WithContent adds content parameter

func (*EditStoryParams) WithParseMode added in v1.1.0 

func (p *EditStoryParams) WithParseMode(parseMode string) *EditStoryParams

WithParseMode adds parse mode parameter

func (*EditStoryParams) WithStoryID added in v1.1.0 

func (p *EditStoryParams) WithStoryID(storyID int) *EditStoryParams

WithStoryID adds story ID parameter

type EditUserStarSubscriptionParams added in v0.32.0 

type EditUserStarSubscriptionParams struct {
	// UserID - Identifier of the user whose subscription will be edited
	UserID int64 `json:"user_id"`

	// TelegramPaymentChargeID - Telegram payment identifier for the subscription
	TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`

	// IsCanceled - 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"`
}

EditUserStarSubscriptionParams - Represents parameters of editUserStarSubscription method.

func (*EditUserStarSubscriptionParams) WithIsCanceled added in v0.32.0 

func (p *EditUserStarSubscriptionParams) WithIsCanceled() *EditUserStarSubscriptionParams

WithIsCanceled adds is canceled parameter

func (*EditUserStarSubscriptionParams) WithTelegramPaymentChargeID added in v0.32.0 

func (p *EditUserStarSubscriptionParams) WithTelegramPaymentChargeID(telegramPaymentChargeID string,
) *EditUserStarSubscriptionParams

WithTelegramPaymentChargeID adds telegram payment charge ID parameter

func (*EditUserStarSubscriptionParams) WithUserID added in v1.1.0 

func (p *EditUserStarSubscriptionParams) WithUserID(userID int64) *EditUserStarSubscriptionParams

WithUserID adds user ID parameter

type EncryptedCredentials 

type EncryptedCredentials struct {
	// Data - Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets
	// required for EncryptedPassportElement (https://core.telegram.org/bots/api#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"`
}

EncryptedCredentials - Describes data required for decrypting and authenticating EncryptedPassportElement (https://core.telegram.org/bots/api#encryptedpassportelement). See the Telegram Passport Documentation (https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes.

type EncryptedPassportElement 

type EncryptedPassportElement struct {
	// Type - Element type. One of “personal_details”, “passport”, “driver_license”,
	// “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”,
	// “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”,
	// “email”.
	Type string `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 (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#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
	// (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#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
	// (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#encryptedcredentials).
	Translation []PassportFile `json:"translation,omitempty"`

	// Hash - Base64-encoded element hash for using in PassportElementErrorUnspecified
	// (https://core.telegram.org/bots/api#passportelementerrorunspecified)
	Hash string `json:"hash"`
}

EncryptedPassportElement - Describes documents or other Telegram Passport elements shared with the bot by the user.

type ExportChatInviteLinkParams 

type ExportChatInviteLinkParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`
}

ExportChatInviteLinkParams - Represents parameters of exportChatInviteLink method.

func (*ExportChatInviteLinkParams) WithChatID added in v0.10.0 

func (p *ExportChatInviteLinkParams) WithChatID(chatID ChatID) *ExportChatInviteLinkParams

WithChatID adds chat ID parameter

type ExternalReplyInfo added in v0.29.0 

type ExternalReplyInfo struct {
	// Origin - Origin of the message replied to by the given message
	Origin MessageOrigin `json:"origin"`

	// Chat - Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a
	// channel.
	Chat *Chat `json:"chat,omitempty"`

	// MessageID - Optional. Unique message identifier inside the original chat. Available only if the original
	// chat is a supergroup or a channel.
	MessageID int `json:"message_id,omitempty"`

	// LinkPreviewOptions - Optional. Options used for link preview generation for the original message, if it
	// is a text message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// Animation - Optional. Message is an animation, information about the animation
	Animation *Animation `json:"animation,omitempty"`

	// Audio - Optional. Message is an audio file, information about the file
	Audio *Audio `json:"audio,omitempty"`

	// Document - Optional. Message is a general file, information about the file
	Document *Document `json:"document,omitempty"`

	// PaidMedia - Optional. Message contains paid media; information about the paid media
	PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`

	// Photo - Optional. Message is a photo, available sizes of the photo
	Photo []PhotoSize `json:"photo,omitempty"`

	// Sticker - Optional. Message is a sticker, information about the sticker
	Sticker *Sticker `json:"sticker,omitempty"`

	// Story - Optional. Message is a forwarded story
	Story *Story `json:"story,omitempty"`

	// Video - Optional. Message is a video, information about the video
	Video *Video `json:"video,omitempty"`

	// VideoNote - Optional. Message is a video note (https://telegram.org/blog/video-messages-and-telescope),
	// information about the video message
	VideoNote *VideoNote `json:"video_note,omitempty"`

	// Voice - Optional. Message is a voice message, information about the file
	Voice *Voice `json:"voice,omitempty"`

	// HasMediaSpoiler - Optional. True, if the message media is covered by a spoiler animation
	HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"`

	// Checklist - Optional. Message is a checklist
	Checklist *Checklist `json:"checklist,omitempty"`

	// Contact - Optional. Message is a shared contact, information about the contact
	Contact *Contact `json:"contact,omitempty"`

	// Dice - Optional. Message is a dice with random value
	Dice *Dice `json:"dice,omitempty"`

	// Game - Optional. Message is a game, information about the game. More about games »
	// (https://core.telegram.org/bots/api#games)
	Game *Game `json:"game,omitempty"`

	// Giveaway - Optional. Message is a scheduled giveaway, information about the giveaway
	Giveaway *Giveaway `json:"giveaway,omitempty"`

	// GiveawayWinners - Optional. A giveaway with public winners was completed
	GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`

	// Invoice - Optional. Message is an invoice for a payment (https://core.telegram.org/bots/api#payments),
	// information about the invoice. More about payments » (https://core.telegram.org/bots/api#payments)
	Invoice *Invoice `json:"invoice,omitempty"`

	// Location - Optional. Message is a shared location, information about the location
	Location *Location `json:"location,omitempty"`

	// Poll - Optional. Message is a native poll, information about the poll
	Poll *Poll `json:"poll,omitempty"`

	// Venue - Optional. Message is a venue, information about the venue
	Venue *Venue `json:"venue,omitempty"`
}

ExternalReplyInfo - This object contains information about a message that is being replied to, which may come from another chat or forum topic.

func (*ExternalReplyInfo) UnmarshalJSON added in v0.29.0 

func (e *ExternalReplyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ExternalReplyInfo

type File 

type File struct {
	// 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 - 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"`

	// FilePath - Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
	FilePath string `json:"file_path,omitempty"`
}

File - This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile (https://core.telegram.org/bots/api#getfile). The maximum file size to download is 20 MB

type ForceReply 

type ForceReply struct {
	// ForceReply - Shows reply interface to the user, as if they manually selected the bot's message and tapped
	// 'Reply'
	ForceReply bool `json:"force_reply"`

	// InputFieldPlaceholder - Optional. The placeholder to be shown in the input field when the reply is
	// active; 1-64 characters
	InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`

	// Selective - Optional. Use this parameter if you want to force reply from specific users only. Targets: 1)
	// users that are @mentioned in the text of the Message (https://core.telegram.org/bots/api#message) object; 2)
	// if the bot's message is a reply to a message in the same chat and forum topic, sender of the original
	// message.
	Selective bool `json:"selective,omitempty"`
}

ForceReply - Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode (https://core.telegram.org/bots/features#privacy-mode). Not supported in channels and for messages sent on behalf of a Telegram Business account.

func (*ForceReply) ReplyType 

func (f *ForceReply) ReplyType() string

ReplyType returns ForceReply type

func (*ForceReply) WithForceReply added in v0.10.0 

func (f *ForceReply) WithForceReply() *ForceReply

WithForceReply adds force reply parameter

func (*ForceReply) WithInputFieldPlaceholder added in v0.10.0 

func (f *ForceReply) WithInputFieldPlaceholder(inputFieldPlaceholder string) *ForceReply

WithInputFieldPlaceholder adds input field placeholder parameter

func (*ForceReply) WithSelective added in v0.10.0 

func (f *ForceReply) WithSelective() *ForceReply

WithSelective adds selective parameter

type ForumTopic added in v0.17.1 

type ForumTopic struct {
	// 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 - 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"`
}

ForumTopic - This object represents a forum topic.

type ForumTopicClosed added in v0.17.1 

type ForumTopicClosed struct{}

ForumTopicClosed - This object represents a service message about a forum topic closed in the chat. Currently holds no information.

type ForumTopicCreated added in v0.17.1 

type ForumTopicCreated struct {
	// 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 - 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"`
}

ForumTopicCreated - This object represents a service message about a new forum topic created in the chat.

type ForumTopicEdited added in v0.18.1 

type ForumTopicEdited struct {
	// 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"`
}

ForumTopicEdited - This object represents a service message about an edited forum topic.

type ForumTopicReopened added in v0.17.1 

type ForumTopicReopened struct{}

ForumTopicReopened - This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

type ForwardMessageParams 

type ForwardMessageParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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
	// forwarded; required if the message is forwarded to a direct messages chat
	DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`

	// FromChatID - Unique identifier for the chat where the original message was sent (or channel username in
	// the format @channel_username)
	FromChatID ChatID `json:"from_chat_id"`

	// VideoStartTimestamp - Optional. New start timestamp for the forwarded video in the message
	VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
	DisableNotification bool `json:"disable_notification,omitempty"`

	// ProtectContent - Optional. Protects the contents of the forwarded message from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`

	// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; only
	// available when forwarding to private chats
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// SuggestedPostParameters - Optional. A JSON-serialized object containing the parameters of the suggested
	// post to send; for direct messages chats only
	SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`

	// MessageID - Message identifier in the chat specified in from_chat_id
	MessageID int `json:"message_id"`
}

ForwardMessageParams - Represents parameters of forwardMessage method.

func (*ForwardMessageParams) WithChatID added in v0.10.0 

func (p *ForwardMessageParams) WithChatID(chatID ChatID) *ForwardMessageParams

WithChatID adds chat ID parameter

func (*ForwardMessageParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *ForwardMessageParams) WithDirectMessagesTopicID(directMessagesTopicID int) *ForwardMessageParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*ForwardMessageParams) WithDisableNotification added in v0.10.0 

func (p *ForwardMessageParams) WithDisableNotification() *ForwardMessageParams

WithDisableNotification adds disable notification parameter

func (*ForwardMessageParams) WithFromChatID added in v0.10.0 

func (p *ForwardMessageParams) WithFromChatID(fromChatID ChatID) *ForwardMessageParams

WithFromChatID adds from chat ID parameter

func (*ForwardMessageParams) WithMessageEffectID added in v1.4.0 

func (p *ForwardMessageParams) WithMessageEffectID(messageEffectID string) *ForwardMessageParams

WithMessageEffectID adds message effect ID parameter

func (*ForwardMessageParams) WithMessageID added in v0.10.0 

func (p *ForwardMessageParams) WithMessageID(messageID int) *ForwardMessageParams

WithMessageID adds message ID parameter

func (*ForwardMessageParams) WithMessageThreadID added in v0.17.1 

func (p *ForwardMessageParams) WithMessageThreadID(messageThreadID int) *ForwardMessageParams

WithMessageThreadID adds message thread ID parameter

func (*ForwardMessageParams) WithProtectContent added in v0.10.0 

func (p *ForwardMessageParams) WithProtectContent() *ForwardMessageParams

WithProtectContent adds protect content parameter

func (*ForwardMessageParams) WithSuggestedPostParameters added in v1.3.0 

func (p *ForwardMessageParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *ForwardMessageParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*ForwardMessageParams) WithVideoStartTimestamp added in v1.0.2 

func (p *ForwardMessageParams) WithVideoStartTimestamp(videoStartTimestamp int) *ForwardMessageParams

WithVideoStartTimestamp adds video start timestamp parameter

type ForwardMessagesParams added in v0.29.0 

type ForwardMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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
	// forwarded; required if the messages are forwarded to a direct messages chat
	DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`

	// FromChatID - Unique identifier for the chat where the original messages were sent (or channel username in
	// the format @channel_username)
	FromChatID ChatID `json:"from_chat_id"`

	// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward.
	// The identifiers must be specified in a strictly increasing order.
	MessageIDs []int `json:"message_ids"`

	// DisableNotification - Optional. Sends the messages silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
	DisableNotification bool `json:"disable_notification,omitempty"`

	// ProtectContent - Optional. Protects the contents of the forwarded messages from forwarding and saving
	ProtectContent bool `json:"protect_content,omitempty"`
}

ForwardMessagesParams - Represents parameters of forwardMessages method.

func (*ForwardMessagesParams) WithChatID added in v0.29.0 

func (p *ForwardMessagesParams) WithChatID(chatID ChatID) *ForwardMessagesParams

WithChatID adds chat ID parameter

func (*ForwardMessagesParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *ForwardMessagesParams) WithDirectMessagesTopicID(directMessagesTopicID int) *ForwardMessagesParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*ForwardMessagesParams) WithDisableNotification added in v0.29.0 

func (p *ForwardMessagesParams) WithDisableNotification() *ForwardMessagesParams

WithDisableNotification adds disable notification parameter

func (*ForwardMessagesParams) WithFromChatID added in v0.29.0 

func (p *ForwardMessagesParams) WithFromChatID(fromChatID ChatID) *ForwardMessagesParams

WithFromChatID adds from chat ID parameter

func (*ForwardMessagesParams) WithMessageIDs added in v0.29.0 

func (p *ForwardMessagesParams) WithMessageIDs(messageIDs ...int) *ForwardMessagesParams

WithMessageIDs adds message ids parameter

func (*ForwardMessagesParams) WithMessageThreadID added in v0.29.0 

func (p *ForwardMessagesParams) WithMessageThreadID(messageThreadID int) *ForwardMessagesParams

WithMessageThreadID adds message thread ID parameter

func (*ForwardMessagesParams) WithProtectContent added in v0.29.0 

func (p *ForwardMessagesParams) WithProtectContent() *ForwardMessagesParams

WithProtectContent adds protect content parameter

type Game 

type Game struct {
	// 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
	// (https://core.telegram.org/bots/api#setgamescore), or manually edited using editMessageText
	// (https://core.telegram.org/bots/api#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 - Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
	// (https://t.me/botfather)
	Animation *Animation `json:"animation,omitempty"`
}

Game - This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

type GameHighScore 

type GameHighScore struct {
	// 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"`
}

GameHighScore - This object represents one row of the high scores table for a game.

type GeneralForumTopicHidden added in v0.18.1 

type GeneralForumTopicHidden struct{}

GeneralForumTopicHidden - This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

type GeneralForumTopicUnhidden added in v0.18.1 

type GeneralForumTopicUnhidden struct{}

GeneralForumTopicUnhidden - This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

type GetBusinessAccountGiftsParams added in v1.1.0 

type GetBusinessAccountGiftsParams struct {
	// BusinessConnectionID - 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"`
}

GetBusinessAccountGiftsParams - Represents parameters of getBusinessAccountGifts method.

func (*GetBusinessAccountGiftsParams) WithBusinessConnectionID added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithBusinessConnectionID(businessConnectionID string,
) *GetBusinessAccountGiftsParams

WithBusinessConnectionID adds business connection ID parameter

func (*GetBusinessAccountGiftsParams) WithExcludeFromBlockchain added in v1.4.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeFromBlockchain() *GetBusinessAccountGiftsParams

WithExcludeFromBlockchain adds exclude from blockchain parameter

func (*GetBusinessAccountGiftsParams) WithExcludeLimitedNonUpgradable added in v1.4.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeLimitedNonUpgradable() *GetBusinessAccountGiftsParams

WithExcludeLimitedNonUpgradable adds exclude limited non upgradable parameter

func (*GetBusinessAccountGiftsParams) WithExcludeLimitedUpgradable added in v1.4.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeLimitedUpgradable() *GetBusinessAccountGiftsParams

WithExcludeLimitedUpgradable adds exclude limited upgradable parameter

func (*GetBusinessAccountGiftsParams) WithExcludeSaved added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeSaved() *GetBusinessAccountGiftsParams

WithExcludeSaved adds exclude saved parameter

func (*GetBusinessAccountGiftsParams) WithExcludeUnique added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeUnique() *GetBusinessAccountGiftsParams

WithExcludeUnique adds exclude unique parameter

func (*GetBusinessAccountGiftsParams) WithExcludeUnlimited added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeUnlimited() *GetBusinessAccountGiftsParams

WithExcludeUnlimited adds exclude unlimited parameter

func (*GetBusinessAccountGiftsParams) WithExcludeUnsaved added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithExcludeUnsaved() *GetBusinessAccountGiftsParams

WithExcludeUnsaved adds exclude unsaved parameter

func (*GetBusinessAccountGiftsParams) WithLimit added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithLimit(limit int) *GetBusinessAccountGiftsParams

WithLimit adds limit parameter

func (*GetBusinessAccountGiftsParams) WithOffset added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithOffset(offset string) *GetBusinessAccountGiftsParams

WithOffset adds offset parameter

func (*GetBusinessAccountGiftsParams) WithSortByPrice added in v1.1.0 

func (p *GetBusinessAccountGiftsParams) WithSortByPrice() *GetBusinessAccountGiftsParams

WithSortByPrice adds sort by price parameter

type GetBusinessAccountStarBalanceParams added in v1.1.0 

type GetBusinessAccountStarBalanceParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`
}

GetBusinessAccountStarBalanceParams - Represents parameters of getBusinessAccountStarBalance method.

func (*GetBusinessAccountStarBalanceParams) WithBusinessConnectionID added in v1.1.0 

func (p *GetBusinessAccountStarBalanceParams) WithBusinessConnectionID(businessConnectionID string,
) *GetBusinessAccountStarBalanceParams

WithBusinessConnectionID adds business connection ID parameter

type GetBusinessConnectionParams added in v0.29.2 

type GetBusinessConnectionParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`
}

GetBusinessConnectionParams - Represents parameters of getBusinessConnection method.

func (*GetBusinessConnectionParams) WithBusinessConnectionID added in v0.29.2 

func (p *GetBusinessConnectionParams) WithBusinessConnectionID(businessConnectionID string,
) *GetBusinessConnectionParams

WithBusinessConnectionID adds business connection ID parameter

type GetChatAdministratorsParams 

type GetChatAdministratorsParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`
}

GetChatAdministratorsParams - Represents parameters of getChatAdministrators method.

func (*GetChatAdministratorsParams) WithChatID added in v0.10.0 

func (p *GetChatAdministratorsParams) WithChatID(chatID ChatID) *GetChatAdministratorsParams

WithChatID adds chat ID parameter

type GetChatGiftsParams added in v1.4.0 

type GetChatGiftsParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// ExcludeUnsaved - Optional. Pass True to exclude gifts that aren't saved to the chat's profile page.
	// Always True, unless the bot has the can_post_messages administrator right in the channel.
	ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`

	// ExcludeSaved - Optional. Pass True to exclude gifts that are saved to the chat's profile page. Always
	// False, unless the bot has the can_post_messages administrator right in the channel.
	ExcludeSaved bool `json:"exclude_saved,omitempty"`

	// 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"`

	// 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"`

	// ExcludeUnique - Optional. Pass True to exclude unique gifts
	ExcludeUnique bool `json:"exclude_unique,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 an
	// 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"`
}

GetChatGiftsParams - Represents parameters of getChatGifts method.

func (*GetChatGiftsParams) WithChatID added in v1.4.0 

func (p *GetChatGiftsParams) WithChatID(chatID ChatID) *GetChatGiftsParams

WithChatID adds chat ID parameter

func (*GetChatGiftsParams) WithExcludeFromBlockchain added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeFromBlockchain() *GetChatGiftsParams

WithExcludeFromBlockchain adds exclude from blockchain parameter

func (*GetChatGiftsParams) WithExcludeLimitedNonUpgradable added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeLimitedNonUpgradable() *GetChatGiftsParams

WithExcludeLimitedNonUpgradable adds exclude limited non upgradable parameter

func (*GetChatGiftsParams) WithExcludeLimitedUpgradable added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeLimitedUpgradable() *GetChatGiftsParams

WithExcludeLimitedUpgradable adds exclude limited upgradable parameter

func (*GetChatGiftsParams) WithExcludeSaved added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeSaved() *GetChatGiftsParams

WithExcludeSaved adds exclude saved parameter

func (*GetChatGiftsParams) WithExcludeUnique added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeUnique() *GetChatGiftsParams

WithExcludeUnique adds exclude unique parameter

func (*GetChatGiftsParams) WithExcludeUnlimited added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeUnlimited() *GetChatGiftsParams

WithExcludeUnlimited adds exclude unlimited parameter

func (*GetChatGiftsParams) WithExcludeUnsaved added in v1.4.0 

func (p *GetChatGiftsParams) WithExcludeUnsaved() *GetChatGiftsParams

WithExcludeUnsaved adds exclude unsaved parameter

func (*GetChatGiftsParams) WithLimit added in v1.4.0 

func (p *GetChatGiftsParams) WithLimit(limit int) *GetChatGiftsParams

WithLimit adds limit parameter

func (*GetChatGiftsParams) WithOffset added in v1.4.0 

func (p *GetChatGiftsParams) WithOffset(offset string) *GetChatGiftsParams

WithOffset adds offset parameter

func (*GetChatGiftsParams) WithSortByPrice added in v1.4.0 

func (p *GetChatGiftsParams) WithSortByPrice() *GetChatGiftsParams

WithSortByPrice adds sort by price parameter

type GetChatMemberCountParams 

type GetChatMemberCountParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`
}

GetChatMemberCountParams - Represents parameters of getChatMemberCount method.

func (*GetChatMemberCountParams) WithChatID added in v0.10.0 

func (p *GetChatMemberCountParams) WithChatID(chatID ChatID) *GetChatMemberCountParams

WithChatID adds chat ID parameter

type GetChatMemberParams 

type GetChatMemberParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

GetChatMemberParams - Represents parameters of getChatMember method.

func (*GetChatMemberParams) WithChatID added in v0.10.0 

func (p *GetChatMemberParams) WithChatID(chatID ChatID) *GetChatMemberParams

WithChatID adds chat ID parameter

func (*GetChatMemberParams) WithUserID added in v1.1.0 

func (p *GetChatMemberParams) WithUserID(userID int64) *GetChatMemberParams

WithUserID adds user ID parameter

type GetChatMenuButtonParams added in v0.11.0 

type GetChatMenuButtonParams struct {
	// ChatID - Optional. Unique identifier for the target private chat. If not specified, default bot's menu
	// button will be returned
	ChatID int64 `json:"chat_id,omitempty"`
}

GetChatMenuButtonParams - Represents parameters of getChatMenuButton method.

func (*GetChatMenuButtonParams) WithChatID added in v1.1.0 

func (p *GetChatMenuButtonParams) WithChatID(chatID int64) *GetChatMenuButtonParams

WithChatID adds chat ID parameter

type GetChatParams 

type GetChatParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`
}

GetChatParams - Represents parameters of getChat method.

func (*GetChatParams) WithChatID added in v0.10.0 

func (p *GetChatParams) WithChatID(chatID ChatID) *GetChatParams

WithChatID adds chat ID parameter

type GetCustomEmojiStickersParams added in v0.16.0 

type GetCustomEmojiStickersParams struct {
	// CustomEmojiIDs - A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers
	// can be specified.
	CustomEmojiIDs []string `json:"custom_emoji_ids"`
}

GetCustomEmojiStickersParams - Represents parameters of getCustomEmojiStickers method.

func (*GetCustomEmojiStickersParams) WithCustomEmojiIDs added in v0.16.0 

func (p *GetCustomEmojiStickersParams) WithCustomEmojiIDs(customEmojiIDs ...string) *GetCustomEmojiStickersParams

WithCustomEmojiIDs adds custom emoji ids parameter

type GetFileParams 

type GetFileParams struct {
	// FileID - File identifier to get information about
	FileID string `json:"file_id"`
}

GetFileParams - Represents parameters of getFile method.

func (*GetFileParams) WithFileID added in v0.10.0 

func (p *GetFileParams) WithFileID(fileID string) *GetFileParams

WithFileID adds file ID parameter

type GetGameHighScoresParams 

type GetGameHighScoresParams struct {
	// UserID - 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"`
}

GetGameHighScoresParams - Represents parameters of getGameHighScores method.

func (*GetGameHighScoresParams) WithChatID added in v1.1.0 

func (p *GetGameHighScoresParams) WithChatID(chatID int64) *GetGameHighScoresParams

WithChatID adds chat ID parameter

func (*GetGameHighScoresParams) WithInlineMessageID added in v0.10.0 

func (p *GetGameHighScoresParams) WithInlineMessageID(inlineMessageID string) *GetGameHighScoresParams

WithInlineMessageID adds inline message ID parameter

func (*GetGameHighScoresParams) WithMessageID added in v0.10.0 

func (p *GetGameHighScoresParams) WithMessageID(messageID int) *GetGameHighScoresParams

WithMessageID adds message ID parameter

func (*GetGameHighScoresParams) WithUserID added in v1.1.0 

func (p *GetGameHighScoresParams) WithUserID(userID int64) *GetGameHighScoresParams

WithUserID adds user ID parameter

type GetMyCommandsParams 

type GetMyCommandsParams struct {
	// Scope - Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault
	// (https://core.telegram.org/bots/api#botcommandscopedefault).
	Scope BotCommandScope `json:"scope,omitempty"`

	// LanguageCode - Optional. A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

GetMyCommandsParams - Represents parameters of getMyCommands method.

func (*GetMyCommandsParams) WithLanguageCode added in v0.10.0 

func (p *GetMyCommandsParams) WithLanguageCode(languageCode string) *GetMyCommandsParams

WithLanguageCode adds language code parameter

func (*GetMyCommandsParams) WithScope added in v0.10.0 

func (p *GetMyCommandsParams) WithScope(scope BotCommandScope) *GetMyCommandsParams

WithScope adds scope parameter

type GetMyDefaultAdministratorRightsParams added in v0.11.0 

type GetMyDefaultAdministratorRightsParams 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,omitempty"`
}

GetMyDefaultAdministratorRightsParams - Represents parameters of getMyDefaultAdministratorRights method.

func (*GetMyDefaultAdministratorRightsParams) WithForChannels added in v0.11.0 

func (p *GetMyDefaultAdministratorRightsParams) WithForChannels() *GetMyDefaultAdministratorRightsParams

WithForChannels adds for channels parameter

type GetMyDescriptionParams added in v0.22.0 

type GetMyDescriptionParams struct {
	// LanguageCode - Optional. A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

GetMyDescriptionParams - Represents parameters of getMyDescription method.

func (*GetMyDescriptionParams) WithLanguageCode added in v0.22.0 

func (p *GetMyDescriptionParams) WithLanguageCode(languageCode string) *GetMyDescriptionParams

WithLanguageCode adds language code parameter

type GetMyNameParams added in v0.22.1 

type GetMyNameParams struct {
	// LanguageCode - Optional. A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

GetMyNameParams - Represents parameters of getMyName method.

func (*GetMyNameParams) WithLanguageCode added in v0.22.1 

func (p *GetMyNameParams) WithLanguageCode(languageCode string) *GetMyNameParams

WithLanguageCode adds language code parameter

type GetMyShortDescriptionParams added in v0.22.0 

type GetMyShortDescriptionParams struct {
	// LanguageCode - Optional. A two-letter ISO 639-1 language code or an empty string
	LanguageCode string `json:"language_code,omitempty"`
}

GetMyShortDescriptionParams - Represents parameters of getMyShortDescription method.

func (*GetMyShortDescriptionParams) WithLanguageCode added in v0.22.0 

func (p *GetMyShortDescriptionParams) WithLanguageCode(languageCode string) *GetMyShortDescriptionParams

WithLanguageCode adds language code parameter

type GetStarTransactionsParams added in v0.31.0 

type GetStarTransactionsParams struct {
	// Offset - Optional. Number of transactions to skip in the response
	Offset int `json:"offset,omitempty"`

	// Limit - Optional. The maximum number of transactions to be retrieved. Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int `json:"limit,omitempty"`
}

GetStarTransactionsParams - Represents parameters of getStarTransactions method.

func (*GetStarTransactionsParams) WithLimit added in v0.31.0 

func (p *GetStarTransactionsParams) WithLimit(limit int) *GetStarTransactionsParams

WithLimit adds limit parameter

func (*GetStarTransactionsParams) WithOffset added in v0.31.0 

func (p *GetStarTransactionsParams) WithOffset(offset int) *GetStarTransactionsParams

WithOffset adds offset parameter

type GetStickerSetParams 

type GetStickerSetParams struct {
	// Name - Name of the sticker set
	Name string `json:"name"`
}

GetStickerSetParams - Represents parameters of getStickerSet method.

func (*GetStickerSetParams) WithName added in v0.10.0 

func (p *GetStickerSetParams) WithName(name string) *GetStickerSetParams

WithName adds name parameter

type GetUpdatesParams 

type GetUpdatesParams struct {
	// Offset - Optional. Identifier of the first update to be returned. Must be greater by one than the highest
	// among the identifiers of previously received updates. By default, updates starting with the earliest
	// unconfirmed update are returned. An update is considered confirmed as soon as getUpdates
	// (https://core.telegram.org/bots/api#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 (https://core.telegram.org/bots/api#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 []string `json:"allowed_updates,omitempty"`
}

GetUpdatesParams - Represents parameters of getUpdates method.

func (*GetUpdatesParams) WithAllowedUpdates added in v0.10.0 

func (p *GetUpdatesParams) WithAllowedUpdates(allowedUpdates ...string) *GetUpdatesParams

WithAllowedUpdates adds allowed updates parameter

func (*GetUpdatesParams) WithLimit added in v0.10.0 

func (p *GetUpdatesParams) WithLimit(limit int) *GetUpdatesParams

WithLimit adds limit parameter

func (*GetUpdatesParams) WithOffset added in v0.10.0 

func (p *GetUpdatesParams) WithOffset(offset int) *GetUpdatesParams

WithOffset adds offset parameter

func (*GetUpdatesParams) WithTimeout added in v0.10.0 

func (p *GetUpdatesParams) WithTimeout(timeout int) *GetUpdatesParams

WithTimeout adds timeout parameter

type GetUserChatBoostsParams added in v0.29.0 

type GetUserChatBoostsParams struct {
	// ChatID - Unique identifier for the chat or username of the channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

GetUserChatBoostsParams - Represents parameters of getUserChatBoosts method.

func (*GetUserChatBoostsParams) WithChatID added in v0.29.0 

func (p *GetUserChatBoostsParams) WithChatID(chatID ChatID) *GetUserChatBoostsParams

WithChatID adds chat ID parameter

func (*GetUserChatBoostsParams) WithUserID added in v1.1.0 

func (p *GetUserChatBoostsParams) WithUserID(userID int64) *GetUserChatBoostsParams

WithUserID adds user ID parameter

type GetUserGiftsParams added in v1.4.0 

type GetUserGiftsParams struct {
	// UserID - Unique identifier of the user
	UserID int64 `json:"user_id"`

	// ExcludeUnlimited - Optional. Pass True to exclude gifts that can be purchased an unlimited number of
	// times
	ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`

	// 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"`

	// 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"`

	// ExcludeUnique - Optional. Pass True to exclude unique gifts
	ExcludeUnique bool `json:"exclude_unique,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 an
	// 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"`
}

GetUserGiftsParams - Represents parameters of getUserGifts method.

func (*GetUserGiftsParams) WithExcludeFromBlockchain added in v1.4.0 

func (p *GetUserGiftsParams) WithExcludeFromBlockchain() *GetUserGiftsParams

WithExcludeFromBlockchain adds exclude from blockchain parameter

func (*GetUserGiftsParams) WithExcludeLimitedNonUpgradable added in v1.4.0 

func (p *GetUserGiftsParams) WithExcludeLimitedNonUpgradable() *GetUserGiftsParams

WithExcludeLimitedNonUpgradable adds exclude limited non upgradable parameter

func (*GetUserGiftsParams) WithExcludeLimitedUpgradable added in v1.4.0 

func (p *GetUserGiftsParams) WithExcludeLimitedUpgradable() *GetUserGiftsParams

WithExcludeLimitedUpgradable adds exclude limited upgradable parameter

func (*GetUserGiftsParams) WithExcludeUnique added in v1.4.0 

func (p *GetUserGiftsParams) WithExcludeUnique() *GetUserGiftsParams

WithExcludeUnique adds exclude unique parameter

func (*GetUserGiftsParams) WithExcludeUnlimited added in v1.4.0 

func (p *GetUserGiftsParams) WithExcludeUnlimited() *GetUserGiftsParams

WithExcludeUnlimited adds exclude unlimited parameter

func (*GetUserGiftsParams) WithLimit added in v1.4.0 

func (p *GetUserGiftsParams) WithLimit(limit int) *GetUserGiftsParams

WithLimit adds limit parameter

func (*GetUserGiftsParams) WithOffset added in v1.4.0 

func (p *GetUserGiftsParams) WithOffset(offset string) *GetUserGiftsParams

WithOffset adds offset parameter

func (*GetUserGiftsParams) WithSortByPrice added in v1.4.0 

func (p *GetUserGiftsParams) WithSortByPrice() *GetUserGiftsParams

WithSortByPrice adds sort by price parameter

func (*GetUserGiftsParams) WithUserID added in v1.4.0 

func (p *GetUserGiftsParams) WithUserID(userID int64) *GetUserGiftsParams

WithUserID adds user ID parameter

type GetUserProfilePhotosParams 

type GetUserProfilePhotosParams struct {
	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Offset - Optional. Sequential number of the first photo to be returned. By default, all photos are
	// returned.
	Offset int `json:"offset,omitempty"`

	// Limit - Optional. Limits the number of photos to be retrieved. Values between 1-100 are accepted.
	// Defaults to 100.
	Limit int `json:"limit,omitempty"`
}

GetUserProfilePhotosParams - Represents parameters of getUserProfilePhotos method.

func (*GetUserProfilePhotosParams) WithLimit added in v0.10.0 

func (p *GetUserProfilePhotosParams) WithLimit(limit int) *GetUserProfilePhotosParams

WithLimit adds limit parameter

func (*GetUserProfilePhotosParams) WithOffset added in v0.10.0 

func (p *GetUserProfilePhotosParams) WithOffset(offset int) *GetUserProfilePhotosParams

WithOffset adds offset parameter

func (*GetUserProfilePhotosParams) WithUserID added in v1.1.0 

func (p *GetUserProfilePhotosParams) WithUserID(userID int64) *GetUserProfilePhotosParams

WithUserID adds user ID parameter

type Gift added in v0.32.0 

type Gift struct {
	// ID - Unique identifier of the gift
	ID string `json:"id"`

	// Sticker - The sticker that represents the gift
	Sticker Sticker `json:"sticker"`

	// StarCount - The number of Telegram Stars that must be paid to send the sticker
	StarCount int `json:"star_count"`

	// UpgradeStarCount - Optional. The number of Telegram Stars that must be paid to upgrade the gift to a
	// unique one
	UpgradeStarCount int `json:"upgrade_star_count,omitempty"`

	// IsPremium - Optional. True, if the gift can only be purchased by Telegram Premium subscribers
	IsPremium bool `json:"is_premium,omitempty"`

	// HasColors - Optional. True, if the gift can be used (after being upgraded) to customize a user's
	// appearance
	HasColors bool `json:"has_colors,omitempty"`

	// TotalCount - Optional. The total number of gifts of this type that can be sent by all users; for limited
	// gifts only
	TotalCount int `json:"total_count,omitempty"`

	// RemainingCount - Optional. The number of remaining gifts of this type that can be sent by all users; for
	// limited gifts only
	RemainingCount int `json:"remaining_count,omitempty"`

	// PersonalTotalCount - Optional. The total number of gifts of this type that can be sent by the bot; for
	// limited gifts only
	PersonalTotalCount int `json:"personal_total_count,omitempty"`

	// PersonalRemainingCount - Optional. The number of remaining gifts of this type that can be sent by the
	// bot; for limited gifts only
	PersonalRemainingCount int `json:"personal_remaining_count,omitempty"`

	// Background - Optional. Background of the gift
	Background *GiftBackground `json:"background,omitempty"`

	// UniqueGiftVariantCount - Optional. The total number of different unique gifts that can be obtained by
	// upgrading the gift
	UniqueGiftVariantCount int `json:"unique_gift_variant_count,omitempty"`

	// PublisherChat - Optional. Information about the chat that published the gift
	PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

Gift - This object represents a gift that can be sent by the bot.

type GiftBackground added in v1.4.0 

type GiftBackground struct {
	// CenterColor - Center color of the background in RGB format
	CenterColor int `json:"center_color"`

	// EdgeColor - Edge color of the background in RGB format
	EdgeColor int `json:"edge_color"`

	// TextColor - Text color of the background in RGB format
	TextColor int `json:"text_color"`
}

GiftBackground - This object describes the background of a gift.

type GiftInfo added in v1.1.0 

type GiftInfo struct {
	// Gift - Information about the gift
	Gift Gift `json:"gift"`

	// OwnedGiftID - Optional. Unique identifier of the received gift for the bot; only present for gifts
	// received on behalf of business accounts
	OwnedGiftID string `json:"owned_gift_id,omitempty"`

	// ConvertStarCount - Optional. Number of Telegram Stars that can be claimed by the receiver by converting
	// the gift; omitted if conversion to Telegram Stars is impossible
	ConvertStarCount int `json:"convert_star_count,omitempty"`

	// PrepaidUpgradeStarCount - Optional. Number of Telegram Stars that were prepaid for the ability to upgrade
	// the gift
	PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`

	// IsUpgradeSeparate - Optional. True, if the gift's upgrade was purchased after the gift was sent
	IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`

	// CanBeUpgraded - Optional. True, if the gift can be upgraded to a unique gift
	CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`

	// Text - Optional. Text of the message that was added to the gift
	Text string `json:"text,omitempty"`

	// Entities - Optional. Special entities that appear in the text
	Entities []MessageEntity `json:"entities,omitempty"`

	// IsPrivate - Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise,
	// everyone will be able to see them
	IsPrivate bool `json:"is_private,omitempty"`

	// UniqueGiftNumber - Optional. Unique number reserved for this gift when upgraded. See the number field in
	// UniqueGift (https://core.telegram.org/bots/api#uniquegift)
	UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
}

GiftInfo - Describes a service message about a regular gift that was sent or received.

type GiftPremiumSubscriptionParams added in v1.1.0 

type GiftPremiumSubscriptionParams struct {
	// UserID - Unique identifier of the target user who will receive a Telegram Premium subscription
	UserID int64 `json:"user_id"`

	// MonthCount - 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 - 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details. Entities other than “bold”,
	// “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	TextParseMode string `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”, and “custom_emoji” are ignored.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

GiftPremiumSubscriptionParams - Represents parameters of giftPremiumSubscription method.

func (*GiftPremiumSubscriptionParams) WithMonthCount added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithMonthCount(monthCount int) *GiftPremiumSubscriptionParams

WithMonthCount adds month count parameter

func (*GiftPremiumSubscriptionParams) WithStarCount added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithStarCount(starCount int) *GiftPremiumSubscriptionParams

WithStarCount adds star count parameter

func (*GiftPremiumSubscriptionParams) WithText added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithText(text string) *GiftPremiumSubscriptionParams

WithText adds text parameter

func (*GiftPremiumSubscriptionParams) WithTextEntities added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithTextEntities(textEntities ...MessageEntity) *GiftPremiumSubscriptionParams

WithTextEntities adds text entities parameter

func (*GiftPremiumSubscriptionParams) WithTextParseMode added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithTextParseMode(textParseMode string) *GiftPremiumSubscriptionParams

WithTextParseMode adds text parse mode parameter

func (*GiftPremiumSubscriptionParams) WithUserID added in v1.1.0 

func (p *GiftPremiumSubscriptionParams) WithUserID(userID int64) *GiftPremiumSubscriptionParams

WithUserID adds user ID parameter

type Gifts added in v0.32.0 

type Gifts struct {
	// Gifts - The list of gifts
	Gifts []Gift `json:"gifts"`
}

Gifts - This object represent a list of gifts.

type Giveaway added in v0.29.0 

type Giveaway struct {
	// Chats - The list of chats which the user must join to participate in the giveaway
	Chats []Chat `json:"chats"`

	// WinnersSelectionDate - Point in time (Unix timestamp) when winners of the giveaway will be selected
	WinnersSelectionDate int64 `json:"winners_selection_date"`

	// WinnerCount - The number of users which are supposed to be selected as winners of the giveaway
	WinnerCount int `json:"winner_count"`

	// OnlyNewMembers - Optional. True, if only users who join the chats after the giveaway started should be
	// eligible to win
	OnlyNewMembers bool `json:"only_new_members,omitempty"`

	// HasPublicWinners - Optional. True, if the list of giveaway winners will be visible to everyone
	HasPublicWinners bool `json:"has_public_winners,omitempty"`

	// PrizeDescription - Optional. Description of additional giveaway prize
	PrizeDescription string `json:"prize_description,omitempty"`

	// CountryCodes - Optional. A list of two-letter ISO 3166-1 alpha-2
	// (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes indicating the countries from which eligible
	// users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a
	// phone number that was bought on Fragment can always participate in giveaways.
	CountryCodes []string `json:"country_codes,omitempty"`

	// 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"`

	// PremiumSubscriptionMonthCount - Optional. The number of months the Telegram Premium subscription won from
	// the giveaway will be active for; for Telegram Premium giveaways only
	PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
}

Giveaway - This object represents a message about a scheduled giveaway.

type GiveawayCompleted added in v0.29.0 

type GiveawayCompleted struct {
	// WinnerCount - Number of winners in the giveaway
	WinnerCount int `json:"winner_count"`

	// UnclaimedPrizeCount - Optional. Number of undistributed prizes
	UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`

	// GiveawayMessage - Optional. Message with the giveaway that was completed, if it wasn't deleted
	GiveawayMessage *Message `json:"giveaway_message,omitempty"`

	// IsStarGiveaway - Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the
	// giveaway is a Telegram Premium giveaway.
	IsStarGiveaway bool `json:"is_star_giveaway,omitempty"`
}

GiveawayCompleted - This object represents a service message about the completion of a giveaway without public winners.

type GiveawayCreated added in v0.29.0 

type GiveawayCreated struct {
	// PrizeStarCount - Optional. The number of Telegram Stars to be split between giveaway winners; for
	// Telegram Star giveaways only
	PrizeStarCount int `json:"prize_star_count,omitempty"`
}

GiveawayCreated - This object represents a service message about the creation of a scheduled giveaway.

type GiveawayWinners added in v0.29.0 

type GiveawayWinners struct {
	// Chat - The chat that created the giveaway
	Chat Chat `json:"chat"`

	// GiveawayMessageID - Identifier of the message with the giveaway in the chat
	GiveawayMessageID int `json:"giveaway_message_id"`

	// WinnersSelectionDate - Point in time (Unix timestamp) when winners of the giveaway were selected
	WinnersSelectionDate int64 `json:"winners_selection_date"`

	// WinnerCount - Total number of winners in the giveaway
	WinnerCount int `json:"winner_count"`

	// Winners - List of up to 100 winners of the giveaway
	Winners []User `json:"winners"`

	// AdditionalChatCount - Optional. The number of other chats the user had to join in order to be eligible
	// for the giveaway
	AdditionalChatCount int `json:"additional_chat_count,omitempty"`

	// PrizeStarCount - Optional. The number of Telegram Stars that were split between giveaway winners; for
	// Telegram Star giveaways only
	PrizeStarCount int `json:"prize_star_count,omitempty"`

	// PremiumSubscriptionMonthCount - Optional. The number of months the Telegram Premium subscription won from
	// the giveaway will be active for; for Telegram Premium giveaways only
	PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`

	// UnclaimedPrizeCount - Optional. Number of undistributed prizes
	UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`

	// OnlyNewMembers - Optional. True, if only users who had joined the chats after the giveaway started were
	// eligible to win
	OnlyNewMembers bool `json:"only_new_members,omitempty"`

	// WasRefunded - Optional. True, if the giveaway was canceled because the payment for it was refunded
	WasRefunded bool `json:"was_refunded,omitempty"`

	// PrizeDescription - Optional. Description of additional giveaway prize
	PrizeDescription string `json:"prize_description,omitempty"`
}

GiveawayWinners - This object represents a message about the completion of a giveaway with public winners.

type HideGeneralForumTopicParams added in v0.18.1 

type HideGeneralForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

HideGeneralForumTopicParams - Represents parameters of hideGeneralForumTopic method.

func (*HideGeneralForumTopicParams) WithChatID added in v0.18.1 

func (p *HideGeneralForumTopicParams) WithChatID(chatID ChatID) *HideGeneralForumTopicParams

WithChatID adds chat ID parameter

type InaccessibleMessage added in v0.29.0 

type InaccessibleMessage struct {
	// Chat - Chat the message belonged to
	Chat Chat `json:"chat"`

	// MessageID - Unique message identifier inside the chat
	MessageID int `json:"message_id"`

	// Date - Always 0. The field can be used to differentiate regular and inaccessible messages.
	Date int64 `json:"date"`
}

InaccessibleMessage - This object describes a message that was deleted or is otherwise inaccessible to the bot.

func (*InaccessibleMessage) GetChat added in v0.29.0 

func (m *InaccessibleMessage) GetChat() Chat

GetChat returns message chat

func (*InaccessibleMessage) GetDate added in v0.29.0 

func (m *InaccessibleMessage) GetDate() int64

GetDate returns message date

func (*InaccessibleMessage) GetMessageID added in v0.29.0 

func (m *InaccessibleMessage) GetMessageID() int

GetMessageID returns message ID

func (*InaccessibleMessage) InaccessibleMessage added in v1.1.0 

func (m *InaccessibleMessage) InaccessibleMessage() *InaccessibleMessage

InaccessibleMessage returns InaccessibleMessage if message not accessible for bot, otherwise returns nil

func (*InaccessibleMessage) IsAccessible added in v0.29.0 

func (m *InaccessibleMessage) IsAccessible() bool

IsAccessible returns true if message accessible for bot

func (*InaccessibleMessage) Message added in v1.1.0 

func (m *InaccessibleMessage) Message() *Message

Message returns Message if message accessible for bot, otherwise returns nil

type InlineKeyboardButton 

type InlineKeyboardButton struct {
	// Text - Label text on the button
	Text string `json:"text"`

	// URL - Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id>
	// can be used to mention a user by their identifier without using a username, if this is allowed by their
	// privacy settings.
	URL string `json:"url,omitempty"`

	// CallbackData - Optional. Data to be sent in a callback query
	// (https://core.telegram.org/bots/api#callbackquery) to the bot when the button is pressed, 1-64 bytes
	CallbackData string `json:"callback_data,omitempty"`

	// WebApp - Optional. Description of the Web App (https://core.telegram.org/bots/webapps) 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 (https://core.telegram.org/bots/api#answerwebappquery). Available
	// only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram
	// Business account.
	WebApp *WebAppInfo `json:"web_app,omitempty"`

	// LoginURL - Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement
	// for the Telegram Login Widget (https://core.telegram.org/widgets/login).
	LoginURL *LoginURL `json:"login_url,omitempty"`

	// SwitchInlineQuery - Optional. If set, pressing the button will prompt the user to select one of their
	// chats, open that chat and insert the bot's username and the specified inline query in the input field. May be
	// empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel
	// direct messages chats and on behalf of a Telegram Business account.
	SwitchInlineQuery *string `json:"switch_inline_query,omitempty"`

	// SwitchInlineQueryCurrentChat - Optional. If set, pressing the button will insert the bot's username and
	// the specified inline query in the current chat's input field. May be empty, in which case only the bot's
	// username will be inserted.
	// This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting
	// something from multiple options. Not supported in channels and for messages sent in channel direct messages
	// chats and on behalf of a Telegram Business account.
	SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"`

	// SwitchInlineQueryChosenChat - Optional. If set, pressing the button will prompt the user to select one of
	// their chats of the specified type, open that chat and insert the bot's username and the specified inline
	// query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a
	// Telegram Business account.
	SwitchInlineQueryChosenChat *SwitchInlineQueryChosenChat `json:"switch_inline_query_chosen_chat,omitempty"`

	// CopyText - Optional. Description of the button that copies the specified text to the clipboard.
	CopyText *CopyTextButton `json:"copy_text,omitempty"`

	// CallbackGame - Optional. Description of the game that will be launched when the user presses the button.
	// NOTE: This type of button must always be the first button in the first row.
	CallbackGame *CallbackGame `json:"callback_game,omitempty"`

	// Pay - Optional. Specify True, to send a Pay button (https://core.telegram.org/bots/api#payments).
	// Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.
	// NOTE: This type of button must always be the first button in the first row and can only be used in invoice
	// messages.
	Pay bool `json:"pay,omitempty"`
}

InlineKeyboardButton - This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.

func (InlineKeyboardButton) WithCallbackData added in v0.10.0 

func (i InlineKeyboardButton) WithCallbackData(callbackData string) InlineKeyboardButton

WithCallbackData adds callback data parameter

func (InlineKeyboardButton) WithCallbackGame added in v0.10.0 

func (i InlineKeyboardButton) WithCallbackGame(callbackGame *CallbackGame) InlineKeyboardButton

WithCallbackGame adds callback game parameter

func (InlineKeyboardButton) WithCopyText added in v0.32.0 

func (i InlineKeyboardButton) WithCopyText(copyText *CopyTextButton) InlineKeyboardButton

WithCopyText adds copy text parameter

func (InlineKeyboardButton) WithLoginURL added in v0.10.0 

func (i InlineKeyboardButton) WithLoginURL(loginURL *LoginURL) InlineKeyboardButton

WithLoginURL adds login URL parameter

func (InlineKeyboardButton) WithPay added in v0.10.0 

func (i InlineKeyboardButton) WithPay() InlineKeyboardButton

WithPay adds pay parameter

func (InlineKeyboardButton) WithSwitchInlineQuery added in v0.10.0 

func (i InlineKeyboardButton) WithSwitchInlineQuery(switchInlineQuery string) InlineKeyboardButton

WithSwitchInlineQuery adds switch inline query parameter

func (InlineKeyboardButton) WithSwitchInlineQueryChosenChat added in v0.22.1 

func (i InlineKeyboardButton) WithSwitchInlineQueryChosenChat(
	switchInlineQueryChosenChat *SwitchInlineQueryChosenChat,
) InlineKeyboardButton

WithSwitchInlineQueryChosenChat adds switch inline query chosen chat parameter

func (InlineKeyboardButton) WithSwitchInlineQueryCurrentChat added in v0.10.0 

func (i InlineKeyboardButton) WithSwitchInlineQueryCurrentChat(
	switchInlineQueryCurrentChat string,
) InlineKeyboardButton

WithSwitchInlineQueryCurrentChat adds switch inline query current chat parameter

func (InlineKeyboardButton) WithText added in v0.10.0 

func (i InlineKeyboardButton) WithText(text string) InlineKeyboardButton

WithText adds text parameter

func (InlineKeyboardButton) WithURL added in v0.10.0 

func (i InlineKeyboardButton) WithURL(url string) InlineKeyboardButton

WithURL adds URL parameter

func (InlineKeyboardButton) WithWebApp added in v0.11.0 

func (i InlineKeyboardButton) WithWebApp(webApp *WebAppInfo) InlineKeyboardButton

WithWebApp adds web app parameter

type InlineKeyboardMarkup 

type InlineKeyboardMarkup struct {
	// InlineKeyboard - Array of button rows, each represented by an Array of InlineKeyboardButton
	// (https://core.telegram.org/bots/api#inlinekeyboardbutton) objects
	InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
}

InlineKeyboardMarkup - This object represents an inline keyboard (https://core.telegram.org/bots/features#inline-keyboards) that appears right next to the message it belongs to.

func (*InlineKeyboardMarkup) ReplyType 

func (i *InlineKeyboardMarkup) ReplyType() string

ReplyType returns InlineKeyboardMarkup type

func (*InlineKeyboardMarkup) WithInlineKeyboard added in v0.10.0 

func (i *InlineKeyboardMarkup) WithInlineKeyboard(inlineKeyboard ...[]InlineKeyboardButton) *InlineKeyboardMarkup

WithInlineKeyboard adds inline keyboard parameter

type InlineQuery 

type InlineQuery struct {
	// ID - Unique identifier for this query
	ID string `json:"id"`

	// From - Sender
	From User `json:"from"`

	// Query - Text of the query (up to 256 characters)
	Query string `json:"query"`

	// Offset - Offset of the results to be returned, can be controlled by the bot
	Offset string `json:"offset"`

	// ChatType - Optional. Type of the chat from which the inline query was sent. Can be either “sender”
	// for a private chat with the inline query sender, “private”, “group”, “supergroup”, or
	// “channel”. The chat type should be always known for requests sent from official clients and most
	// third-party clients, unless the request was sent from a secret chat
	ChatType string `json:"chat_type,omitempty"`

	// Location - Optional. Sender location, only for bots that request user location
	Location *Location `json:"location,omitempty"`
}

InlineQuery - This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

type InlineQueryResult 

type InlineQueryResult interface {
	// ResultType returns InlineQueryResult type
	ResultType() string
	// contains filtered or unexported methods
}

InlineQueryResult - This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: InlineQueryResultCachedAudio (https://core.telegram.org/bots/api#inlinequeryresultcachedaudio) InlineQueryResultCachedDocument (https://core.telegram.org/bots/api#inlinequeryresultcacheddocument) InlineQueryResultCachedGif (https://core.telegram.org/bots/api#inlinequeryresultcachedgif) InlineQueryResultCachedMpeg4Gif (https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif) InlineQueryResultCachedPhoto (https://core.telegram.org/bots/api#inlinequeryresultcachedphoto) InlineQueryResultCachedSticker (https://core.telegram.org/bots/api#inlinequeryresultcachedsticker) InlineQueryResultCachedVideo (https://core.telegram.org/bots/api#inlinequeryresultcachedvideo) InlineQueryResultCachedVoice (https://core.telegram.org/bots/api#inlinequeryresultcachedvoice) InlineQueryResultArticle (https://core.telegram.org/bots/api#inlinequeryresultarticle) InlineQueryResultAudio (https://core.telegram.org/bots/api#inlinequeryresultaudio) InlineQueryResultContact (https://core.telegram.org/bots/api#inlinequeryresultcontact) InlineQueryResultGame (https://core.telegram.org/bots/api#inlinequeryresultgame) InlineQueryResultDocument (https://core.telegram.org/bots/api#inlinequeryresultdocument) InlineQueryResultGif (https://core.telegram.org/bots/api#inlinequeryresultgif) InlineQueryResultLocation (https://core.telegram.org/bots/api#inlinequeryresultlocation) InlineQueryResultMpeg4Gif (https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif) InlineQueryResultPhoto (https://core.telegram.org/bots/api#inlinequeryresultphoto) InlineQueryResultVenue (https://core.telegram.org/bots/api#inlinequeryresultvenue) InlineQueryResultVideo (https://core.telegram.org/bots/api#inlinequeryresultvideo) InlineQueryResultVoice (https://core.telegram.org/bots/api#inlinequeryresultvoice) Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.

type InlineQueryResultArticle 

type InlineQueryResultArticle struct {
	// Type - Type of the result, must be article
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 Bytes
	ID string `json:"id"`

	// Title - Title of the result
	Title string `json:"title"`

	// InputMessageContent - Content of the message to be sent
	InputMessageContent InputMessageContent `json:"input_message_content"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// URL - Optional. URL of the result
	URL string `json:"url,omitempty"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// ThumbnailURL - Optional. URL of the thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url,omitempty"`

	// ThumbnailWidth - Optional. Thumbnail width
	ThumbnailWidth int `json:"thumbnail_width,omitempty"`

	// ThumbnailHeight - Optional. Thumbnail height
	ThumbnailHeight int `json:"thumbnail_height,omitempty"`
}

InlineQueryResultArticle - Represents a link to an article or web page.

func (*InlineQueryResultArticle) ResultType 

func (i *InlineQueryResultArticle) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultArticle) WithDescription added in v0.10.0 

func (i *InlineQueryResultArticle) WithDescription(description string) *InlineQueryResultArticle

WithDescription adds description parameter

func (*InlineQueryResultArticle) WithID added in v0.10.0 

func (i *InlineQueryResultArticle) WithID(iD string) *InlineQueryResultArticle

WithID adds ID parameter

func (*InlineQueryResultArticle) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultArticle) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultArticle

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultArticle) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultArticle) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultArticle

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultArticle) WithThumbnailHeight added in v0.22.0 

func (i *InlineQueryResultArticle) WithThumbnailHeight(thumbnailHeight int) *InlineQueryResultArticle

WithThumbnailHeight adds thumbnail height parameter

func (*InlineQueryResultArticle) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultArticle) WithThumbnailURL(thumbnailURL string) *InlineQueryResultArticle

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultArticle) WithThumbnailWidth added in v0.22.0 

func (i *InlineQueryResultArticle) WithThumbnailWidth(thumbnailWidth int) *InlineQueryResultArticle

WithThumbnailWidth adds thumbnail width parameter

func (*InlineQueryResultArticle) WithTitle added in v0.10.0 

func (i *InlineQueryResultArticle) WithTitle(title string) *InlineQueryResultArticle

WithTitle adds title parameter

func (*InlineQueryResultArticle) WithURL added in v0.10.0 

func (i *InlineQueryResultArticle) WithURL(url string) *InlineQueryResultArticle

WithURL adds URL parameter

type InlineQueryResultAudio 

type InlineQueryResultAudio struct {
	// Type - Type of the result, must be audio
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// AudioURL - A valid URL for the audio file
	AudioURL string `json:"audio_url"`

	// Title - Title
	Title string `json:"title"`

	// Caption - Optional. 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// Performer - Optional. Performer
	Performer string `json:"performer,omitempty"`

	// AudioDuration - Optional. Audio duration in seconds
	AudioDuration int `json:"audio_duration,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the audio
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultAudio - Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

func (*InlineQueryResultAudio) ResultType 

func (i *InlineQueryResultAudio) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultAudio) WithAudioDuration added in v0.10.0 

func (i *InlineQueryResultAudio) WithAudioDuration(audioDuration int) *InlineQueryResultAudio

WithAudioDuration adds audio duration parameter

func (*InlineQueryResultAudio) WithAudioURL added in v0.10.0 

func (i *InlineQueryResultAudio) WithAudioURL(audioURL string) *InlineQueryResultAudio

WithAudioURL adds audio URL parameter

func (*InlineQueryResultAudio) WithCaption added in v0.10.0 

func (i *InlineQueryResultAudio) WithCaption(caption string) *InlineQueryResultAudio

WithCaption adds caption parameter

func (*InlineQueryResultAudio) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultAudio) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultAudio

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultAudio) WithID added in v0.10.0 

func (i *InlineQueryResultAudio) WithID(iD string) *InlineQueryResultAudio

WithID adds ID parameter

func (*InlineQueryResultAudio) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultAudio) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultAudio

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultAudio) WithParseMode added in v0.10.0 

func (i *InlineQueryResultAudio) WithParseMode(parseMode string) *InlineQueryResultAudio

WithParseMode adds parse mode parameter

func (*InlineQueryResultAudio) WithPerformer added in v0.10.0 

func (i *InlineQueryResultAudio) WithPerformer(performer string) *InlineQueryResultAudio

WithPerformer adds performer parameter

func (*InlineQueryResultAudio) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultAudio) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultAudio

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultAudio) WithTitle added in v0.10.0 

func (i *InlineQueryResultAudio) WithTitle(title string) *InlineQueryResultAudio

WithTitle adds title parameter

type InlineQueryResultCachedAudio 

type InlineQueryResultCachedAudio struct {
	// Type - Type of the result, must be audio
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// AudioFileID - A valid file identifier for the audio file
	AudioFileID string `json:"audio_file_id"`

	// Caption - Optional. 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the audio
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedAudio - Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

func (*InlineQueryResultCachedAudio) ResultType 

func (i *InlineQueryResultCachedAudio) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedAudio) WithAudioFileID added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithAudioFileID(audioFileID string) *InlineQueryResultCachedAudio

WithAudioFileID adds audio file ID parameter

func (*InlineQueryResultCachedAudio) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithCaption(caption string) *InlineQueryResultCachedAudio

WithCaption adds caption parameter

func (*InlineQueryResultCachedAudio) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedAudio

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedAudio) WithID added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithID(iD string) *InlineQueryResultCachedAudio

WithID adds ID parameter

func (*InlineQueryResultCachedAudio) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedAudio

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedAudio) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithParseMode(parseMode string) *InlineQueryResultCachedAudio

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedAudio) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedAudio) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedAudio

WithReplyMarkup adds reply markup parameter

type InlineQueryResultCachedDocument 

type InlineQueryResultCachedDocument struct {
	// Type - Type of the result, must be document
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// Title - Title for the result
	Title string `json:"title"`

	// DocumentFileID - A valid file identifier for the file
	DocumentFileID string `json:"document_file_id"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the file
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedDocument - Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

func (*InlineQueryResultCachedDocument) ResultType 

func (i *InlineQueryResultCachedDocument) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedDocument) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithCaption(caption string) *InlineQueryResultCachedDocument

WithCaption adds caption parameter

func (*InlineQueryResultCachedDocument) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedDocument

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedDocument) WithDescription added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithDescription(description string) *InlineQueryResultCachedDocument

WithDescription adds description parameter

func (*InlineQueryResultCachedDocument) WithDocumentFileID added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithDocumentFileID(documentFileID string) *InlineQueryResultCachedDocument

WithDocumentFileID adds document file ID parameter

func (*InlineQueryResultCachedDocument) WithID added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithID(iD string) *InlineQueryResultCachedDocument

WithID adds ID parameter

func (*InlineQueryResultCachedDocument) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedDocument

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedDocument) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithParseMode(parseMode string) *InlineQueryResultCachedDocument

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedDocument) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedDocument

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedDocument) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedDocument) WithTitle(title string) *InlineQueryResultCachedDocument

WithTitle adds title parameter

type InlineQueryResultCachedGif 

type InlineQueryResultCachedGif struct {
	// Type - Type of the result, must be gif
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// GifFileID - A valid file identifier for the GIF file
	GifFileID string `json:"gif_file_id"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Caption - Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the GIF animation
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedGif - Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

func (*InlineQueryResultCachedGif) ResultType 

func (i *InlineQueryResultCachedGif) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedGif) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithCaption(caption string) *InlineQueryResultCachedGif

WithCaption adds caption parameter

func (*InlineQueryResultCachedGif) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultCachedGif

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedGif) WithGifFileID added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithGifFileID(gifFileID string) *InlineQueryResultCachedGif

WithGifFileID adds gif file ID parameter

func (*InlineQueryResultCachedGif) WithID added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithID(iD string) *InlineQueryResultCachedGif

WithID adds ID parameter

func (*InlineQueryResultCachedGif) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedGif

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedGif) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithParseMode(parseMode string) *InlineQueryResultCachedGif

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedGif) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultCachedGif

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedGif) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultCachedGif) WithShowCaptionAboveMedia() *InlineQueryResultCachedGif

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultCachedGif) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedGif) WithTitle(title string) *InlineQueryResultCachedGif

WithTitle adds title parameter

type InlineQueryResultCachedMpeg4Gif 

type InlineQueryResultCachedMpeg4Gif struct {
	// Type - Type of the result, must be mpeg4_gif
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// Mpeg4FileID - A valid file identifier for the MPEG4 file
	Mpeg4FileID string `json:"mpeg4_file_id"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Caption - Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the video animation
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedMpeg4Gif - Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

func (*InlineQueryResultCachedMpeg4Gif) ResultType 

func (i *InlineQueryResultCachedMpeg4Gif) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedMpeg4Gif) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithCaption(caption string) *InlineQueryResultCachedMpeg4Gif

WithCaption adds caption parameter

func (*InlineQueryResultCachedMpeg4Gif) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedMpeg4Gif

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedMpeg4Gif) WithID added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithID(iD string) *InlineQueryResultCachedMpeg4Gif

WithID adds ID parameter

func (*InlineQueryResultCachedMpeg4Gif) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedMpeg4Gif

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedMpeg4Gif) WithMpeg4FileID added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithMpeg4FileID(mpeg4FileID string) *InlineQueryResultCachedMpeg4Gif

WithMpeg4FileID adds mpeg4 file ID parameter

func (*InlineQueryResultCachedMpeg4Gif) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithParseMode(parseMode string) *InlineQueryResultCachedMpeg4Gif

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedMpeg4Gif) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedMpeg4Gif

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedMpeg4Gif) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultCachedMpeg4Gif) WithShowCaptionAboveMedia() *InlineQueryResultCachedMpeg4Gif

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultCachedMpeg4Gif) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedMpeg4Gif) WithTitle(title string) *InlineQueryResultCachedMpeg4Gif

WithTitle adds title parameter

type InlineQueryResultCachedPhoto 

type InlineQueryResultCachedPhoto struct {
	// Type - Type of the result, must be photo
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// PhotoFileID - A valid file identifier of the photo
	PhotoFileID string `json:"photo_file_id"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the photo
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedPhoto - Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

func (*InlineQueryResultCachedPhoto) ResultType 

func (i *InlineQueryResultCachedPhoto) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedPhoto) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithCaption(caption string) *InlineQueryResultCachedPhoto

WithCaption adds caption parameter

func (*InlineQueryResultCachedPhoto) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedPhoto

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedPhoto) WithDescription added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithDescription(description string) *InlineQueryResultCachedPhoto

WithDescription adds description parameter

func (*InlineQueryResultCachedPhoto) WithID added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithID(iD string) *InlineQueryResultCachedPhoto

WithID adds ID parameter

func (*InlineQueryResultCachedPhoto) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedPhoto

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedPhoto) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithParseMode(parseMode string) *InlineQueryResultCachedPhoto

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedPhoto) WithPhotoFileID added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithPhotoFileID(photoFileID string) *InlineQueryResultCachedPhoto

WithPhotoFileID adds photo file ID parameter

func (*InlineQueryResultCachedPhoto) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedPhoto

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedPhoto) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultCachedPhoto) WithShowCaptionAboveMedia() *InlineQueryResultCachedPhoto

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultCachedPhoto) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedPhoto) WithTitle(title string) *InlineQueryResultCachedPhoto

WithTitle adds title parameter

type InlineQueryResultCachedSticker 

type InlineQueryResultCachedSticker struct {
	// Type - Type of the result, must be sticker
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// StickerFileID - A valid file identifier of the sticker
	StickerFileID string `json:"sticker_file_id"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the sticker
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedSticker - Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

func (*InlineQueryResultCachedSticker) ResultType 

func (i *InlineQueryResultCachedSticker) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedSticker) WithID added in v0.10.0 

func (i *InlineQueryResultCachedSticker) WithID(iD string) *InlineQueryResultCachedSticker

WithID adds ID parameter

func (*InlineQueryResultCachedSticker) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedSticker) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedSticker

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedSticker) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedSticker) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedSticker

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedSticker) WithStickerFileID added in v0.10.0 

func (i *InlineQueryResultCachedSticker) WithStickerFileID(stickerFileID string) *InlineQueryResultCachedSticker

WithStickerFileID adds sticker file ID parameter

type InlineQueryResultCachedVideo 

type InlineQueryResultCachedVideo struct {
	// Type - Type of the result, must be video
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// VideoFileID - A valid file identifier for the video file
	VideoFileID string `json:"video_file_id"`

	// Title - Title for the result
	Title string `json:"title"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the video
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedVideo - Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

func (*InlineQueryResultCachedVideo) ResultType 

func (i *InlineQueryResultCachedVideo) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedVideo) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithCaption(caption string) *InlineQueryResultCachedVideo

WithCaption adds caption parameter

func (*InlineQueryResultCachedVideo) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedVideo

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedVideo) WithDescription added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithDescription(description string) *InlineQueryResultCachedVideo

WithDescription adds description parameter

func (*InlineQueryResultCachedVideo) WithID added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithID(iD string) *InlineQueryResultCachedVideo

WithID adds ID parameter

func (*InlineQueryResultCachedVideo) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedVideo

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedVideo) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithParseMode(parseMode string) *InlineQueryResultCachedVideo

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedVideo) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedVideo

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedVideo) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultCachedVideo) WithShowCaptionAboveMedia() *InlineQueryResultCachedVideo

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultCachedVideo) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithTitle(title string) *InlineQueryResultCachedVideo

WithTitle adds title parameter

func (*InlineQueryResultCachedVideo) WithVideoFileID added in v0.10.0 

func (i *InlineQueryResultCachedVideo) WithVideoFileID(videoFileID string) *InlineQueryResultCachedVideo

WithVideoFileID adds video file ID parameter

type InlineQueryResultCachedVoice 

type InlineQueryResultCachedVoice struct {
	// Type - Type of the result, must be voice
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// VoiceFileID - A valid file identifier for the voice message
	VoiceFileID string `json:"voice_file_id"`

	// Title - Voice message title
	Title string `json:"title"`

	// Caption - Optional. 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the voice message
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultCachedVoice - Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

func (*InlineQueryResultCachedVoice) ResultType 

func (i *InlineQueryResultCachedVoice) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultCachedVoice) WithCaption added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithCaption(caption string) *InlineQueryResultCachedVoice

WithCaption adds caption parameter

func (*InlineQueryResultCachedVoice) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithCaptionEntities(captionEntities ...MessageEntity,
) *InlineQueryResultCachedVoice

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultCachedVoice) WithID added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithID(iD string) *InlineQueryResultCachedVoice

WithID adds ID parameter

func (*InlineQueryResultCachedVoice) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultCachedVoice

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultCachedVoice) WithParseMode added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithParseMode(parseMode string) *InlineQueryResultCachedVoice

WithParseMode adds parse mode parameter

func (*InlineQueryResultCachedVoice) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *InlineQueryResultCachedVoice

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultCachedVoice) WithTitle added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithTitle(title string) *InlineQueryResultCachedVoice

WithTitle adds title parameter

func (*InlineQueryResultCachedVoice) WithVoiceFileID added in v0.10.0 

func (i *InlineQueryResultCachedVoice) WithVoiceFileID(voiceFileID string) *InlineQueryResultCachedVoice

WithVoiceFileID adds voice file ID parameter

type InlineQueryResultContact 

type InlineQueryResultContact struct {
	// Type - Type of the result, must be contact
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 Bytes
	ID string `json:"id"`

	// PhoneNumber - Contact's phone number
	PhoneNumber string `json:"phone_number"`

	// FirstName - Contact's first name
	FirstName string `json:"first_name"`

	// LastName - Optional. Contact's last name
	LastName string `json:"last_name,omitempty"`

	// Vcard - Optional. Additional data about the contact in the form of a vCard
	// (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes
	Vcard string `json:"vcard,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the contact
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`

	// ThumbnailURL - Optional. URL of the thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url,omitempty"`

	// ThumbnailWidth - Optional. Thumbnail width
	ThumbnailWidth int `json:"thumbnail_width,omitempty"`

	// ThumbnailHeight - Optional. Thumbnail height
	ThumbnailHeight int `json:"thumbnail_height,omitempty"`
}

InlineQueryResultContact - Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

func (*InlineQueryResultContact) ResultType 

func (i *InlineQueryResultContact) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultContact) WithFirstName added in v0.10.0 

func (i *InlineQueryResultContact) WithFirstName(firstName string) *InlineQueryResultContact

WithFirstName adds first name parameter

func (*InlineQueryResultContact) WithID added in v0.10.0 

func (i *InlineQueryResultContact) WithID(iD string) *InlineQueryResultContact

WithID adds ID parameter

func (*InlineQueryResultContact) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultContact) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultContact

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultContact) WithLastName added in v0.10.0 

func (i *InlineQueryResultContact) WithLastName(lastName string) *InlineQueryResultContact

WithLastName adds last name parameter

func (*InlineQueryResultContact) WithPhoneNumber added in v0.10.0 

func (i *InlineQueryResultContact) WithPhoneNumber(phoneNumber string) *InlineQueryResultContact

WithPhoneNumber adds phone number parameter

func (*InlineQueryResultContact) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultContact) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultContact

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultContact) WithThumbnailHeight added in v0.22.0 

func (i *InlineQueryResultContact) WithThumbnailHeight(thumbnailHeight int) *InlineQueryResultContact

WithThumbnailHeight adds thumbnail height parameter

func (*InlineQueryResultContact) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultContact) WithThumbnailURL(thumbnailURL string) *InlineQueryResultContact

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultContact) WithThumbnailWidth added in v0.22.0 

func (i *InlineQueryResultContact) WithThumbnailWidth(thumbnailWidth int) *InlineQueryResultContact

WithThumbnailWidth adds thumbnail width parameter

func (*InlineQueryResultContact) WithVcard added in v0.10.0 

func (i *InlineQueryResultContact) WithVcard(vcard string) *InlineQueryResultContact

WithVcard adds vcard parameter

type InlineQueryResultDocument 

type InlineQueryResultDocument struct {
	// Type - Type of the result, must be document
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// Title - Title for the result
	Title string `json:"title"`

	// Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// DocumentURL - A valid URL for the file
	DocumentURL string `json:"document_url"`

	// MimeType - MIME type of the content of the file, either “application/pdf” or “application/zip”
	MimeType string `json:"mime_type"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the file
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`

	// ThumbnailURL - Optional. URL of the thumbnail (JPEG only) for the file
	ThumbnailURL string `json:"thumbnail_url,omitempty"`

	// ThumbnailWidth - Optional. Thumbnail width
	ThumbnailWidth int `json:"thumbnail_width,omitempty"`

	// ThumbnailHeight - Optional. Thumbnail height
	ThumbnailHeight int `json:"thumbnail_height,omitempty"`
}

InlineQueryResultDocument - Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

func (*InlineQueryResultDocument) ResultType 

func (i *InlineQueryResultDocument) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultDocument) WithCaption added in v0.10.0 

func (i *InlineQueryResultDocument) WithCaption(caption string) *InlineQueryResultDocument

WithCaption adds caption parameter

func (*InlineQueryResultDocument) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultDocument) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultDocument

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultDocument) WithDescription added in v0.10.0 

func (i *InlineQueryResultDocument) WithDescription(description string) *InlineQueryResultDocument

WithDescription adds description parameter

func (*InlineQueryResultDocument) WithDocumentURL added in v0.10.0 

func (i *InlineQueryResultDocument) WithDocumentURL(documentURL string) *InlineQueryResultDocument

WithDocumentURL adds document URL parameter

func (*InlineQueryResultDocument) WithID added in v0.10.0 

func (i *InlineQueryResultDocument) WithID(iD string) *InlineQueryResultDocument

WithID adds ID parameter

func (*InlineQueryResultDocument) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultDocument) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultDocument

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultDocument) WithMimeType added in v0.10.0 

func (i *InlineQueryResultDocument) WithMimeType(mimeType string) *InlineQueryResultDocument

WithMimeType adds mime type parameter

func (*InlineQueryResultDocument) WithParseMode added in v0.10.0 

func (i *InlineQueryResultDocument) WithParseMode(parseMode string) *InlineQueryResultDocument

WithParseMode adds parse mode parameter

func (*InlineQueryResultDocument) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultDocument) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultDocument

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultDocument) WithThumbnailHeight added in v0.22.0 

func (i *InlineQueryResultDocument) WithThumbnailHeight(thumbnailHeight int) *InlineQueryResultDocument

WithThumbnailHeight adds thumbnail height parameter

func (*InlineQueryResultDocument) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultDocument) WithThumbnailURL(thumbnailURL string) *InlineQueryResultDocument

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultDocument) WithThumbnailWidth added in v0.22.0 

func (i *InlineQueryResultDocument) WithThumbnailWidth(thumbnailWidth int) *InlineQueryResultDocument

WithThumbnailWidth adds thumbnail width parameter

func (*InlineQueryResultDocument) WithTitle added in v0.10.0 

func (i *InlineQueryResultDocument) WithTitle(title string) *InlineQueryResultDocument

WithTitle adds title parameter

type InlineQueryResultGame 

type InlineQueryResultGame struct {
	// Type - Type of the result, must be game
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// GameShortName - Short name of the game
	GameShortName string `json:"game_short_name"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

InlineQueryResultGame - Represents a Game (https://core.telegram.org/bots/api#games).

func (*InlineQueryResultGame) ResultType 

func (i *InlineQueryResultGame) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultGame) WithGameShortName added in v0.10.0 

func (i *InlineQueryResultGame) WithGameShortName(gameShortName string) *InlineQueryResultGame

WithGameShortName adds game short name parameter

func (*InlineQueryResultGame) WithID added in v0.10.0 

func (i *InlineQueryResultGame) WithID(iD string) *InlineQueryResultGame

WithID adds ID parameter

func (*InlineQueryResultGame) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultGame) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultGame

WithReplyMarkup adds reply markup parameter

type InlineQueryResultGif 

type InlineQueryResultGif struct {
	// Type - Type of the result, must be gif
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// GifURL - A valid URL for the GIF file
	GifURL string `json:"gif_url"`

	// GifWidth - Optional. Width of the GIF
	GifWidth int `json:"gif_width,omitempty"`

	// GifHeight - Optional. Height of the GIF
	GifHeight int `json:"gif_height,omitempty"`

	// GifDuration - Optional. Duration of the GIF in seconds
	GifDuration int `json:"gif_duration,omitempty"`

	// ThumbnailURL - URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url"`

	// ThumbnailMimeType - Optional. MIME type of the thumbnail, must be one of “image/jpeg”,
	// “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
	ThumbnailMimeType string `json:"thumbnail_mime_type,omitempty"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Caption - Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the GIF animation
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultGif - Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

func (*InlineQueryResultGif) ResultType 

func (i *InlineQueryResultGif) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultGif) WithCaption added in v0.10.0 

func (i *InlineQueryResultGif) WithCaption(caption string) *InlineQueryResultGif

WithCaption adds caption parameter

func (*InlineQueryResultGif) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultGif) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultGif

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultGif) WithGifDuration added in v0.10.0 

func (i *InlineQueryResultGif) WithGifDuration(gifDuration int) *InlineQueryResultGif

WithGifDuration adds gif duration parameter

func (*InlineQueryResultGif) WithGifHeight added in v0.10.0 

func (i *InlineQueryResultGif) WithGifHeight(gifHeight int) *InlineQueryResultGif

WithGifHeight adds gif height parameter

func (*InlineQueryResultGif) WithGifURL added in v0.10.0 

func (i *InlineQueryResultGif) WithGifURL(gifURL string) *InlineQueryResultGif

WithGifURL adds gif URL parameter

func (*InlineQueryResultGif) WithGifWidth added in v0.10.0 

func (i *InlineQueryResultGif) WithGifWidth(gifWidth int) *InlineQueryResultGif

WithGifWidth adds gif width parameter

func (*InlineQueryResultGif) WithID added in v0.10.0 

func (i *InlineQueryResultGif) WithID(iD string) *InlineQueryResultGif

WithID adds ID parameter

func (*InlineQueryResultGif) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultGif) WithInputMessageContent(inputMessageContent InputMessageContent) *InlineQueryResultGif

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultGif) WithParseMode added in v0.10.0 

func (i *InlineQueryResultGif) WithParseMode(parseMode string) *InlineQueryResultGif

WithParseMode adds parse mode parameter

func (*InlineQueryResultGif) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultGif) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultGif

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultGif) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultGif) WithShowCaptionAboveMedia() *InlineQueryResultGif

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultGif) WithThumbnailMimeType added in v0.22.0 

func (i *InlineQueryResultGif) WithThumbnailMimeType(thumbnailMimeType string) *InlineQueryResultGif

WithThumbnailMimeType adds thumbnail mime type parameter

func (*InlineQueryResultGif) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultGif) WithThumbnailURL(thumbnailURL string) *InlineQueryResultGif

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultGif) WithTitle added in v0.10.0 

func (i *InlineQueryResultGif) WithTitle(title string) *InlineQueryResultGif

WithTitle adds title parameter

type InlineQueryResultLocation 

type InlineQueryResultLocation struct {
	// Type - Type of the result, must be location
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 Bytes
	ID string `json:"id"`

	// Latitude - Location latitude in degrees
	Latitude float64 `json:"latitude"`

	// Longitude - Location longitude in degrees
	Longitude float64 `json:"longitude"`

	// Title - Location title
	Title string `json:"title"`

	// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// LivePeriod - Optional. Period in seconds during which the location can be updated, should be between 60
	// and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
	LivePeriod int `json:"live_period,omitempty"`

	// Heading - Optional. For live locations, a direction in which the user is moving, in degrees. Must be
	// between 1 and 360 if specified.
	Heading int `json:"heading,omitempty"`

	// ProximityAlertRadius - Optional. For live locations, a maximum distance for proximity alerts about
	// approaching another chat member, in meters. Must be between 1 and 100000 if specified.
	ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the location
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`

	// ThumbnailURL - Optional. URL of the thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url,omitempty"`

	// ThumbnailWidth - Optional. Thumbnail width
	ThumbnailWidth int `json:"thumbnail_width,omitempty"`

	// ThumbnailHeight - Optional. Thumbnail height
	ThumbnailHeight int `json:"thumbnail_height,omitempty"`
}

InlineQueryResultLocation - Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

func (*InlineQueryResultLocation) ResultType 

func (i *InlineQueryResultLocation) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultLocation) WithHeading added in v0.10.0 

func (i *InlineQueryResultLocation) WithHeading(heading int) *InlineQueryResultLocation

WithHeading adds heading parameter

func (*InlineQueryResultLocation) WithHorizontalAccuracy added in v1.1.0 

func (i *InlineQueryResultLocation) WithHorizontalAccuracy(horizontalAccuracy float64) *InlineQueryResultLocation

WithHorizontalAccuracy adds horizontal accuracy parameter

func (*InlineQueryResultLocation) WithID added in v0.10.0 

func (i *InlineQueryResultLocation) WithID(iD string) *InlineQueryResultLocation

WithID adds ID parameter

func (*InlineQueryResultLocation) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultLocation) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultLocation

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultLocation) WithLatitude added in v1.1.0 

func (i *InlineQueryResultLocation) WithLatitude(latitude float64) *InlineQueryResultLocation

WithLatitude adds latitude parameter

func (*InlineQueryResultLocation) WithLivePeriod added in v0.10.0 

func (i *InlineQueryResultLocation) WithLivePeriod(livePeriod int) *InlineQueryResultLocation

WithLivePeriod adds live period parameter

func (*InlineQueryResultLocation) WithLongitude added in v1.1.0 

func (i *InlineQueryResultLocation) WithLongitude(longitude float64) *InlineQueryResultLocation

WithLongitude adds longitude parameter

func (*InlineQueryResultLocation) WithProximityAlertRadius added in v0.10.0 

func (i *InlineQueryResultLocation) WithProximityAlertRadius(proximityAlertRadius int) *InlineQueryResultLocation

WithProximityAlertRadius adds proximity alert radius parameter

func (*InlineQueryResultLocation) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultLocation) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultLocation

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultLocation) WithThumbnailHeight added in v0.22.0 

func (i *InlineQueryResultLocation) WithThumbnailHeight(thumbnailHeight int) *InlineQueryResultLocation

WithThumbnailHeight adds thumbnail height parameter

func (*InlineQueryResultLocation) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultLocation) WithThumbnailURL(thumbnailURL string) *InlineQueryResultLocation

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultLocation) WithThumbnailWidth added in v0.22.0 

func (i *InlineQueryResultLocation) WithThumbnailWidth(thumbnailWidth int) *InlineQueryResultLocation

WithThumbnailWidth adds thumbnail width parameter

func (*InlineQueryResultLocation) WithTitle added in v0.10.0 

func (i *InlineQueryResultLocation) WithTitle(title string) *InlineQueryResultLocation

WithTitle adds title parameter

type InlineQueryResultMpeg4Gif 

type InlineQueryResultMpeg4Gif struct {
	// Type - Type of the result, must be mpeg4_gif
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// Mpeg4URL - A valid URL for the MPEG4 file
	Mpeg4URL string `json:"mpeg4_url"`

	// Mpeg4Width - Optional. Video width
	Mpeg4Width int `json:"mpeg4_width,omitempty"`

	// Mpeg4Height - Optional. Video height
	Mpeg4Height int `json:"mpeg4_height,omitempty"`

	// Mpeg4Duration - Optional. Video duration in seconds
	Mpeg4Duration int `json:"mpeg4_duration,omitempty"`

	// ThumbnailURL - URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url"`

	// ThumbnailMimeType - Optional. MIME type of the thumbnail, must be one of “image/jpeg”,
	// “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
	ThumbnailMimeType string `json:"thumbnail_mime_type,omitempty"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Caption - Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the video animation
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultMpeg4Gif - Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

func (*InlineQueryResultMpeg4Gif) ResultType 

func (i *InlineQueryResultMpeg4Gif) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultMpeg4Gif) WithCaption added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithCaption(caption string) *InlineQueryResultMpeg4Gif

WithCaption adds caption parameter

func (*InlineQueryResultMpeg4Gif) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultMpeg4Gif

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultMpeg4Gif) WithID added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithID(iD string) *InlineQueryResultMpeg4Gif

WithID adds ID parameter

func (*InlineQueryResultMpeg4Gif) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultMpeg4Gif

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultMpeg4Gif) WithMpeg4Duration added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithMpeg4Duration(mpeg4Duration int) *InlineQueryResultMpeg4Gif

WithMpeg4Duration adds mpeg4 duration parameter

func (*InlineQueryResultMpeg4Gif) WithMpeg4Height added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithMpeg4Height(mpeg4Height int) *InlineQueryResultMpeg4Gif

WithMpeg4Height adds mpeg4 height parameter

func (*InlineQueryResultMpeg4Gif) WithMpeg4URL added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithMpeg4URL(mpeg4URL string) *InlineQueryResultMpeg4Gif

WithMpeg4URL adds mpeg4 URL parameter

func (*InlineQueryResultMpeg4Gif) WithMpeg4Width added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithMpeg4Width(mpeg4Width int) *InlineQueryResultMpeg4Gif

WithMpeg4Width adds mpeg4 width parameter

func (*InlineQueryResultMpeg4Gif) WithParseMode added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithParseMode(parseMode string) *InlineQueryResultMpeg4Gif

WithParseMode adds parse mode parameter

func (*InlineQueryResultMpeg4Gif) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultMpeg4Gif

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultMpeg4Gif) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultMpeg4Gif) WithShowCaptionAboveMedia() *InlineQueryResultMpeg4Gif

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultMpeg4Gif) WithThumbnailMimeType added in v0.22.0 

func (i *InlineQueryResultMpeg4Gif) WithThumbnailMimeType(thumbnailMimeType string) *InlineQueryResultMpeg4Gif

WithThumbnailMimeType adds thumbnail mime type parameter

func (*InlineQueryResultMpeg4Gif) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultMpeg4Gif) WithThumbnailURL(thumbnailURL string) *InlineQueryResultMpeg4Gif

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultMpeg4Gif) WithTitle added in v0.10.0 

func (i *InlineQueryResultMpeg4Gif) WithTitle(title string) *InlineQueryResultMpeg4Gif

WithTitle adds title parameter

type InlineQueryResultPhoto 

type InlineQueryResultPhoto struct {
	// Type - Type of the result, must be photo
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// PhotoURL - A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB
	PhotoURL string `json:"photo_url"`

	// ThumbnailURL - URL of the thumbnail for the photo
	ThumbnailURL string `json:"thumbnail_url"`

	// PhotoWidth - Optional. Width of the photo
	PhotoWidth int `json:"photo_width,omitempty"`

	// PhotoHeight - Optional. Height of the photo
	PhotoHeight int `json:"photo_height,omitempty"`

	// Title - Optional. Title for the result
	Title string `json:"title,omitempty"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the photo
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultPhoto - Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

func (*InlineQueryResultPhoto) ResultType 

func (i *InlineQueryResultPhoto) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultPhoto) WithCaption added in v0.10.0 

func (i *InlineQueryResultPhoto) WithCaption(caption string) *InlineQueryResultPhoto

WithCaption adds caption parameter

func (*InlineQueryResultPhoto) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultPhoto) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultPhoto

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultPhoto) WithDescription added in v0.10.0 

func (i *InlineQueryResultPhoto) WithDescription(description string) *InlineQueryResultPhoto

WithDescription adds description parameter

func (*InlineQueryResultPhoto) WithID added in v0.10.0 

func (i *InlineQueryResultPhoto) WithID(iD string) *InlineQueryResultPhoto

WithID adds ID parameter

func (*InlineQueryResultPhoto) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultPhoto) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultPhoto

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultPhoto) WithParseMode added in v0.10.0 

func (i *InlineQueryResultPhoto) WithParseMode(parseMode string) *InlineQueryResultPhoto

WithParseMode adds parse mode parameter

func (*InlineQueryResultPhoto) WithPhotoHeight added in v0.10.0 

func (i *InlineQueryResultPhoto) WithPhotoHeight(photoHeight int) *InlineQueryResultPhoto

WithPhotoHeight adds photo height parameter

func (*InlineQueryResultPhoto) WithPhotoURL added in v0.10.0 

func (i *InlineQueryResultPhoto) WithPhotoURL(photoURL string) *InlineQueryResultPhoto

WithPhotoURL adds photo URL parameter

func (*InlineQueryResultPhoto) WithPhotoWidth added in v0.10.0 

func (i *InlineQueryResultPhoto) WithPhotoWidth(photoWidth int) *InlineQueryResultPhoto

WithPhotoWidth adds photo width parameter

func (*InlineQueryResultPhoto) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultPhoto) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultPhoto

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultPhoto) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultPhoto) WithShowCaptionAboveMedia() *InlineQueryResultPhoto

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultPhoto) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultPhoto) WithThumbnailURL(thumbnailURL string) *InlineQueryResultPhoto

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultPhoto) WithTitle added in v0.10.0 

func (i *InlineQueryResultPhoto) WithTitle(title string) *InlineQueryResultPhoto

WithTitle adds title parameter

type InlineQueryResultVenue 

type InlineQueryResultVenue struct {
	// Type - Type of the result, must be venue
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 Bytes
	ID string `json:"id"`

	// Latitude - Latitude of the venue location in degrees
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of the venue location in degrees
	Longitude float64 `json:"longitude"`

	// Title - Title of the venue
	Title string `json:"title"`

	// Address - Address of the venue
	Address string `json:"address"`

	// FoursquareID - Optional. Foursquare identifier of the venue if known
	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
	// (https://developers.google.com/places/web-service/supported_types).)
	GooglePlaceType string `json:"google_place_type,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the venue
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`

	// ThumbnailURL - Optional. URL of the thumbnail for the result
	ThumbnailURL string `json:"thumbnail_url,omitempty"`

	// ThumbnailWidth - Optional. Thumbnail width
	ThumbnailWidth int `json:"thumbnail_width,omitempty"`

	// ThumbnailHeight - Optional. Thumbnail height
	ThumbnailHeight int `json:"thumbnail_height,omitempty"`
}

InlineQueryResultVenue - Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

func (*InlineQueryResultVenue) ResultType 

func (i *InlineQueryResultVenue) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultVenue) WithAddress added in v0.10.0 

func (i *InlineQueryResultVenue) WithAddress(address string) *InlineQueryResultVenue

WithAddress adds address parameter

func (*InlineQueryResultVenue) WithFoursquareID added in v0.10.0 

func (i *InlineQueryResultVenue) WithFoursquareID(foursquareID string) *InlineQueryResultVenue

WithFoursquareID adds foursquare ID parameter

func (*InlineQueryResultVenue) WithFoursquareType added in v0.10.0 

func (i *InlineQueryResultVenue) WithFoursquareType(foursquareType string) *InlineQueryResultVenue

WithFoursquareType adds foursquare type parameter

func (*InlineQueryResultVenue) WithGooglePlaceID added in v0.10.0 

func (i *InlineQueryResultVenue) WithGooglePlaceID(googlePlaceID string) *InlineQueryResultVenue

WithGooglePlaceID adds google place ID parameter

func (*InlineQueryResultVenue) WithGooglePlaceType added in v0.10.0 

func (i *InlineQueryResultVenue) WithGooglePlaceType(googlePlaceType string) *InlineQueryResultVenue

WithGooglePlaceType adds google place type parameter

func (*InlineQueryResultVenue) WithID added in v0.10.0 

func (i *InlineQueryResultVenue) WithID(iD string) *InlineQueryResultVenue

WithID adds ID parameter

func (*InlineQueryResultVenue) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultVenue) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultVenue

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultVenue) WithLatitude added in v1.1.0 

func (i *InlineQueryResultVenue) WithLatitude(latitude float64) *InlineQueryResultVenue

WithLatitude adds latitude parameter

func (*InlineQueryResultVenue) WithLongitude added in v1.1.0 

func (i *InlineQueryResultVenue) WithLongitude(longitude float64) *InlineQueryResultVenue

WithLongitude adds longitude parameter

func (*InlineQueryResultVenue) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultVenue) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultVenue

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultVenue) WithThumbnailHeight added in v0.22.0 

func (i *InlineQueryResultVenue) WithThumbnailHeight(thumbnailHeight int) *InlineQueryResultVenue

WithThumbnailHeight adds thumbnail height parameter

func (*InlineQueryResultVenue) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultVenue) WithThumbnailURL(thumbnailURL string) *InlineQueryResultVenue

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultVenue) WithThumbnailWidth added in v0.22.0 

func (i *InlineQueryResultVenue) WithThumbnailWidth(thumbnailWidth int) *InlineQueryResultVenue

WithThumbnailWidth adds thumbnail width parameter

func (*InlineQueryResultVenue) WithTitle added in v0.10.0 

func (i *InlineQueryResultVenue) WithTitle(title string) *InlineQueryResultVenue

WithTitle adds title parameter

type InlineQueryResultVideo 

type InlineQueryResultVideo struct {
	// Type - Type of the result, must be video
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// VideoURL - A valid URL for the embedded video player or video file
	VideoURL string `json:"video_url"`

	// MimeType - MIME type of the content of the video URL, “text/html” or “video/mp4”
	MimeType string `json:"mime_type"`

	// ThumbnailURL - URL of the thumbnail (JPEG only) for the video
	ThumbnailURL string `json:"thumbnail_url"`

	// Title - Title for the result
	Title string `json:"title"`

	// Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// VideoWidth - Optional. Video width
	VideoWidth int `json:"video_width,omitempty"`

	// VideoHeight - Optional. Video height
	VideoHeight int `json:"video_height,omitempty"`

	// VideoDuration - Optional. Video duration in seconds
	VideoDuration int `json:"video_duration,omitempty"`

	// Description - Optional. Short description of the result
	Description string `json:"description,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the video. This field is
	// required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultVideo - Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video. If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.

func (*InlineQueryResultVideo) ResultType 

func (i *InlineQueryResultVideo) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultVideo) WithCaption added in v0.10.0 

func (i *InlineQueryResultVideo) WithCaption(caption string) *InlineQueryResultVideo

WithCaption adds caption parameter

func (*InlineQueryResultVideo) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultVideo) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultVideo

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultVideo) WithDescription added in v0.10.0 

func (i *InlineQueryResultVideo) WithDescription(description string) *InlineQueryResultVideo

WithDescription adds description parameter

func (*InlineQueryResultVideo) WithID added in v0.10.0 

func (i *InlineQueryResultVideo) WithID(iD string) *InlineQueryResultVideo

WithID adds ID parameter

func (*InlineQueryResultVideo) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultVideo) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultVideo

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultVideo) WithMimeType added in v0.10.0 

func (i *InlineQueryResultVideo) WithMimeType(mimeType string) *InlineQueryResultVideo

WithMimeType adds mime type parameter

func (*InlineQueryResultVideo) WithParseMode added in v0.10.0 

func (i *InlineQueryResultVideo) WithParseMode(parseMode string) *InlineQueryResultVideo

WithParseMode adds parse mode parameter

func (*InlineQueryResultVideo) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultVideo) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultVideo

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultVideo) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InlineQueryResultVideo) WithShowCaptionAboveMedia() *InlineQueryResultVideo

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InlineQueryResultVideo) WithThumbnailURL added in v0.22.0 

func (i *InlineQueryResultVideo) WithThumbnailURL(thumbnailURL string) *InlineQueryResultVideo

WithThumbnailURL adds thumbnail URL parameter

func (*InlineQueryResultVideo) WithTitle added in v0.10.0 

func (i *InlineQueryResultVideo) WithTitle(title string) *InlineQueryResultVideo

WithTitle adds title parameter

func (*InlineQueryResultVideo) WithVideoDuration added in v0.10.0 

func (i *InlineQueryResultVideo) WithVideoDuration(videoDuration int) *InlineQueryResultVideo

WithVideoDuration adds video duration parameter

func (*InlineQueryResultVideo) WithVideoHeight added in v0.10.0 

func (i *InlineQueryResultVideo) WithVideoHeight(videoHeight int) *InlineQueryResultVideo

WithVideoHeight adds video height parameter

func (*InlineQueryResultVideo) WithVideoURL added in v0.10.0 

func (i *InlineQueryResultVideo) WithVideoURL(videoURL string) *InlineQueryResultVideo

WithVideoURL adds video URL parameter

func (*InlineQueryResultVideo) WithVideoWidth added in v0.10.0 

func (i *InlineQueryResultVideo) WithVideoWidth(videoWidth int) *InlineQueryResultVideo

WithVideoWidth adds video width parameter

type InlineQueryResultVoice 

type InlineQueryResultVoice struct {
	// Type - Type of the result, must be voice
	Type string `json:"type"`

	// ID - Unique identifier for this result, 1-64 bytes
	ID string `json:"id"`

	// VoiceURL - A valid URL for the voice recording
	VoiceURL string `json:"voice_url"`

	// Title - Recording title
	Title string `json:"title"`

	// Caption - Optional. 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// VoiceDuration - Optional. Recording duration in seconds
	VoiceDuration int `json:"voice_duration,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard (https://core.telegram.org/bots/features#inline-keyboards)
	// attached to the message
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`

	// InputMessageContent - Optional. Content of the message to be sent instead of the voice recording
	InputMessageContent InputMessageContent `json:"input_message_content,omitempty"`
}

InlineQueryResultVoice - Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

func (*InlineQueryResultVoice) ResultType 

func (i *InlineQueryResultVoice) ResultType() string

ResultType returns InlineQueryResult type

func (*InlineQueryResultVoice) WithCaption added in v0.10.0 

func (i *InlineQueryResultVoice) WithCaption(caption string) *InlineQueryResultVoice

WithCaption adds caption parameter

func (*InlineQueryResultVoice) WithCaptionEntities added in v0.10.0 

func (i *InlineQueryResultVoice) WithCaptionEntities(captionEntities ...MessageEntity) *InlineQueryResultVoice

WithCaptionEntities adds caption entities parameter

func (*InlineQueryResultVoice) WithID added in v0.10.0 

func (i *InlineQueryResultVoice) WithID(iD string) *InlineQueryResultVoice

WithID adds ID parameter

func (*InlineQueryResultVoice) WithInputMessageContent added in v0.10.0 

func (i *InlineQueryResultVoice) WithInputMessageContent(inputMessageContent InputMessageContent,
) *InlineQueryResultVoice

WithInputMessageContent adds input message content parameter

func (*InlineQueryResultVoice) WithParseMode added in v0.10.0 

func (i *InlineQueryResultVoice) WithParseMode(parseMode string) *InlineQueryResultVoice

WithParseMode adds parse mode parameter

func (*InlineQueryResultVoice) WithReplyMarkup added in v0.10.0 

func (i *InlineQueryResultVoice) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *InlineQueryResultVoice

WithReplyMarkup adds reply markup parameter

func (*InlineQueryResultVoice) WithTitle added in v0.10.0 

func (i *InlineQueryResultVoice) WithTitle(title string) *InlineQueryResultVoice

WithTitle adds title parameter

func (*InlineQueryResultVoice) WithVoiceDuration added in v0.10.0 

func (i *InlineQueryResultVoice) WithVoiceDuration(voiceDuration int) *InlineQueryResultVoice

WithVoiceDuration adds voice duration parameter

func (*InlineQueryResultVoice) WithVoiceURL added in v0.10.0 

func (i *InlineQueryResultVoice) WithVoiceURL(voiceURL string) *InlineQueryResultVoice

WithVoiceURL adds voice URL parameter

type InlineQueryResultsButton added in v0.22.1 

type InlineQueryResultsButton struct {
	// Text - Label text on the button
	Text string `json:"text"`

	// WebApp - Optional. Description of the Web App (https://core.telegram.org/bots/webapps) 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 (https://core.telegram.org/bots/webapps#initializing-mini-apps) inside the Web
	// App.
	WebApp *WebAppInfo `json:"web_app,omitempty"`

	// StartParameter - Optional. Deep-linking (https://core.telegram.org/bots/features#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 (https://core.telegram.org/bots/api#inlinekeyboardmarkup) 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"`
}

InlineQueryResultsButton - This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

type InputChecklist added in v1.2.0 

type InputChecklist struct {
	// 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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, and custom_emoji
	// 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"`

	// OthersCanMarkTasksAsDone - 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"`
}

InputChecklist - Describes a checklist to create.

func (*InputChecklist) WithOthersCanAddTasks added in v1.2.0 

func (i *InputChecklist) WithOthersCanAddTasks() *InputChecklist

WithOthersCanAddTasks adds others can add tasks parameter

func (*InputChecklist) WithOthersCanMarkTasksAsDone added in v1.2.0 

func (i *InputChecklist) WithOthersCanMarkTasksAsDone() *InputChecklist

WithOthersCanMarkTasksAsDone adds others can mark tasks as done parameter

func (*InputChecklist) WithParseMode added in v1.2.0 

func (i *InputChecklist) WithParseMode(parseMode string) *InputChecklist

WithParseMode adds parse mode parameter

func (*InputChecklist) WithTasks added in v1.2.0 

func (i *InputChecklist) WithTasks(tasks ...InputChecklistTask) *InputChecklist

WithTasks adds tasks parameter

func (*InputChecklist) WithTitle added in v1.2.0 

func (i *InputChecklist) WithTitle(title string) *InputChecklist

WithTitle adds title parameter

func (*InputChecklist) WithTitleEntities added in v1.2.0 

func (i *InputChecklist) WithTitleEntities(titleEntities ...MessageEntity) *InputChecklist

WithTitleEntities adds title entities parameter

type InputChecklistTask added in v1.2.0 

type InputChecklistTask struct {
	// ID - Unique identifier of the task; must be positive and unique among all task identifiers currently
	// present in the checklist
	ID int `json:"id"`

	// 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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, and custom_emoji entities are
	// allowed.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

InputChecklistTask - Describes a task to add to a checklist.

func (*InputChecklistTask) WithID added in v1.2.0 

func (i *InputChecklistTask) WithID(iD int) *InputChecklistTask

WithID adds ID parameter

func (*InputChecklistTask) WithParseMode added in v1.2.0 

func (i *InputChecklistTask) WithParseMode(parseMode string) *InputChecklistTask

WithParseMode adds parse mode parameter

func (*InputChecklistTask) WithText added in v1.2.0 

func (i *InputChecklistTask) WithText(text string) *InputChecklistTask

WithText adds text parameter

func (*InputChecklistTask) WithTextEntities added in v1.2.0 

func (i *InputChecklistTask) WithTextEntities(textEntities ...MessageEntity) *InputChecklistTask

WithTextEntities adds text entities parameter

type InputContactMessageContent 

type InputContactMessageContent struct {
	// PhoneNumber - Contact's phone number
	PhoneNumber string `json:"phone_number"`

	// FirstName - Contact's first name
	FirstName string `json:"first_name"`

	// LastName - Optional. Contact's last name
	LastName string `json:"last_name,omitempty"`

	// Vcard - Optional. Additional data about the contact in the form of a vCard
	// (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes
	Vcard string `json:"vcard,omitempty"`
}

InputContactMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a contact message to be sent as the result of an inline query.

func (*InputContactMessageContent) ContentType 

func (i *InputContactMessageContent) ContentType() string

ContentType returns InputMessageContent type

func (*InputContactMessageContent) WithFirstName added in v0.10.0 

func (i *InputContactMessageContent) WithFirstName(firstName string) *InputContactMessageContent

WithFirstName adds first name parameter

func (*InputContactMessageContent) WithLastName added in v0.10.0 

func (i *InputContactMessageContent) WithLastName(lastName string) *InputContactMessageContent

WithLastName adds last name parameter

func (*InputContactMessageContent) WithPhoneNumber added in v0.10.0 

func (i *InputContactMessageContent) WithPhoneNumber(phoneNumber string) *InputContactMessageContent

WithPhoneNumber adds phone number parameter

func (*InputContactMessageContent) WithVcard added in v0.10.0 

func (i *InputContactMessageContent) WithVcard(vcard string) *InputContactMessageContent

WithVcard adds vcard parameter

type InputFile 

type InputFile struct {
	// File - Object that can be treated as file (has name and data to read).
	// Implemented by os.File.
	File telegoapi.NamedReader

	// FileID - ID of file stored in Telegram
	FileID string

	// URL - URL to get file from
	URL string
	// contains filtered or unexported fields
}

InputFile - This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.

func (InputFile) MarshalJSON 

func (i InputFile) MarshalJSON() ([]byte, error)

MarshalJSON return JSON representation of InputFile

func (InputFile) String 

func (i InputFile) String() string

String returns string representation of InputFile

type InputInvoiceMessageContent 

type InputInvoiceMessageContent struct {
	// Title - Product name, 1-32 characters
	Title string `json:"title"`

	// Description - Product description, 1-255 characters
	Description string `json:"description"`

	// Payload - 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 (https://t.me/botfather). Pass
	// an empty string for payments in Telegram Stars (https://t.me/BotNews/90).
	ProviderToken string `json:"provider_token,omitempty"`

	// Currency - Three-letter ISO 4217 currency code, see more on currencies
	// (https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in Telegram Stars
	// (https://t.me/BotNews/90).
	Currency string `json:"currency"`

	// Prices - 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
	// (https://t.me/BotNews/90).
	Prices []LabeledPrice `json:"prices"`

	// MaxTipAmount - Optional. The maximum accepted amount for tips in the smallest units of the currency
	// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the
	// exp parameter in currencies.json (https://core.telegram.org/bots/payments/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 (https://t.me/BotNews/90).
	MaxTipAmount int `json:"max_tip_amount,omitempty"`

	// SuggestedTipAmounts - Optional. A JSON-serialized array of suggested amounts of tip 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. A JSON-serialized object for data about the invoice, which will be shared with
	// the payment provider. A detailed description of the 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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	NeedShippingAddress bool `json:"need_shipping_address,omitempty"`

	// SendPhoneNumberToProvider - Optional. Pass True if the user's phone number should be sent to the
	// provider. Ignored for payments in Telegram Stars (https://t.me/BotNews/90).
	SendPhoneNumberToProvider 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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	IsFlexible bool `json:"is_flexible,omitempty"`
}

InputInvoiceMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of an invoice message to be sent as the result of an inline query.

func (*InputInvoiceMessageContent) ContentType 

func (i *InputInvoiceMessageContent) ContentType() string

ContentType returns InputMessageContent type

func (*InputInvoiceMessageContent) WithCurrency added in v0.10.0 

func (i *InputInvoiceMessageContent) WithCurrency(currency string) *InputInvoiceMessageContent

WithCurrency adds currency parameter

func (*InputInvoiceMessageContent) WithDescription added in v0.10.0 

func (i *InputInvoiceMessageContent) WithDescription(description string) *InputInvoiceMessageContent

WithDescription adds description parameter

func (*InputInvoiceMessageContent) WithIsFlexible added in v0.10.0 

func (i *InputInvoiceMessageContent) WithIsFlexible() *InputInvoiceMessageContent

WithIsFlexible adds is flexible parameter

func (*InputInvoiceMessageContent) WithMaxTipAmount added in v0.10.0 

func (i *InputInvoiceMessageContent) WithMaxTipAmount(maxTipAmount int) *InputInvoiceMessageContent

WithMaxTipAmount adds max tip amount parameter

func (*InputInvoiceMessageContent) WithNeedEmail added in v0.10.0 

func (i *InputInvoiceMessageContent) WithNeedEmail() *InputInvoiceMessageContent

WithNeedEmail adds need email parameter

func (*InputInvoiceMessageContent) WithNeedName added in v0.10.0 

func (i *InputInvoiceMessageContent) WithNeedName() *InputInvoiceMessageContent

WithNeedName adds need name parameter

func (*InputInvoiceMessageContent) WithNeedPhoneNumber added in v0.10.0 

func (i *InputInvoiceMessageContent) WithNeedPhoneNumber() *InputInvoiceMessageContent

WithNeedPhoneNumber adds need phone number parameter

func (*InputInvoiceMessageContent) WithNeedShippingAddress added in v0.10.0 

func (i *InputInvoiceMessageContent) WithNeedShippingAddress() *InputInvoiceMessageContent

WithNeedShippingAddress adds need shipping address parameter

func (*InputInvoiceMessageContent) WithPayload added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPayload(payload string) *InputInvoiceMessageContent

WithPayload adds payload parameter

func (*InputInvoiceMessageContent) WithPhotoHeight added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPhotoHeight(photoHeight int) *InputInvoiceMessageContent

WithPhotoHeight adds photo height parameter

func (*InputInvoiceMessageContent) WithPhotoSize added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPhotoSize(photoSize int) *InputInvoiceMessageContent

WithPhotoSize adds photo size parameter

func (*InputInvoiceMessageContent) WithPhotoURL added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPhotoURL(photoURL string) *InputInvoiceMessageContent

WithPhotoURL adds photo URL parameter

func (*InputInvoiceMessageContent) WithPhotoWidth added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPhotoWidth(photoWidth int) *InputInvoiceMessageContent

WithPhotoWidth adds photo width parameter

func (*InputInvoiceMessageContent) WithPrices added in v0.10.0 

func (i *InputInvoiceMessageContent) WithPrices(prices ...LabeledPrice) *InputInvoiceMessageContent

WithPrices adds prices parameter

func (*InputInvoiceMessageContent) WithProviderData added in v0.10.0 

func (i *InputInvoiceMessageContent) WithProviderData(providerData string) *InputInvoiceMessageContent

WithProviderData adds provider data parameter

func (*InputInvoiceMessageContent) WithProviderToken added in v0.10.0 

func (i *InputInvoiceMessageContent) WithProviderToken(providerToken string) *InputInvoiceMessageContent

WithProviderToken adds provider token parameter

func (*InputInvoiceMessageContent) WithSendEmailToProvider added in v0.10.0 

func (i *InputInvoiceMessageContent) WithSendEmailToProvider() *InputInvoiceMessageContent

WithSendEmailToProvider adds send email to provider parameter

func (*InputInvoiceMessageContent) WithSendPhoneNumberToProvider added in v0.10.0 

func (i *InputInvoiceMessageContent) WithSendPhoneNumberToProvider() *InputInvoiceMessageContent

WithSendPhoneNumberToProvider adds send phone number to provider parameter

func (*InputInvoiceMessageContent) WithSuggestedTipAmounts added in v0.10.0 

func (i *InputInvoiceMessageContent) WithSuggestedTipAmounts(suggestedTipAmounts ...int) *InputInvoiceMessageContent

WithSuggestedTipAmounts adds suggested tip amounts parameter

func (*InputInvoiceMessageContent) WithTitle added in v0.10.0 

func (i *InputInvoiceMessageContent) WithTitle(title string) *InputInvoiceMessageContent

WithTitle adds title parameter

type InputLocationMessageContent 

type InputLocationMessageContent struct {
	// Latitude - Latitude of the location in degrees
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of the location in degrees
	Longitude float64 `json:"longitude"`

	// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// LivePeriod - Optional. Period in seconds during which the location can be updated, should be between 60
	// and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
	LivePeriod int `json:"live_period,omitempty"`

	// Heading - Optional. For live locations, a direction in which the user is moving, in degrees. Must be
	// between 1 and 360 if specified.
	Heading int `json:"heading,omitempty"`

	// ProximityAlertRadius - Optional. For live locations, a maximum distance for proximity alerts about
	// approaching another chat member, in meters. Must be between 1 and 100000 if specified.
	ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
}

InputLocationMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a location message to be sent as the result of an inline query.

func (*InputLocationMessageContent) ContentType 

func (i *InputLocationMessageContent) ContentType() string

ContentType returns InputMessageContent type

func (*InputLocationMessageContent) WithHeading added in v0.10.0 

func (i *InputLocationMessageContent) WithHeading(heading int) *InputLocationMessageContent

WithHeading adds heading parameter

func (*InputLocationMessageContent) WithHorizontalAccuracy added in v1.1.0 

func (i *InputLocationMessageContent) WithHorizontalAccuracy(horizontalAccuracy float64) *InputLocationMessageContent

WithHorizontalAccuracy adds horizontal accuracy parameter

func (*InputLocationMessageContent) WithLatitude added in v1.1.0 

func (i *InputLocationMessageContent) WithLatitude(latitude float64) *InputLocationMessageContent

WithLatitude adds latitude parameter

func (*InputLocationMessageContent) WithLivePeriod added in v0.10.0 

func (i *InputLocationMessageContent) WithLivePeriod(livePeriod int) *InputLocationMessageContent

WithLivePeriod adds live period parameter

func (*InputLocationMessageContent) WithLongitude added in v1.1.0 

func (i *InputLocationMessageContent) WithLongitude(longitude float64) *InputLocationMessageContent

WithLongitude adds longitude parameter

func (*InputLocationMessageContent) WithProximityAlertRadius added in v0.10.0 

func (i *InputLocationMessageContent) WithProximityAlertRadius(proximityAlertRadius int) *InputLocationMessageContent

WithProximityAlertRadius adds proximity alert radius parameter

type InputMedia 

type InputMedia interface {
	// MediaType return InputMedia type
	MediaType() string
	// contains filtered or unexported methods
}

InputMedia - This object represents the content of a media message to be sent. It should be one of InputMediaAnimation (https://core.telegram.org/bots/api#inputmediaanimation) InputMediaDocument (https://core.telegram.org/bots/api#inputmediadocument) InputMediaAudio (https://core.telegram.org/bots/api#inputmediaaudio) InputMediaPhoto (https://core.telegram.org/bots/api#inputmediaphoto) InputMediaVideo (https://core.telegram.org/bots/api#inputmediavideo)

type InputMediaAnimation 

type InputMediaAnimation struct {
	// Type - Type of the result, must be animation
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Caption - Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the animation caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// Width - Optional. Animation width
	Width int `json:"width,omitempty"`

	// Height - Optional. Animation height
	Height int `json:"height,omitempty"`

	// Duration - Optional. Animation duration in seconds
	Duration int `json:"duration,omitempty"`

	// HasSpoiler - Optional. Pass True if the animation needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaAnimation - Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

func (*InputMediaAnimation) MediaType 

func (i *InputMediaAnimation) MediaType() string

MediaType return InputMedia type

func (*InputMediaAnimation) WithCaption added in v0.10.0 

func (i *InputMediaAnimation) WithCaption(caption string) *InputMediaAnimation

WithCaption adds caption parameter

func (*InputMediaAnimation) WithCaptionEntities added in v0.10.0 

func (i *InputMediaAnimation) WithCaptionEntities(captionEntities ...MessageEntity) *InputMediaAnimation

WithCaptionEntities adds caption entities parameter

func (*InputMediaAnimation) WithDuration added in v0.10.0 

func (i *InputMediaAnimation) WithDuration(duration int) *InputMediaAnimation

WithDuration adds duration parameter

func (*InputMediaAnimation) WithHasSpoiler added in v0.18.1 

func (i *InputMediaAnimation) WithHasSpoiler() *InputMediaAnimation

WithHasSpoiler adds has spoiler parameter

func (*InputMediaAnimation) WithHeight added in v0.10.0 

func (i *InputMediaAnimation) WithHeight(height int) *InputMediaAnimation

WithHeight adds height parameter

func (*InputMediaAnimation) WithMedia added in v0.10.0 

func (i *InputMediaAnimation) WithMedia(media InputFile) *InputMediaAnimation

WithMedia adds media parameter

func (*InputMediaAnimation) WithParseMode added in v0.10.0 

func (i *InputMediaAnimation) WithParseMode(parseMode string) *InputMediaAnimation

WithParseMode adds parse mode parameter

func (*InputMediaAnimation) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InputMediaAnimation) WithShowCaptionAboveMedia() *InputMediaAnimation

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InputMediaAnimation) WithThumbnail added in v0.22.0 

func (i *InputMediaAnimation) WithThumbnail(thumbnail *InputFile) *InputMediaAnimation

WithThumbnail adds thumbnail parameter

func (*InputMediaAnimation) WithWidth added in v0.10.0 

func (i *InputMediaAnimation) WithWidth(width int) *InputMediaAnimation

WithWidth adds width parameter

type InputMediaAudio 

type InputMediaAudio struct {
	// Type - Type of the result, must be audio
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Caption - Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// Duration - Optional. Duration of the audio in seconds
	Duration int `json:"duration,omitempty"`

	// Performer - Optional. Performer of the audio
	Performer string `json:"performer,omitempty"`

	// Title - Optional. Title of the audio
	Title string `json:"title,omitempty"`
}

InputMediaAudio - Represents an audio file to be treated as music to be sent.

func (*InputMediaAudio) MediaType 

func (i *InputMediaAudio) MediaType() string

MediaType return InputMedia type

func (*InputMediaAudio) WithCaption added in v0.10.0 

func (i *InputMediaAudio) WithCaption(caption string) *InputMediaAudio

WithCaption adds caption parameter

func (*InputMediaAudio) WithCaptionEntities added in v0.10.0 

func (i *InputMediaAudio) WithCaptionEntities(captionEntities ...MessageEntity) *InputMediaAudio

WithCaptionEntities adds caption entities parameter

func (*InputMediaAudio) WithDuration added in v0.10.0 

func (i *InputMediaAudio) WithDuration(duration int) *InputMediaAudio

WithDuration adds duration parameter

func (*InputMediaAudio) WithMedia added in v0.10.0 

func (i *InputMediaAudio) WithMedia(media InputFile) *InputMediaAudio

WithMedia adds media parameter

func (*InputMediaAudio) WithParseMode added in v0.10.0 

func (i *InputMediaAudio) WithParseMode(parseMode string) *InputMediaAudio

WithParseMode adds parse mode parameter

func (*InputMediaAudio) WithPerformer added in v0.10.0 

func (i *InputMediaAudio) WithPerformer(performer string) *InputMediaAudio

WithPerformer adds performer parameter

func (*InputMediaAudio) WithThumbnail added in v0.22.0 

func (i *InputMediaAudio) WithThumbnail(thumbnail *InputFile) *InputMediaAudio

WithThumbnail adds thumbnail parameter

func (*InputMediaAudio) WithTitle added in v0.10.0 

func (i *InputMediaAudio) WithTitle(title string) *InputMediaAudio

WithTitle adds title parameter

type InputMediaDocument 

type InputMediaDocument struct {
	// Type - Type of the result, must be document
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// Caption - Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// DisableContentTypeDetection - Optional. Disables automatic server-side content type detection for files
	// uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
	DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
}

InputMediaDocument - Represents a general file to be sent.

func (*InputMediaDocument) MediaType 

func (i *InputMediaDocument) MediaType() string

MediaType return InputMedia type

func (*InputMediaDocument) WithCaption added in v0.10.0 

func (i *InputMediaDocument) WithCaption(caption string) *InputMediaDocument

WithCaption adds caption parameter

func (*InputMediaDocument) WithCaptionEntities added in v0.10.0 

func (i *InputMediaDocument) WithCaptionEntities(captionEntities ...MessageEntity) *InputMediaDocument

WithCaptionEntities adds caption entities parameter

func (*InputMediaDocument) WithDisableContentTypeDetection added in v0.10.0 

func (i *InputMediaDocument) WithDisableContentTypeDetection() *InputMediaDocument

WithDisableContentTypeDetection adds disable content type detection parameter

func (*InputMediaDocument) WithMedia added in v0.10.0 

func (i *InputMediaDocument) WithMedia(media InputFile) *InputMediaDocument

WithMedia adds media parameter

func (*InputMediaDocument) WithParseMode added in v0.10.0 

func (i *InputMediaDocument) WithParseMode(parseMode string) *InputMediaDocument

WithParseMode adds parse mode parameter

func (*InputMediaDocument) WithThumbnail added in v0.22.0 

func (i *InputMediaDocument) WithThumbnail(thumbnail *InputFile) *InputMediaDocument

WithThumbnail adds thumbnail parameter

type InputMediaPhoto 

type InputMediaPhoto struct {
	// Type - Type of the result, must be photo
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// Caption - Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// HasSpoiler - Optional. Pass True if the photo needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaPhoto - Represents a photo to be sent.

func (*InputMediaPhoto) MediaType 

func (i *InputMediaPhoto) MediaType() string

MediaType return InputMedia type

func (*InputMediaPhoto) WithCaption added in v0.10.0 

func (i *InputMediaPhoto) WithCaption(caption string) *InputMediaPhoto

WithCaption adds caption parameter

func (*InputMediaPhoto) WithCaptionEntities added in v0.10.0 

func (i *InputMediaPhoto) WithCaptionEntities(captionEntities ...MessageEntity) *InputMediaPhoto

WithCaptionEntities adds caption entities parameter

func (*InputMediaPhoto) WithHasSpoiler added in v0.18.1 

func (i *InputMediaPhoto) WithHasSpoiler() *InputMediaPhoto

WithHasSpoiler adds has spoiler parameter

func (*InputMediaPhoto) WithMedia added in v0.10.0 

func (i *InputMediaPhoto) WithMedia(media InputFile) *InputMediaPhoto

WithMedia adds media parameter

func (*InputMediaPhoto) WithParseMode added in v0.10.0 

func (i *InputMediaPhoto) WithParseMode(parseMode string) *InputMediaPhoto

WithParseMode adds parse mode parameter

func (*InputMediaPhoto) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InputMediaPhoto) WithShowCaptionAboveMedia() *InputMediaPhoto

WithShowCaptionAboveMedia adds show caption above media parameter

type InputMediaVideo 

type InputMediaVideo struct {
	// Type - Type of the result, must be video
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,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 » (https://core.telegram.org/bots/api#sending-files)
	Cover *InputFile `json:"cover,omitempty"`

	// StartTimestamp - Optional. Start timestamp for the video in the message
	StartTimestamp int `json:"start_timestamp,omitempty"`

	// Caption - Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
	Caption string `json:"caption,omitempty"`

	// ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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"`

	// 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"`

	// HasSpoiler - Optional. Pass True if the video needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`
}

InputMediaVideo - Represents a video to be sent.

func (*InputMediaVideo) MediaType 

func (i *InputMediaVideo) MediaType() string

MediaType return InputMedia type

func (*InputMediaVideo) WithCaption added in v0.10.0 

func (i *InputMediaVideo) WithCaption(caption string) *InputMediaVideo

WithCaption adds caption parameter

func (*InputMediaVideo) WithCaptionEntities added in v0.10.0 

func (i *InputMediaVideo) WithCaptionEntities(captionEntities ...MessageEntity) *InputMediaVideo

WithCaptionEntities adds caption entities parameter

func (*InputMediaVideo) WithCover added in v1.0.2 

func (i *InputMediaVideo) WithCover(cover *InputFile) *InputMediaVideo

WithCover adds cover parameter

func (*InputMediaVideo) WithDuration added in v0.10.0 

func (i *InputMediaVideo) WithDuration(duration int) *InputMediaVideo

WithDuration adds duration parameter

func (*InputMediaVideo) WithHasSpoiler added in v0.18.1 

func (i *InputMediaVideo) WithHasSpoiler() *InputMediaVideo

WithHasSpoiler adds has spoiler parameter

func (*InputMediaVideo) WithHeight added in v0.10.0 

func (i *InputMediaVideo) WithHeight(height int) *InputMediaVideo

WithHeight adds height parameter

func (*InputMediaVideo) WithMedia added in v0.10.0 

func (i *InputMediaVideo) WithMedia(media InputFile) *InputMediaVideo

WithMedia adds media parameter

func (*InputMediaVideo) WithParseMode added in v0.10.0 

func (i *InputMediaVideo) WithParseMode(parseMode string) *InputMediaVideo

WithParseMode adds parse mode parameter

func (*InputMediaVideo) WithShowCaptionAboveMedia added in v0.30.2 

func (i *InputMediaVideo) WithShowCaptionAboveMedia() *InputMediaVideo

WithShowCaptionAboveMedia adds show caption above media parameter

func (*InputMediaVideo) WithStartTimestamp added in v1.0.2 

func (i *InputMediaVideo) WithStartTimestamp(startTimestamp int) *InputMediaVideo

WithStartTimestamp adds start timestamp parameter

func (*InputMediaVideo) WithSupportsStreaming added in v0.10.0 

func (i *InputMediaVideo) WithSupportsStreaming() *InputMediaVideo

WithSupportsStreaming adds supports streaming parameter

func (*InputMediaVideo) WithThumbnail added in v0.22.0 

func (i *InputMediaVideo) WithThumbnail(thumbnail *InputFile) *InputMediaVideo

WithThumbnail adds thumbnail parameter

func (*InputMediaVideo) WithWidth added in v0.10.0 

func (i *InputMediaVideo) WithWidth(width int) *InputMediaVideo

WithWidth adds width parameter

type InputMessageContent 

type InputMessageContent interface {
	// ContentType returns InputMessageContent type
	ContentType() string
	// contains filtered or unexported methods
}

InputMessageContent - This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types: InputTextMessageContent (https://core.telegram.org/bots/api#inputtextmessagecontent) InputLocationMessageContent (https://core.telegram.org/bots/api#inputlocationmessagecontent) InputVenueMessageContent (https://core.telegram.org/bots/api#inputvenuemessagecontent) InputContactMessageContent (https://core.telegram.org/bots/api#inputcontactmessagecontent) InputInvoiceMessageContent (https://core.telegram.org/bots/api#inputinvoicemessagecontent)

type InputPaidMedia added in v0.31.0 

type InputPaidMedia interface {
	// MediaType returns InputPaidMedia type
	MediaType() string
	// MediaFile returns InputPaidMedia file
	MediaFile() InputFile
	// contains filtered or unexported methods
}

InputPaidMedia - This object describes the paid media to be sent. Currently, it can be one of InputPaidMediaPhoto (https://core.telegram.org/bots/api#inputpaidmediaphoto) InputPaidMediaVideo (https://core.telegram.org/bots/api#inputpaidmediavideo)

type InputPaidMediaPhoto added in v0.31.0 

type InputPaidMediaPhoto struct {
	// Type - Type of the media, must be photo
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`
}

InputPaidMediaPhoto - The paid media to send is a photo.

func (*InputPaidMediaPhoto) MediaFile added in v0.31.0 

func (i *InputPaidMediaPhoto) MediaFile() InputFile

MediaFile returns InputPaidMedia file

func (*InputPaidMediaPhoto) MediaType added in v0.31.0 

func (i *InputPaidMediaPhoto) MediaType() string

MediaType returns InputPaidMedia type

func (*InputPaidMediaPhoto) WithMedia added in v1.0.2 

func (i *InputPaidMediaPhoto) WithMedia(media InputFile) *InputPaidMediaPhoto

WithMedia adds media parameter

type InputPaidMediaVideo added in v0.31.0 

type InputPaidMediaVideo struct {
	// Type - Type of the media, must be video
	Type string `json:"type"`

	// Media - File to send. 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
	// » (https://core.telegram.org/bots/api#sending-files)
	Media InputFile `json:"media"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,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 » (https://core.telegram.org/bots/api#sending-files)
	Cover *InputFile `json:"cover,omitempty"`

	// StartTimestamp - Optional. Start timestamp for the video in the message
	StartTimestamp int `json:"start_timestamp,omitempty"`

	// 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"`
}

InputPaidMediaVideo - The paid media to send is a video.

func (*InputPaidMediaVideo) MediaFile added in v0.31.0 

func (i *InputPaidMediaVideo) MediaFile() InputFile

MediaFile returns InputPaidMedia file

func (*InputPaidMediaVideo) MediaType added in v0.31.0 

func (i *InputPaidMediaVideo) MediaType() string

MediaType returns InputPaidMedia type

func (*InputPaidMediaVideo) WithCover added in v1.0.2 

func (i *InputPaidMediaVideo) WithCover(cover *InputFile) *InputPaidMediaVideo

WithCover adds cover parameter

func (*InputPaidMediaVideo) WithDuration added in v1.0.2 

func (i *InputPaidMediaVideo) WithDuration(duration int) *InputPaidMediaVideo

WithDuration adds duration parameter

func (*InputPaidMediaVideo) WithHeight added in v1.0.2 

func (i *InputPaidMediaVideo) WithHeight(height int) *InputPaidMediaVideo

WithHeight adds height parameter

func (*InputPaidMediaVideo) WithMedia added in v1.0.2 

func (i *InputPaidMediaVideo) WithMedia(media InputFile) *InputPaidMediaVideo

WithMedia adds media parameter

func (*InputPaidMediaVideo) WithStartTimestamp added in v1.0.2 

func (i *InputPaidMediaVideo) WithStartTimestamp(startTimestamp int) *InputPaidMediaVideo

WithStartTimestamp adds start timestamp parameter

func (*InputPaidMediaVideo) WithSupportsStreaming added in v1.0.2 

func (i *InputPaidMediaVideo) WithSupportsStreaming() *InputPaidMediaVideo

WithSupportsStreaming adds supports streaming parameter

func (*InputPaidMediaVideo) WithThumbnail added in v1.0.2 

func (i *InputPaidMediaVideo) WithThumbnail(thumbnail *InputFile) *InputPaidMediaVideo

WithThumbnail adds thumbnail parameter

func (*InputPaidMediaVideo) WithWidth added in v1.0.2 

func (i *InputPaidMediaVideo) WithWidth(width int) *InputPaidMediaVideo

WithWidth adds width parameter

type InputPollOption added in v0.30.1 

type InputPollOption struct {
	// Text - Option text, 1-100 characters
	Text string `json:"text"`

	// TextParseMode - Optional. Mode for parsing entities in the text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji
	// entities are allowed
	TextParseMode string `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"`
}

InputPollOption - This object contains information about one answer option in a poll to be sent.

func (*InputPollOption) WithText added in v0.30.1 

func (i *InputPollOption) WithText(text string) *InputPollOption

WithText adds text parameter

func (*InputPollOption) WithTextEntities added in v0.30.1 

func (i *InputPollOption) WithTextEntities(textEntities ...MessageEntity) *InputPollOption

WithTextEntities adds text entities parameter

func (*InputPollOption) WithTextParseMode added in v0.30.1 

func (i *InputPollOption) WithTextParseMode(textParseMode string) *InputPollOption

WithTextParseMode adds text parse mode parameter

type InputProfilePhoto added in v1.1.0 

type InputProfilePhoto interface {
	// ProfilePhotoType return InputProfilePhoto type
	ProfilePhotoType() string
	// contains filtered or unexported methods
}

InputProfilePhoto - This object describes a profile photo to set. Currently, it can be one of InputProfilePhotoStatic (https://core.telegram.org/bots/api#inputprofilephotostatic) InputProfilePhotoAnimated (https://core.telegram.org/bots/api#inputprofilephotoanimated)

type InputProfilePhotoAnimated added in v1.1.0 

type InputProfilePhotoAnimated struct {
	// Type - Type of the profile photo, must be animated
	Type string `json:"type"`

	// 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Animation InputFile `json:"animation"`

	// 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"`
}

InputProfilePhotoAnimated - An animated profile photo in the MPEG4 format.

func (*InputProfilePhotoAnimated) ProfilePhotoType added in v1.1.0 

func (i *InputProfilePhotoAnimated) ProfilePhotoType() string

ProfilePhotoType return InputProfilePhoto type

func (*InputProfilePhotoAnimated) WithAnimation added in v1.1.0 

func (i *InputProfilePhotoAnimated) WithAnimation(animation InputFile) *InputProfilePhotoAnimated

WithAnimation adds animation parameter

func (*InputProfilePhotoAnimated) WithMainFrameTimestamp added in v1.1.0 

func (i *InputProfilePhotoAnimated) WithMainFrameTimestamp(mainFrameTimestamp float64) *InputProfilePhotoAnimated

WithMainFrameTimestamp adds main frame timestamp parameter

type InputProfilePhotoStatic added in v1.1.0 

type InputProfilePhotoStatic struct {
	// Type - Type of the profile photo, must be static
	Type string `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 » (https://core.telegram.org/bots/api#sending-files)
	Photo InputFile `json:"photo"`
}

InputProfilePhotoStatic - A static profile photo in the .JPG format.

func (*InputProfilePhotoStatic) ProfilePhotoType added in v1.1.0 

func (i *InputProfilePhotoStatic) ProfilePhotoType() string

ProfilePhotoType return InputProfilePhoto type

func (*InputProfilePhotoStatic) WithPhoto added in v1.1.0 

func (i *InputProfilePhotoStatic) WithPhoto(photo InputFile) *InputProfilePhotoStatic

WithPhoto adds photo parameter

type InputSticker added in v0.22.0 

type InputSticker struct {
	// Sticker - The added sticker. Pass a file_id as a String to send a file that already exists on the
	// Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass
	// “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name>
	// name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files »
	// (https://core.telegram.org/bots/api#sending-files)
	Sticker InputFile `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 string `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"`
}

InputSticker - This object describes a sticker to be added to a sticker set.

func (*InputSticker) WithEmojiList added in v0.22.0 

func (i *InputSticker) WithEmojiList(emojiList ...string) *InputSticker

WithEmojiList adds emoji list parameter

func (*InputSticker) WithFormat added in v0.29.2 

func (i *InputSticker) WithFormat(format string) *InputSticker

WithFormat adds format parameter

func (*InputSticker) WithKeywords added in v0.22.0 

func (i *InputSticker) WithKeywords(keywords ...string) *InputSticker

WithKeywords adds keywords parameter

func (*InputSticker) WithMaskPosition added in v0.22.0 

func (i *InputSticker) WithMaskPosition(maskPosition *MaskPosition) *InputSticker

WithMaskPosition adds mask position parameter

func (*InputSticker) WithSticker added in v0.22.0 

func (i *InputSticker) WithSticker(sticker InputFile) *InputSticker

WithSticker adds sticker parameter

type InputStoryContent added in v1.1.0 

type InputStoryContent interface {
	// StoryType return InputStoryContent type
	StoryType() string
	// contains filtered or unexported methods
}

InputStoryContent - This object describes the content of a story to post. Currently, it can be one of InputStoryContentPhoto (https://core.telegram.org/bots/api#inputstorycontentphoto) InputStoryContentVideo (https://core.telegram.org/bots/api#inputstorycontentvideo)

type InputStoryContentPhoto added in v1.1.0 

type InputStoryContentPhoto struct {
	// Type - Type of the content, must be photo
	Type string `json:"type"`

	// Photo - The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB.
	// The photo 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 » (https://core.telegram.org/bots/api#sending-files)
	Photo InputFile `json:"photo"`
}

InputStoryContentPhoto - Describes a photo to post as a story.

func (*InputStoryContentPhoto) StoryType added in v1.1.0 

func (i *InputStoryContentPhoto) StoryType() string

StoryType return InputStoryContent type

func (*InputStoryContentPhoto) WithPhoto added in v1.1.0 

func (i *InputStoryContentPhoto) WithPhoto(photo InputFile) *InputStoryContentPhoto

WithPhoto adds photo parameter

type InputStoryContentVideo added in v1.1.0 

type InputStoryContentVideo struct {
	// Type - Type of the content, must be video
	Type string `json:"type"`

	// Video - The video to post as a story. The video must be of the size 720x1280, streamable, encoded with
	// H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video
	// can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if
	// the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files
	// » (https://core.telegram.org/bots/api#sending-files)
	Video InputFile `json:"video"`

	// 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 - Optional. Pass True if the video has no sound
	IsAnimation bool `json:"is_animation,omitempty"`
}

InputStoryContentVideo - Describes a video to post as a story.

func (*InputStoryContentVideo) StoryType added in v1.1.0 

func (i *InputStoryContentVideo) StoryType() string

StoryType return InputStoryContent type

func (*InputStoryContentVideo) WithCoverFrameTimestamp added in v1.1.0 

func (i *InputStoryContentVideo) WithCoverFrameTimestamp(coverFrameTimestamp float64) *InputStoryContentVideo

WithCoverFrameTimestamp adds cover frame timestamp parameter

func (*InputStoryContentVideo) WithDuration added in v1.1.0 

func (i *InputStoryContentVideo) WithDuration(duration float64) *InputStoryContentVideo

WithDuration adds duration parameter

func (*InputStoryContentVideo) WithIsAnimation added in v1.1.0 

func (i *InputStoryContentVideo) WithIsAnimation() *InputStoryContentVideo

WithIsAnimation adds is animation parameter

func (*InputStoryContentVideo) WithVideo added in v1.1.0 

func (i *InputStoryContentVideo) WithVideo(video InputFile) *InputStoryContentVideo

WithVideo adds video parameter

type InputTextMessageContent 

type InputTextMessageContent struct {
	// MessageText - Text of the message to be sent, 1-4096 characters
	MessageText string `json:"message_text"`

	// ParseMode - Optional. Mode for parsing entities in the message text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `json:"parse_mode,omitempty"`

	// Entities - Optional. List of special entities that appear in message text, which can be specified instead
	// of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`

	// LinkPreviewOptions - Optional. Link preview generation options for the message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
}

InputTextMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a text message to be sent as the result of an inline query.

func (*InputTextMessageContent) ContentType 

func (i *InputTextMessageContent) ContentType() string

ContentType returns InputMessageContent type

func (*InputTextMessageContent) WithEntities added in v0.10.0 

func (i *InputTextMessageContent) WithEntities(entities ...MessageEntity) *InputTextMessageContent

WithEntities adds entities parameter

func (*InputTextMessageContent) WithLinkPreviewOptions added in v0.29.0 

func (i *InputTextMessageContent) WithLinkPreviewOptions(
	linkPreviewOptions *LinkPreviewOptions,
) *InputTextMessageContent

WithLinkPreviewOptions adds link preview options parameter

func (*InputTextMessageContent) WithMessageText added in v0.10.0 

func (i *InputTextMessageContent) WithMessageText(messageText string) *InputTextMessageContent

WithMessageText adds message text parameter

func (*InputTextMessageContent) WithParseMode added in v0.10.0 

func (i *InputTextMessageContent) WithParseMode(parseMode string) *InputTextMessageContent

WithParseMode adds parse mode parameter

type InputVenueMessageContent 

type InputVenueMessageContent struct {
	// Latitude - Latitude of the venue in degrees
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of the venue in degrees
	Longitude float64 `json:"longitude"`

	// Title - Name of the venue
	Title string `json:"title"`

	// Address - Address of the venue
	Address string `json:"address"`

	// FoursquareID - Optional. Foursquare identifier of the venue, if known
	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
	// (https://developers.google.com/places/web-service/supported_types).)
	GooglePlaceType string `json:"google_place_type,omitempty"`
}

InputVenueMessageContent - Represents the content (https://core.telegram.org/bots/api#inputmessagecontent) of a venue message to be sent as the result of an inline query.

func (*InputVenueMessageContent) ContentType 

func (i *InputVenueMessageContent) ContentType() string

ContentType returns InputMessageContent type

func (*InputVenueMessageContent) WithAddress added in v0.10.0 

func (i *InputVenueMessageContent) WithAddress(address string) *InputVenueMessageContent

WithAddress adds address parameter

func (*InputVenueMessageContent) WithFoursquareID added in v0.10.0 

func (i *InputVenueMessageContent) WithFoursquareID(foursquareID string) *InputVenueMessageContent

WithFoursquareID adds foursquare ID parameter

func (*InputVenueMessageContent) WithFoursquareType added in v0.10.0 

func (i *InputVenueMessageContent) WithFoursquareType(foursquareType string) *InputVenueMessageContent

WithFoursquareType adds foursquare type parameter

func (*InputVenueMessageContent) WithGooglePlaceID added in v0.10.0 

func (i *InputVenueMessageContent) WithGooglePlaceID(googlePlaceID string) *InputVenueMessageContent

WithGooglePlaceID adds google place ID parameter

func (*InputVenueMessageContent) WithGooglePlaceType added in v0.10.0 

func (i *InputVenueMessageContent) WithGooglePlaceType(googlePlaceType string) *InputVenueMessageContent

WithGooglePlaceType adds google place type parameter

func (*InputVenueMessageContent) WithLatitude added in v1.1.0 

func (i *InputVenueMessageContent) WithLatitude(latitude float64) *InputVenueMessageContent

WithLatitude adds latitude parameter

func (*InputVenueMessageContent) WithLongitude added in v1.1.0 

func (i *InputVenueMessageContent) WithLongitude(longitude float64) *InputVenueMessageContent

WithLongitude adds longitude parameter

func (*InputVenueMessageContent) WithTitle added in v0.10.0 

func (i *InputVenueMessageContent) WithTitle(title string) *InputVenueMessageContent

WithTitle adds title parameter

type Invoice 

type Invoice struct {
	// 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 - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies)
	// code, or “XTR” for payments in Telegram Stars (https://t.me/BotNews/90)
	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
	// (https://core.telegram.org/bots/payments/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"`
}

Invoice - This object contains basic information about an invoice.

type KeyboardButton 

type KeyboardButton struct {
	// Text - Text of the button. If none of the optional fields are used, it will be sent as a message when the
	// button is pressed
	Text string `json:"text"`

	// RequestUsers - Optional. If specified, pressing the button will open a list of suitable users.
	// Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in
	// private chats only.
	RequestUsers *KeyboardButtonRequestUsers `json:"request_users,omitempty"`

	// RequestChat - Optional. If specified, pressing the button will open a list of suitable chats. Tapping on
	// a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats
	// only.
	RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"`

	// RequestContact - Optional. If True, the user's phone number will be sent as a contact when the button is
	// pressed. Available in private chats only.
	RequestContact bool `json:"request_contact,omitempty"`

	// RequestLocation - Optional. If True, the user's current location will be sent when the button is pressed.
	// Available in private chats only.
	RequestLocation bool `json:"request_location,omitempty"`

	// RequestPoll - Optional. If specified, the user will be asked to create a poll and send it to the bot when
	// the button is pressed. Available in private chats only.
	RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`

	// WebApp - Optional. If specified, the described Web App (https://core.telegram.org/bots/webapps) will be
	// launched when the button is pressed. The Web App will be able to send a “web_app_data” service message.
	// Available in private chats only.
	WebApp *WebAppInfo `json:"web_app,omitempty"`
}

KeyboardButton - This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.

func (KeyboardButton) WithRequestChat added in v0.20.1 

func (k KeyboardButton) WithRequestChat(requestChat *KeyboardButtonRequestChat) KeyboardButton

WithRequestChat adds request chat parameter

func (KeyboardButton) WithRequestContact added in v0.10.0 

func (k KeyboardButton) WithRequestContact() KeyboardButton

WithRequestContact adds request contact parameter

func (KeyboardButton) WithRequestLocation added in v0.10.0 

func (k KeyboardButton) WithRequestLocation() KeyboardButton

WithRequestLocation adds request location parameter

func (KeyboardButton) WithRequestPoll added in v0.10.0 

func (k KeyboardButton) WithRequestPoll(requestPoll *KeyboardButtonPollType) KeyboardButton

WithRequestPoll adds request poll parameter

func (KeyboardButton) WithRequestUsers added in v0.29.0 

func (k KeyboardButton) WithRequestUsers(requestUsers *KeyboardButtonRequestUsers) KeyboardButton

WithRequestUsers adds request users parameter

func (KeyboardButton) WithText added in v0.10.0 

func (k KeyboardButton) WithText(text string) KeyboardButton

WithText adds text parameter

func (KeyboardButton) WithWebApp added in v0.11.0 

func (k KeyboardButton) WithWebApp(webApp *WebAppInfo) KeyboardButton

WithWebApp adds web app parameter

type KeyboardButtonPollType 

type KeyboardButtonPollType struct {
	// Type - Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If
	// regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll
	// of any type.
	Type string `json:"type,omitempty"`
}

KeyboardButtonPollType - This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

type KeyboardButtonRequestChat added in v0.20.1 

type KeyboardButtonRequestChat struct {
	// RequestID - Signed 32-bit identifier of the request, which will be received back in the ChatShared
	// (https://core.telegram.org/bots/api#chatshared) object. Must be unique within the message
	RequestID int32 `json:"request_id"`

	// ChatIsChannel - Pass True to request a channel chat, pass False to request a group or a supergroup chat.
	ChatIsChannel bool `json:"chat_is_channel"`

	// ChatIsForum - Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat.
	// If not specified, no additional restrictions are applied.
	ChatIsForum *bool `json:"chat_is_forum,omitempty"`

	// ChatHasUsername - Optional. Pass True to request a supergroup or a channel with a username, pass False to
	// request a chat without a username. If not specified, no additional restrictions are applied.
	ChatHasUsername *bool `json:"chat_has_username,omitempty"`

	// ChatIsCreated - Optional. Pass True to request a chat owned by the user. Otherwise, no additional
	// restrictions are applied.
	ChatIsCreated *bool `json:"chat_is_created,omitempty"`

	// UserAdministratorRights - Optional. A JSON-serialized object listing the required administrator rights of
	// the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no
	// additional restrictions are applied.
	UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"`

	// BotAdministratorRights - Optional. A JSON-serialized object listing the required administrator rights of
	// the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no
	// additional restrictions are applied.
	BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"`

	// BotIsMember - Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional
	// restrictions are applied.
	BotIsMember *bool `json:"bot_is_member,omitempty"`

	// RequestTitle - Optional. Pass True to request the chat's title
	RequestTitle *bool `json:"request_title,omitempty"`

	// RequestUsername - Optional. Pass True to request the chat's username
	RequestUsername *bool `json:"request_username,omitempty"`

	// RequestPhoto - Optional. Pass True to request the chat's photo
	RequestPhoto *bool `json:"request_photo,omitempty"`
}

KeyboardButtonRequestChat - This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats » (https://core.telegram.org/bots/features#chat-and-user-selection).

func (*KeyboardButtonRequestChat) WithBotAdministratorRights added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithBotAdministratorRights(botAdministratorRights *ChatAdministratorRights,
) *KeyboardButtonRequestChat

WithBotAdministratorRights adds bot administrator rights parameter

func (*KeyboardButtonRequestChat) WithBotIsMember added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithBotIsMember(botIsMember bool) *KeyboardButtonRequestChat

WithBotIsMember adds bot is member parameter

func (*KeyboardButtonRequestChat) WithChatHasUsername added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithChatHasUsername(chatHasUsername bool) *KeyboardButtonRequestChat

WithChatHasUsername adds chat has username parameter

func (*KeyboardButtonRequestChat) WithChatIsChannel added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithChatIsChannel() *KeyboardButtonRequestChat

WithChatIsChannel adds chat is channel parameter

func (*KeyboardButtonRequestChat) WithChatIsCreated added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithChatIsCreated(chatIsCreated bool) *KeyboardButtonRequestChat

WithChatIsCreated adds chat is created parameter

func (*KeyboardButtonRequestChat) WithChatIsForum added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithChatIsForum(chatIsForum bool) *KeyboardButtonRequestChat

WithChatIsForum adds chat is forum parameter

func (*KeyboardButtonRequestChat) WithRequestID added in v1.1.0 

func (k *KeyboardButtonRequestChat) WithRequestID(requestID int32) *KeyboardButtonRequestChat

WithRequestID adds request ID parameter

func (*KeyboardButtonRequestChat) WithRequestPhoto added in v0.29.2 

func (k *KeyboardButtonRequestChat) WithRequestPhoto(requestPhoto bool) *KeyboardButtonRequestChat

WithRequestPhoto adds request photo parameter

func (*KeyboardButtonRequestChat) WithRequestTitle added in v0.29.2 

func (k *KeyboardButtonRequestChat) WithRequestTitle(requestTitle bool) *KeyboardButtonRequestChat

WithRequestTitle adds request title parameter

func (*KeyboardButtonRequestChat) WithRequestUsername added in v0.29.2 

func (k *KeyboardButtonRequestChat) WithRequestUsername(requestUsername bool) *KeyboardButtonRequestChat

WithRequestUsername adds request username parameter

func (*KeyboardButtonRequestChat) WithUserAdministratorRights added in v0.26.0 

func (k *KeyboardButtonRequestChat) WithUserAdministratorRights(userAdministratorRights *ChatAdministratorRights,
) *KeyboardButtonRequestChat

WithUserAdministratorRights adds user administrator rights parameter

type KeyboardButtonRequestUsers added in v0.29.0 

type KeyboardButtonRequestUsers struct {
	// RequestID - Signed 32-bit identifier of the request that will be received back in the UsersShared
	// (https://core.telegram.org/bots/api#usersshared) object. Must be unique within the message
	RequestID int32 `json:"request_id"`

	// UserIsBot - Optional. Pass True to request bots, pass False to request regular users. If not specified,
	// no additional restrictions are applied.
	UserIsBot *bool `json:"user_is_bot,omitempty"`

	// UserIsPremium - Optional. Pass True to request premium users, pass False to request non-premium users. If
	// not specified, no additional restrictions are applied.
	UserIsPremium *bool `json:"user_is_premium,omitempty"`

	// MaxQuantity - Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
	MaxQuantity int `json:"max_quantity,omitempty"`

	// RequestName - Optional. Pass True to request the users' first and last names
	RequestName *bool `json:"request_name,omitempty"`

	// RequestUsername - Optional. Pass True to request the users' usernames
	RequestUsername *bool `json:"request_username,omitempty"`

	// RequestPhoto - Optional. Pass True to request the users' photos
	RequestPhoto *bool `json:"request_photo,omitempty"`
}

KeyboardButtonRequestUsers - This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users » (https://core.telegram.org/bots/features#chat-and-user-selection)

func (*KeyboardButtonRequestUsers) WithMaxQuantity added in v0.29.0 

func (k *KeyboardButtonRequestUsers) WithMaxQuantity(maxQuantity int) *KeyboardButtonRequestUsers

WithMaxQuantity adds max quantity parameter

func (*KeyboardButtonRequestUsers) WithRequestID added in v1.1.0 

func (k *KeyboardButtonRequestUsers) WithRequestID(requestID int32) *KeyboardButtonRequestUsers

WithRequestID adds request ID parameter

func (*KeyboardButtonRequestUsers) WithRequestName added in v0.29.2 

func (k *KeyboardButtonRequestUsers) WithRequestName(requestName bool) *KeyboardButtonRequestUsers

WithRequestName adds request name parameter

func (*KeyboardButtonRequestUsers) WithRequestPhoto added in v0.29.2 

func (k *KeyboardButtonRequestUsers) WithRequestPhoto(requestPhoto bool) *KeyboardButtonRequestUsers

WithRequestPhoto adds request photo parameter

func (*KeyboardButtonRequestUsers) WithRequestUsername added in v0.29.2 

func (k *KeyboardButtonRequestUsers) WithRequestUsername(requestUsername bool) *KeyboardButtonRequestUsers

WithRequestUsername adds request username parameter

func (*KeyboardButtonRequestUsers) WithUserIsBot added in v0.29.0 

func (k *KeyboardButtonRequestUsers) WithUserIsBot(userIsBot bool) *KeyboardButtonRequestUsers

WithUserIsBot adds user is bot parameter

func (*KeyboardButtonRequestUsers) WithUserIsPremium added in v0.29.0 

func (k *KeyboardButtonRequestUsers) WithUserIsPremium(userIsPremium bool) *KeyboardButtonRequestUsers

WithUserIsPremium adds user is premium parameter

type LabeledPrice 

type LabeledPrice struct {
	// Label - Portion label
	Label string `json:"label"`

	// Amount - Price of the product in the smallest units of the currency
	// (https://core.telegram.org/bots/payments#supported-currencies) (integer, not float/double). For example, for
	// a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json
	// (https://core.telegram.org/bots/payments/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"`
}

LabeledPrice - This object represents a portion of the price for goods or services.

type LeaveChatParams 

type LeaveChatParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup or channel (in the
	// format @channel_username). Channel direct messages chats aren't supported; leave the corresponding channel
	// instead.
	ChatID ChatID `json:"chat_id"`
}

LeaveChatParams - Represents parameters of leaveChat method.

func (*LeaveChatParams) WithChatID added in v0.10.0 

func (p *LeaveChatParams) WithChatID(chatID ChatID) *LeaveChatParams

WithChatID adds chat ID parameter

type LinkPreviewOptions added in v0.29.0 

type LinkPreviewOptions struct {
	// IsDisabled - Optional. True, if the link preview is disabled
	IsDisabled bool `json:"is_disabled,omitempty"`

	// URL - Optional. URL to use for the link preview. If empty, then the first URL found in the message text
	// will be used
	URL string `json:"url,omitempty"`

	// PreferSmallMedia - Optional. True, if the media in the link preview is supposed to be shrunk; ignored if
	// the URL isn't explicitly specified or media size change isn't supported for the preview
	PreferSmallMedia bool `json:"prefer_small_media,omitempty"`

	// PreferLargeMedia - Optional. True, if the media in the link preview is supposed to be enlarged; ignored
	// if the URL isn't explicitly specified or media size change isn't supported for the preview
	PreferLargeMedia bool `json:"prefer_large_media,omitempty"`

	// ShowAboveText - Optional. True, if the link preview must be shown above the message text; otherwise, the
	// link preview will be shown below the message text
	ShowAboveText bool `json:"show_above_text,omitempty"`
}

LinkPreviewOptions - Describes the options used for link preview generation.

type Location 

type Location struct {
	// Latitude - Latitude as defined by the sender
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude as defined by the sender
	Longitude float64 `json:"longitude"`

	// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// LivePeriod - Optional. Time relative to the message sending date, during which the location can be
	// updated; in seconds. For active live locations only.
	LivePeriod int `json:"live_period,omitempty"`

	// Heading - Optional. The direction in which user is moving, in degrees; 1-360. For active live locations
	// only.
	Heading int `json:"heading,omitempty"`

	// ProximityAlertRadius - Optional. The maximum distance for proximity alerts about approaching another chat
	// member, in meters. For sent live locations only.
	ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
}

Location - This object represents a point on the map.

type LocationAddress added in v1.1.0 

type LocationAddress struct {
	// CountryCode - The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
	CountryCode string `json:"country_code"`

	// State - Optional. State of the location
	State string `json:"state,omitempty"`

	// City - Optional. City of the location
	City string `json:"city,omitempty"`

	// Street - Optional. Street address of the location
	Street string `json:"street,omitempty"`
}

LocationAddress - Describes the physical address of a location.

type Logger 

type Logger interface {
	Debugf(format string, args ...any)
	Errorf(format string, args ...any)
}

Logger represents logger used to debug or error information

type LoginURL 

type LoginURL struct {
	// URL - An HTTPS URL to be opened with user authorization data added to the query string when the button is
	// pressed. If the user refuses to provide authorization data, the original URL without information about the
	// user will be opened. The data added is the same as described in Receiving authorization data
	// (https://core.telegram.org/widgets/login#receiving-authorization-data).
	// NOTE: You must always check the hash of the received data to verify the authentication and the integrity of
	// the data as described in Checking authorization
	// (https://core.telegram.org/widgets/login#checking-authorization).
	URL string `json:"url"`

	// ForwardText - Optional. New text of the button in forwarded messages.
	ForwardText string `json:"forward_text,omitempty"`

	// BotUsername - Optional. Username of a bot, which will be used for user authorization. See Setting up a
	// bot (https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the
	// current bot's username will be assumed. The URL's domain must be the same as the domain linked with the bot.
	// See Linking your domain to the bot (https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot)
	// for more details.
	BotUsername string `json:"bot_username,omitempty"`

	// RequestWriteAccess - Optional. Pass True to request the permission for your bot to send messages to the
	// user.
	RequestWriteAccess bool `json:"request_write_access,omitempty"`
}

LoginURL - This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget (https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in: TITLE (https://core.telegram.org/file/811140015/1734/8VZFkwWXalM.97872/6127fa62d8a0bf2b3c) Telegram apps support these buttons as of version 5.7 (https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). Sample bot: @discussbot (https://t.me/discussbot)

type LongPollingOption added in v0.19.0 

type LongPollingOption func(lp *longPolling) error

LongPollingOption represents an option that can be applied to long polling

func WithLongPollingBuffer added in v0.19.0 

func WithLongPollingBuffer(chanBuffer uint) LongPollingOption

WithLongPollingBuffer sets buffering for update chan. Default is 100.

func WithLongPollingRetryTimeout added in v0.19.0 

func WithLongPollingRetryTimeout(retryTimeout time.Duration) LongPollingOption

WithLongPollingRetryTimeout sets updates retry timeout for long polling. Ensure that between two calls of Bot.GetUpdates method will be at least specified time if an error occurred, but it could be longer. If zero is passed, reties will be disabled and on error update chan will be closed. Default is 8s.

func WithLongPollingUpdateInterval added in v0.19.0 

func WithLongPollingUpdateInterval(updateInterval time.Duration) LongPollingOption

WithLongPollingUpdateInterval sets an update interval for long polling. Ensure that between two calls of Bot.GetUpdates method will be at least specified time, but it could be longer. Default is 0s. Note: Telegram has built in a timeout mechanism, to properly use it, set [GetUpdatesParams.Timeout] to desired timeout and update interval to 0 (default, recommended way).

type MaskPosition 

type MaskPosition struct {
	// Point - The part of the face relative to which the mask should be placed. One of “forehead”,
	// “eyes”, “mouth”, or “chin”.
	Point string `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 float64 `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 float64 `json:"y_shift"`

	// Scale - Mask scaling coefficient. For example, 2.0 means double size.
	Scale float64 `json:"scale"`
}

MaskPosition - This object describes the position on faces where a mask should be placed by default.

type MaybeInaccessibleMessage added in v0.29.0 

type MaybeInaccessibleMessage interface {
	// IsAccessible returns true if message accessible for bot
	IsAccessible() bool
	// Message returns [Message] if message accessible for bot, otherwise returns nil
	Message() *Message
	// InaccessibleMessage returns [InaccessibleMessage] if message not accessible for bot, otherwise returns nil
	InaccessibleMessage() *InaccessibleMessage

	// GetChat returns message chat
	GetChat() Chat
	// GetMessageID returns message ID
	GetMessageID() int
	// GetDate returns message date
	GetDate() int64
	// contains filtered or unexported methods
}

MaybeInaccessibleMessage - This object describes a message that can be inaccessible to the bot. It can be one of Message (https://core.telegram.org/bots/api#message) InaccessibleMessage (https://core.telegram.org/bots/api#inaccessiblemessage) 

type MenuButton interface {
	// ButtonType returns MenuButton type
	ButtonType() string
	// contains filtered or unexported methods
}

MenuButton - This object describes the bot's menu button in a private chat. It should be one of MenuButtonCommands (https://core.telegram.org/bots/api#menubuttoncommands) MenuButtonWebApp (https://core.telegram.org/bots/api#menubuttonwebapp) MenuButtonDefault (https://core.telegram.org/bots/api#menubuttondefault) If a menu button other than MenuButtonDefault (https://core.telegram.org/bots/api#menubuttondefault) is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands. 

type MenuButtonCommands struct {
	// Type - Type of the button, must be commands
	Type string `json:"type"`
}

MenuButtonCommands - Represents a menu button, which opens the bot's list of commands. 

func (m *MenuButtonCommands) ButtonType() string

ButtonType returns MenuButton type 

type MenuButtonDefault struct {
	// Type - Type of the button, must be default
	Type string `json:"type"`
}

MenuButtonDefault - Describes that no specific value for the menu button was set. 

func (m *MenuButtonDefault) ButtonType() string

ButtonType returns MenuButton type 

type MenuButtonWebApp struct {
	// Type - Type of the button, must be web_app
	Type string `json:"type"`

	// Text - Text on the button
	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
	// (https://core.telegram.org/bots/api#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"`
}

MenuButtonWebApp - Represents a menu button, which launches a Web App (https://core.telegram.org/bots/webapps). 

func (m *MenuButtonWebApp) ButtonType() string

ButtonType returns MenuButton type 

func (m *MenuButtonWebApp) WithText(text string) *MenuButtonWebApp

WithText adds text parameter 

func (m *MenuButtonWebApp) WithWebApp(webApp WebAppInfo) *MenuButtonWebApp

WithWebApp adds web app parameter

type Message 

type Message struct {
	// MessageID - Unique message identifier inside this chat. In specific instances (e.g., message containing a
	// video sent to a big chat), the server might automatically schedule a message instead of sending it
	// immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is
	// actually sent
	MessageID int `json:"message_id"`

	// MessageThreadID - Optional. Unique identifier of a message thread or forum topic to which the message
	// belongs; for supergroups and private chats only
	MessageThreadID int `json:"message_thread_id,omitempty"`

	// DirectMessagesTopic - Optional. Information about the direct messages chat topic that contains the
	// message
	DirectMessagesTopic *DirectMessagesTopic `json:"direct_messages_topic,omitempty"`

	// From - Optional. Sender of the message; may be empty for messages sent to channels. For backward
	// compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in
	// non-channel chats
	From *User `json:"from,omitempty"`

	// SenderChat - Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup
	// itself for messages sent by its anonymous administrators or a linked channel for messages automatically
	// forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of
	// a chat, the field from contains a fake sender user in non-channel chats.
	SenderChat *Chat `json:"sender_chat,omitempty"`

	// SenderBoostCount - Optional. If the sender of the message boosted the chat, the number of boosts added by
	// the user
	SenderBoostCount int `json:"sender_boost_count,omitempty"`

	// SenderBusinessBot - Optional. The bot that actually sent the message on behalf of the business account.
	// Available only for outgoing messages sent on behalf of the connected business account.
	SenderBusinessBot *User `json:"sender_business_bot,omitempty"`

	// Date - Date the message was sent in Unix time. It is always a positive number, representing a valid date.
	Date int64 `json:"date"`

	// BusinessConnectionID - Optional. Unique identifier of the business connection from which the message was
	// received. If non-empty, the message belongs to a chat of the corresponding business account that is
	// independent from any potential bot chat which might share the same identifier.
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// Chat - Chat the message belongs to
	Chat Chat `json:"chat"`

	// ForwardOrigin - Optional. Information about the original message for forwarded messages
	ForwardOrigin MessageOrigin `json:"forward_origin,omitempty"`

	// IsTopicMessage - Optional. True, if the message is sent to a topic in a forum supergroup or a private
	// chat with the bot
	IsTopicMessage bool `json:"is_topic_message,omitempty"`

	// IsAutomaticForward - Optional. True, if the message is a channel post that was automatically forwarded to
	// the connected discussion group
	IsAutomaticForward bool `json:"is_automatic_forward,omitempty"`

	// ReplyToMessage - Optional. For replies in the same chat and message thread, the original message. Note
	// that the Message (https://core.telegram.org/bots/api#message) object in this field will not contain further
	// reply_to_message fields even if it itself is a reply.
	ReplyToMessage *Message `json:"reply_to_message,omitempty"`

	// ExternalReply - Optional. Information about the message that is being replied to, which may come from
	// another chat or forum topic
	ExternalReply *ExternalReplyInfo `json:"external_reply,omitempty"`

	// Quote - Optional. For replies that quote part of the original message, the quoted part of the message
	Quote *TextQuote `json:"quote,omitempty"`

	// ReplyToStory - Optional. For replies to a story, the original story
	ReplyToStory *Story `json:"reply_to_story,omitempty"`

	// ReplyToChecklistTaskID - Optional. Identifier of the specific checklist task that is being replied to
	ReplyToChecklistTaskID int `json:"reply_to_checklist_task_id,omitempty"`

	// ViaBot - Optional. Bot through which the message was sent
	ViaBot *User `json:"via_bot,omitempty"`

	// EditDate - Optional. Date the message was last edited in Unix time
	EditDate int64 `json:"edit_date,omitempty"`

	// HasProtectedContent - Optional. True, if the message can't be forwarded
	HasProtectedContent bool `json:"has_protected_content,omitempty"`

	// IsFromOffline - Optional. True, if the message was sent by an implicit action, for example, as an away or
	// a greeting business message, or as a scheduled message
	IsFromOffline bool `json:"is_from_offline,omitempty"`

	// IsPaidPost - Optional. True, if the message is a paid post. Note that such posts must not be deleted for
	// 24 hours to receive the payment and can't be edited.
	IsPaidPost bool `json:"is_paid_post,omitempty"`

	// MediaGroupID - Optional. The unique identifier of a media message group this message belongs to
	MediaGroupID string `json:"media_group_id,omitempty"`

	// AuthorSignature - Optional. Signature of the post author for messages in channels, or the custom title of
	// an anonymous group administrator
	AuthorSignature string `json:"author_signature,omitempty"`

	// PaidStarCount - Optional. The number of Telegram Stars that were paid by the sender of the message to
	// send it
	PaidStarCount int `json:"paid_star_count,omitempty"`

	// Text - Optional. For text messages, the actual UTF-8 text of the message
	Text string `json:"text,omitempty"`

	// Entities - Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that
	// appear in the text
	Entities []MessageEntity `json:"entities,omitempty"`

	// LinkPreviewOptions - Optional. Options used for link preview generation for the message, if it is a text
	// message and link preview options were changed
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// SuggestedPostInfo - Optional. Information about suggested post parameters if the message is a suggested
	// post in a channel direct messages chat. If the message is an approved or declined suggested post, then it
	// can't be edited.
	SuggestedPostInfo *SuggestedPostInfo `json:"suggested_post_info,omitempty"`

	// EffectID - Optional. Unique identifier of the message effect added to the message
	EffectID string `json:"effect_id,omitempty"`

	// Animation - Optional. Message is an animation, information about the animation. For backward
	// compatibility, when this field is set, the document field will also be set
	Animation *Animation `json:"animation,omitempty"`

	// Audio - Optional. Message is an audio file, information about the file
	Audio *Audio `json:"audio,omitempty"`

	// Document - Optional. Message is a general file, information about the file
	Document *Document `json:"document,omitempty"`

	// PaidMedia - Optional. Message contains paid media; information about the paid media
	PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`

	// Photo - Optional. Message is a photo, available sizes of the photo
	Photo []PhotoSize `json:"photo,omitempty"`

	// Sticker - Optional. Message is a sticker, information about the sticker
	Sticker *Sticker `json:"sticker,omitempty"`

	// Story - Optional. Message is a forwarded story
	Story *Story `json:"story,omitempty"`

	// Video - Optional. Message is a video, information about the video
	Video *Video `json:"video,omitempty"`

	// VideoNote - Optional. Message is a video note (https://telegram.org/blog/video-messages-and-telescope),
	// information about the video message
	VideoNote *VideoNote `json:"video_note,omitempty"`

	// Voice - Optional. Message is a voice message, information about the file
	Voice *Voice `json:"voice,omitempty"`

	// Caption - Optional. Caption for the animation, audio, document, paid media, photo, video or voice
	Caption string `json:"caption,omitempty"`

	// CaptionEntities - Optional. For messages with a caption, special entities like usernames, URLs, bot
	// commands, etc. that appear in the caption
	CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`

	// ShowCaptionAboveMedia - Optional. True, if the caption must be shown above the message media
	ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`

	// HasMediaSpoiler - Optional. True, if the message media is covered by a spoiler animation
	HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"`

	// Checklist - Optional. Message is a checklist
	Checklist *Checklist `json:"checklist,omitempty"`

	// Contact - Optional. Message is a shared contact, information about the contact
	Contact *Contact `json:"contact,omitempty"`

	// Dice - Optional. Message is a dice with random value
	Dice *Dice `json:"dice,omitempty"`

	// Game - Optional. Message is a game, information about the game. More about games »
	// (https://core.telegram.org/bots/api#games)
	Game *Game `json:"game,omitempty"`

	// Poll - Optional. Message is a native poll, information about the poll
	Poll *Poll `json:"poll,omitempty"`

	// Venue - Optional. Message is a venue, information about the venue. For backward compatibility, when this
	// field is set, the location field will also be set
	Venue *Venue `json:"venue,omitempty"`

	// Location - Optional. Message is a shared location, information about the location
	Location *Location `json:"location,omitempty"`

	// NewChatMembers - Optional. New members that were added to the group or supergroup and information about
	// them (the bot itself may be one of these members)
	NewChatMembers []User `json:"new_chat_members,omitempty"`

	// LeftChatMember - Optional. A member was removed from the group, information about them (this member may
	// be the bot itself)
	LeftChatMember *User `json:"left_chat_member,omitempty"`

	// NewChatTitle - Optional. A chat title was changed to this value
	NewChatTitle string `json:"new_chat_title,omitempty"`

	// NewChatPhoto - Optional. A chat photo was change to this value
	NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"`

	// DeleteChatPhoto - Optional. Service message: the chat photo was deleted
	DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"`

	// GroupChatCreated - Optional. Service message: the group has been created
	GroupChatCreated bool `json:"group_chat_created,omitempty"`

	// SupergroupChatCreated - Optional. Service message: the supergroup has been created. This field can't be
	// received in a message coming through updates, because bot can't be a member of a supergroup when it is
	// created. It can only be found in reply_to_message if someone replies to a very first message in a directly
	// created supergroup.
	SupergroupChatCreated bool `json:"supergroup_chat_created,omitempty"`

	// ChannelChatCreated - Optional. Service message: the channel has been created. This field can't be
	// received in a message coming through updates, because bot can't be a member of a channel when it is created.
	// It can only be found in reply_to_message if someone replies to a very first message in a channel.
	ChannelChatCreated bool `json:"channel_chat_created,omitempty"`

	// MessageAutoDeleteTimerChanged - Optional. Service message: auto-delete timer settings changed in the chat
	MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`

	// 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"`

	// MigrateFromChatID - Optional. The supergroup has been migrated from a group 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.
	MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"`

	// PinnedMessage - Optional. Specified message was pinned. Note that the Message
	// (https://core.telegram.org/bots/api#message) object in this field will not contain further reply_to_message
	// fields even if it itself is a reply.
	PinnedMessage MaybeInaccessibleMessage `json:"pinned_message,omitempty"`

	// Invoice - Optional. Message is an invoice for a payment (https://core.telegram.org/bots/api#payments),
	// information about the invoice. More about payments » (https://core.telegram.org/bots/api#payments)
	Invoice *Invoice `json:"invoice,omitempty"`

	// SuccessfulPayment - Optional. Message is a service message about a successful payment, information about
	// the payment. More about payments » (https://core.telegram.org/bots/api#payments)
	SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`

	// RefundedPayment - Optional. Message is a service message about a refunded payment, information about the
	// payment. More about payments » (https://core.telegram.org/bots/api#payments)
	RefundedPayment *RefundedPayment `json:"refunded_payment,omitempty"`

	// UsersShared - Optional. Service message: users were shared with the bot
	UsersShared *UsersShared `json:"users_shared,omitempty"`

	// ChatShared - Optional. Service message: a chat was shared with the bot
	ChatShared *ChatShared `json:"chat_shared,omitempty"`

	// Gift - Optional. Service message: a regular gift was sent or received
	Gift *GiftInfo `json:"gift,omitempty"`

	// UniqueGift - Optional. Service message: a unique gift was sent or received
	UniqueGift *UniqueGiftInfo `json:"unique_gift,omitempty"`

	// GiftUpgradeSent - Optional. Service message: upgrade of a gift was purchased after the gift was sent
	GiftUpgradeSent *GiftInfo `json:"gift_upgrade_sent,omitempty"`

	// ConnectedWebsite - Optional. The domain name of the website on which the user has logged in. More about
	// Telegram Login » (https://core.telegram.org/widgets/login)
	ConnectedWebsite string `json:"connected_website,omitempty"`

	// WriteAccessAllowed - Optional. Service message: the user allowed the bot to write messages after adding
	// it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a
	// Web App sent by the method requestWriteAccess (https://core.telegram.org/bots/webapps#initializing-mini-apps)
	WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`

	// PassportData - Optional. Telegram Passport data
	PassportData *PassportData `json:"passport_data,omitempty"`

	// ProximityAlertTriggered - Optional. Service message. A user in the chat triggered another user's
	// proximity alert while sharing Live Location.
	ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`

	// BoostAdded - Optional. Service message: user boosted the chat
	BoostAdded *ChatBoostAdded `json:"boost_added,omitempty"`

	// ChatBackgroundSet - Optional. Service message: chat background set
	ChatBackgroundSet *ChatBackground `json:"chat_background_set,omitempty"`

	// ChecklistTasksDone - Optional. Service message: some tasks in a checklist were marked as done or not done
	ChecklistTasksDone *ChecklistTasksDone `json:"checklist_tasks_done,omitempty"`

	// ChecklistTasksAdded - Optional. Service message: tasks were added to a checklist
	ChecklistTasksAdded *ChecklistTasksAdded `json:"checklist_tasks_added,omitempty"`

	// DirectMessagePriceChanged - Optional. Service message: the price for paid messages in the corresponding
	// direct messages chat of a channel has changed
	DirectMessagePriceChanged *DirectMessagePriceChanged `json:"direct_message_price_changed,omitempty"`

	// ForumTopicCreated - Optional. Service message: forum topic created
	ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"`

	// ForumTopicEdited - Optional. Service message: forum topic edited
	ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"`

	// ForumTopicClosed - Optional. Service message: forum topic closed
	ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"`

	// ForumTopicReopened - Optional. Service message: forum topic reopened
	ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"`

	// GeneralForumTopicHidden - Optional. Service message: the 'General' forum topic hidden
	GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"`

	// GeneralForumTopicUnhidden - Optional. Service message: the 'General' forum topic unhidden
	GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"`

	// GiveawayCreated - Optional. Service message: a scheduled giveaway was created
	GiveawayCreated *GiveawayCreated `json:"giveaway_created,omitempty"`

	// Giveaway - Optional. The message is a scheduled giveaway message
	Giveaway *Giveaway `json:"giveaway,omitempty"`

	// GiveawayWinners - Optional. A giveaway with public winners was completed
	GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`

	// GiveawayCompleted - Optional. Service message: a giveaway without public winners was completed
	GiveawayCompleted *GiveawayCompleted `json:"giveaway_completed,omitempty"`

	// PaidMessagePriceChanged - Optional. Service message: the price for paid messages has changed in the chat
	PaidMessagePriceChanged *PaidMessagePriceChanged `json:"paid_message_price_changed,omitempty"`

	// SuggestedPostApproved - Optional. Service message: a suggested post was approved
	SuggestedPostApproved *SuggestedPostApproved `json:"suggested_post_approved,omitempty"`

	// SuggestedPostApprovalFailed - Optional. Service message: approval of a suggested post has failed
	SuggestedPostApprovalFailed *SuggestedPostApprovalFailed `json:"suggested_post_approval_failed,omitempty"`

	// SuggestedPostDeclined - Optional. Service message: a suggested post was declined
	SuggestedPostDeclined *SuggestedPostDeclined `json:"suggested_post_declined,omitempty"`

	// SuggestedPostPaid - Optional. Service message: payment for a suggested post was received
	SuggestedPostPaid *SuggestedPostPaid `json:"suggested_post_paid,omitempty"`

	// SuggestedPostRefunded - Optional. Service message: payment for a suggested post was refunded
	SuggestedPostRefunded *SuggestedPostRefunded `json:"suggested_post_refunded,omitempty"`

	// VideoChatScheduled - Optional. Service message: video chat scheduled
	VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`

	// VideoChatStarted - Optional. Service message: video chat started
	VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`

	// VideoChatEnded - Optional. Service message: video chat ended
	VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`

	// VideoChatParticipantsInvited - Optional. Service message: new participants invited to a video chat
	VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`

	// WebAppData - Optional. Service message: data sent by a Web App
	WebAppData *WebAppData `json:"web_app_data,omitempty"`

	// ReplyMarkup - Optional. Inline keyboard attached to the message. login_url buttons are represented as
	// ordinary URL buttons.
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

Message - This object represents a message.

func (*Message) GetChat added in v0.29.0 

func (m *Message) GetChat() Chat

GetChat returns message chat

func (*Message) GetDate added in v0.29.0 

func (m *Message) GetDate() int64

GetDate returns message date

func (*Message) GetMessageID added in v0.29.0 

func (m *Message) GetMessageID() int

GetMessageID returns message ID

func (*Message) InaccessibleMessage added in v1.1.0 

func (m *Message) InaccessibleMessage() *InaccessibleMessage

InaccessibleMessage returns InaccessibleMessage if message not accessible for bot, otherwise returns nil

func (*Message) IsAccessible added in v0.29.0 

func (m *Message) IsAccessible() bool

IsAccessible returns true if message accessible for bot

func (*Message) Message added in v1.1.0 

func (m *Message) Message() *Message

Message returns Message if message accessible for bot, otherwise returns nil

func (*Message) UnmarshalJSON added in v0.29.0 

func (m *Message) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to Message

type MessageAutoDeleteTimerChanged 

type MessageAutoDeleteTimerChanged struct {
	// MessageAutoDeleteTime - New auto-delete time for messages in the chat; in seconds
	MessageAutoDeleteTime int `json:"message_auto_delete_time"`
}

MessageAutoDeleteTimerChanged - This object represents a service message about a change in auto-delete timer settings.

type MessageEntity 

type MessageEntity struct {
	// Type - Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or
	// #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot),
	// “url” (https://telegram.org), “email” ([email protected]), “phone_number”
	// (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text),
	// “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block
	// quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth
	// string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for
	// users without usernames (https://telegram.org/blog/edit#new-mentions)), “custom_emoji” (for inline custom
	// emoji stickers)
	Type string `json:"type"`

	// Offset - Offset in UTF-16 code units (https://core.telegram.org/api/entities#entity-length) to the start
	// of the entity
	Offset int `json:"offset"`

	// Length - Length of the entity in UTF-16 code units (https://core.telegram.org/api/entities#entity-length)
	Length int `json:"length"`

	// URL - Optional. For “text_link” only, URL that will be opened after user taps on the text
	URL string `json:"url,omitempty"`

	// User - Optional. For “text_mention” only, the mentioned user
	User *User `json:"user,omitempty"`

	// Language - Optional. For “pre” only, the programming language of the entity text
	Language string `json:"language,omitempty"`

	// CustomEmojiID - Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use
	// getCustomEmojiStickers (https://core.telegram.org/bots/api#getcustomemojistickers) to get full information
	// about the sticker
	CustomEmojiID string `json:"custom_emoji_id,omitempty"`
}

MessageEntity - This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

type MessageID 

type MessageID struct {
	// MessageID - Unique message identifier. In specific instances (e.g., message containing a video sent to a
	// big chat), the server might automatically schedule a message instead of sending it immediately. In such
	// cases, this field will be 0 and the relevant message will be unusable until it is actually sent
	MessageID int `json:"message_id"`
}

MessageID - This object represents a unique message identifier.

type MessageOrigin added in v0.29.0 

type MessageOrigin interface {
	// OriginType returns original message type
	OriginType() string
	// OriginalDate returns original message date
	OriginalDate() int64
	// contains filtered or unexported methods
}

MessageOrigin - This object describes the origin of a message. It can be one of MessageOriginUser (https://core.telegram.org/bots/api#messageoriginuser) MessageOriginHiddenUser (https://core.telegram.org/bots/api#messageoriginhiddenuser) MessageOriginChat (https://core.telegram.org/bots/api#messageoriginchat) MessageOriginChannel (https://core.telegram.org/bots/api#messageoriginchannel)

type MessageOriginChannel added in v0.29.0 

type MessageOriginChannel struct {
	// Type - Type of the message origin, always “channel”
	Type string `json:"type"`

	// Date - Date the message was sent originally in Unix time
	Date int64 `json:"date"`

	// Chat - Channel chat to which the message was originally sent
	Chat Chat `json:"chat"`

	// MessageID - Unique message identifier inside the chat
	MessageID int `json:"message_id"`

	// AuthorSignature - Optional. Signature of the original post author
	AuthorSignature string `json:"author_signature,omitempty"`
}

MessageOriginChannel - The message was originally sent to a channel chat.

func (*MessageOriginChannel) OriginType added in v0.29.0 

func (m *MessageOriginChannel) OriginType() string

OriginType returns original message type

func (*MessageOriginChannel) OriginalDate added in v0.29.0 

func (m *MessageOriginChannel) OriginalDate() int64

OriginalDate returns original message date

type MessageOriginChat added in v0.29.0 

type MessageOriginChat struct {
	// Type - Type of the message origin, always “chat”
	Type string `json:"type"`

	// Date - Date the message was sent originally in Unix time
	Date int64 `json:"date"`

	// SenderChat - Chat that sent the message originally
	SenderChat Chat `json:"sender_chat"`

	// AuthorSignature - Optional. For messages originally sent by an anonymous chat administrator, original
	// message author signature
	AuthorSignature string `json:"author_signature,omitempty"`
}

MessageOriginChat - The message was originally sent on behalf of a chat to a group chat.

func (*MessageOriginChat) OriginType added in v0.29.0 

func (m *MessageOriginChat) OriginType() string

OriginType returns original message type

func (*MessageOriginChat) OriginalDate added in v0.29.0 

func (m *MessageOriginChat) OriginalDate() int64

OriginalDate returns original message date

type MessageOriginHiddenUser added in v0.29.0 

type MessageOriginHiddenUser struct {
	// Type - Type of the message origin, always “hidden_user”
	Type string `json:"type"`

	// Date - Date the message was sent originally in Unix time
	Date int64 `json:"date"`

	// SenderUserName - Name of the user that sent the message originally
	SenderUserName string `json:"sender_user_name"`
}

MessageOriginHiddenUser - The message was originally sent by an unknown user.

func (*MessageOriginHiddenUser) OriginType added in v0.29.0 

func (m *MessageOriginHiddenUser) OriginType() string

OriginType returns original message type

func (*MessageOriginHiddenUser) OriginalDate added in v0.29.0 

func (m *MessageOriginHiddenUser) OriginalDate() int64

OriginalDate returns original message date

type MessageOriginUser added in v0.29.0 

type MessageOriginUser struct {
	// Type - Type of the message origin, always “user”
	Type string `json:"type"`

	// Date - Date the message was sent originally in Unix time
	Date int64 `json:"date"`

	// SenderUser - User that sent the message originally
	SenderUser User `json:"sender_user"`
}

MessageOriginUser - The message was originally sent by a known user.

func (*MessageOriginUser) OriginType added in v0.29.0 

func (m *MessageOriginUser) OriginType() string

OriginType returns original message type

func (*MessageOriginUser) OriginalDate added in v0.29.0 

func (m *MessageOriginUser) OriginalDate() int64

OriginalDate returns original message date

type MessageReactionCountUpdated added in v0.29.0 

type MessageReactionCountUpdated struct {
	// Chat - The chat containing the message
	Chat Chat `json:"chat"`

	// MessageID - Unique message identifier inside the chat
	MessageID int `json:"message_id"`

	// Date - Date of the change in Unix time
	Date int64 `json:"date"`

	// Reactions - List of reactions that are present on the message
	Reactions []ReactionCount `json:"reactions"`
}

MessageReactionCountUpdated - This object represents reaction changes on a message with anonymous reactions.

type MessageReactionUpdated added in v0.29.0 

type MessageReactionUpdated struct {
	// Chat - The chat containing the message the user reacted to
	Chat Chat `json:"chat"`

	// MessageID - Unique identifier of the message inside the chat
	MessageID int `json:"message_id"`

	// User - Optional. The user that changed the reaction, if the user isn't anonymous
	User *User `json:"user,omitempty"`

	// ActorChat - Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
	ActorChat *Chat `json:"actor_chat,omitempty"`

	// Date - Date of the change in Unix time
	Date int64 `json:"date"`

	// OldReaction - Previous list of reaction types that were set by the user
	OldReaction []ReactionType `json:"old_reaction"`

	// NewReaction - New list of reaction types that have been set by the user
	NewReaction []ReactionType `json:"new_reaction"`
}

MessageReactionUpdated - This object represents a change of a reaction on a message performed by a user.

func (*MessageReactionUpdated) UnmarshalJSON added in v0.29.0 

func (u *MessageReactionUpdated) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to MessageReactionUpdated

type OrderInfo 

type OrderInfo struct {
	// Name - Optional. User name
	Name string `json:"name,omitempty"`

	// PhoneNumber - Optional. User's phone number
	PhoneNumber string `json:"phone_number,omitempty"`

	// Email - Optional. User email
	Email string `json:"email,omitempty"`

	// ShippingAddress - Optional. User shipping address
	ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
}

OrderInfo - This object represents information about an order.

type OwnedGift added in v1.1.0 

type OwnedGift interface {
	// GiftType returns OwnedGift type
	GiftType() string
	// contains filtered or unexported methods
}

OwnedGift - This object describes a gift received and owned by a user or a chat. Currently, it can be one of OwnedGiftRegular (https://core.telegram.org/bots/api#ownedgiftregular) OwnedGiftUnique (https://core.telegram.org/bots/api#ownedgiftunique)

type OwnedGiftRegular added in v1.1.0 

type OwnedGiftRegular struct {
	// Type - Type of the gift, always “regular”
	Type string `json:"type"`

	// Gift - Information about the regular gift
	Gift Gift `json:"gift"`

	// OwnedGiftID - Optional. Unique identifier of the gift for the bot; for gifts received on behalf of
	// business accounts only
	OwnedGiftID string `json:"owned_gift_id,omitempty"`

	// SenderUser - Optional. Sender of the gift if it is a known user
	SenderUser *User `json:"sender_user,omitempty"`

	// SendDate - Date the gift was sent in Unix time
	SendDate int64 `json:"send_date"`

	// Text - Optional. Text of the message that was added to the gift
	Text string `json:"text,omitempty"`

	// Entities - Optional. Special entities that appear in the text
	Entities []MessageEntity `json:"entities,omitempty"`

	// IsPrivate - Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise,
	// everyone will be able to see them
	IsPrivate bool `json:"is_private,omitempty"`

	// IsSaved - Optional. True, if the gift is displayed on the account's profile page; for gifts received on
	// behalf of business accounts only
	IsSaved bool `json:"is_saved,omitempty"`

	// CanBeUpgraded - Optional. True, if the gift can be upgraded to a unique gift; for gifts received on
	// behalf of business accounts only
	CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`

	// WasRefunded - Optional. True, if the gift was refunded and isn't available anymore
	WasRefunded bool `json:"was_refunded,omitempty"`

	// ConvertStarCount - Optional. Number of Telegram Stars that can be claimed by the receiver instead of the
	// gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business
	// accounts only
	ConvertStarCount int `json:"convert_star_count,omitempty"`

	// PrepaidUpgradeStarCount - Optional. Number of Telegram Stars that were paid for the ability to upgrade
	// the gift
	PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`

	// IsUpgradeSeparate - Optional. True, if the gift's upgrade was purchased after the gift was sent; for
	// gifts received on behalf of business accounts only
	IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`

	// UniqueGiftNumber - Optional. Unique number reserved for this gift when upgraded. See the number field in
	// UniqueGift (https://core.telegram.org/bots/api#uniquegift)
	UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
}

OwnedGiftRegular - Describes a regular gift owned by a user or a chat.

func (*OwnedGiftRegular) GiftType added in v1.1.0 

func (g *OwnedGiftRegular) GiftType() string

GiftType returns OwnedGift type

type OwnedGiftUnique added in v1.1.0 

type OwnedGiftUnique struct {
	// Type - Type of the gift, always “unique”
	Type string `json:"type"`

	// Gift - Information about the unique gift
	Gift UniqueGift `json:"gift"`

	// OwnedGiftID - Optional. Unique identifier of the received gift for the bot; for gifts received on behalf
	// of business accounts only
	OwnedGiftID string `json:"owned_gift_id,omitempty"`

	// SenderUser - Optional. Sender of the gift if it is a known user
	SenderUser *User `json:"sender_user,omitempty"`

	// SendDate - Date the gift was sent in Unix time
	SendDate int64 `json:"send_date"`

	// IsSaved - Optional. True, if the gift is displayed on the account's profile page; for gifts received on
	// behalf of business accounts only
	IsSaved bool `json:"is_saved,omitempty"`

	// CanBeTransferred - Optional. True, if the gift can be transferred to another owner; for gifts received on
	// behalf of business accounts only
	CanBeTransferred bool `json:"can_be_transferred,omitempty"`

	// TransferStarCount - Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if
	// the bot cannot transfer the gift
	TransferStarCount int `json:"transfer_star_count,omitempty"`

	// NextTransferDate - Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in
	// the past, then the gift can be transferred now
	NextTransferDate int64 `json:"next_transfer_date,omitempty"`
}

OwnedGiftUnique - Describes a unique gift received and owned by a user or a chat.

func (*OwnedGiftUnique) GiftType added in v1.1.0 

func (g *OwnedGiftUnique) GiftType() string

GiftType returns OwnedGift type

type OwnedGifts added in v1.1.0 

type OwnedGifts struct {
	// TotalCount - The total number of gifts owned by the user or the chat
	TotalCount int `json:"total_count"`

	// Gifts - The list of gifts
	Gifts []OwnedGift `json:"gifts"`

	// NextOffset - Optional. Offset for the next request. If empty, then there are no more results
	NextOffset string `json:"next_offset,omitempty"`
}

OwnedGifts - Contains the list of gifts received and owned by a user or a chat.

func (*OwnedGifts) UnmarshalJSON added in v1.1.1 

func (g *OwnedGifts) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to OwnedGifts

type PaidMedia added in v0.31.0 

type PaidMedia interface {
	// MediaType returns PaidMedia type
	MediaType() string
	// contains filtered or unexported methods
}

PaidMedia - This object describes paid media. Currently, it can be one of PaidMediaPreview (https://core.telegram.org/bots/api#paidmediapreview) PaidMediaPhoto (https://core.telegram.org/bots/api#paidmediaphoto) PaidMediaVideo (https://core.telegram.org/bots/api#paidmediavideo)

WARNING: Telegram introduced undocumented type "other", it will be correctly parsed by Telego, but will not be exposed to users directly as it's not documented anywhere, but still used by Telegram

type PaidMediaInfo added in v0.31.0 

type PaidMediaInfo struct {
	// 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"`
}

PaidMediaInfo - Describes the paid media added to a message.

func (*PaidMediaInfo) UnmarshalJSON added in v0.31.0 

func (m *PaidMediaInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to PaidMediaInfo

type PaidMediaPhoto added in v0.31.0 

type PaidMediaPhoto struct {
	// Type - Type of the paid media, always “photo”
	Type string `json:"type"`

	// Photo - The photo
	Photo []PhotoSize `json:"photo"`
}

PaidMediaPhoto - The paid media is a photo.

func (*PaidMediaPhoto) MediaType added in v0.31.0 

func (m *PaidMediaPhoto) MediaType() string

MediaType returns PaidMedia type

type PaidMediaPreview added in v0.31.0 

type PaidMediaPreview struct {
	// Type - Type of the paid media, always “preview”
	Type string `json:"type"`

	// 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"`
}

PaidMediaPreview - The paid media isn't available before the payment.

func (*PaidMediaPreview) MediaType added in v0.31.0 

func (m *PaidMediaPreview) MediaType() string

MediaType returns PaidMedia type

type PaidMediaPurchased added in v0.31.3 

type PaidMediaPurchased struct {
	// From - User who purchased the media
	From User `json:"from"`

	// PaidMediaPayload - Bot-specified paid media payload
	PaidMediaPayload string `json:"paid_media_payload"`
}

PaidMediaPurchased - This object contains information about a paid media purchase.

type PaidMediaVideo added in v0.31.0 

type PaidMediaVideo struct {
	// Type - Type of the paid media, always “video”
	Type string `json:"type"`

	// Video - The video
	Video Video `json:"video"`
}

PaidMediaVideo - The paid media is a video.

func (*PaidMediaVideo) MediaType added in v0.31.0 

func (m *PaidMediaVideo) MediaType() string

MediaType returns PaidMedia type

type PaidMessagePriceChanged added in v1.1.0 

type PaidMessagePriceChanged struct {
	// PaidMessageStarCount - The new number of Telegram Stars that must be paid by non-administrator users of
	// the supergroup chat for each sent message
	PaidMessageStarCount int `json:"paid_message_star_count"`
}

PaidMessagePriceChanged - Describes a service message about a change in the price of paid messages within a chat.

type PassportData 

type PassportData struct {
	// 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"`
}

PassportData - Describes Telegram Passport data shared with the bot by the user.

type PassportElementError 

type PassportElementError interface {
	// ErrorSource returns PassportElementError source
	ErrorSource() string
	// contains filtered or unexported methods
}

PassportElementError - This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of: PassportElementErrorDataField (https://core.telegram.org/bots/api#passportelementerrordatafield) PassportElementErrorFrontSide (https://core.telegram.org/bots/api#passportelementerrorfrontside) PassportElementErrorReverseSide (https://core.telegram.org/bots/api#passportelementerrorreverseside) PassportElementErrorSelfie (https://core.telegram.org/bots/api#passportelementerrorselfie) PassportElementErrorFile (https://core.telegram.org/bots/api#passportelementerrorfile) PassportElementErrorFiles (https://core.telegram.org/bots/api#passportelementerrorfiles) PassportElementErrorTranslationFile (https://core.telegram.org/bots/api#passportelementerrortranslationfile) PassportElementErrorTranslationFiles (https://core.telegram.org/bots/api#passportelementerrortranslationfiles) PassportElementErrorUnspecified (https://core.telegram.org/bots/api#passportelementerrorunspecified)

type PassportElementErrorDataField 

type PassportElementErrorDataField struct {
	// Source - Error source, must be data
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the error, one of “personal_details”,
	// “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”
	Type string `json:"type"`

	// FieldName - Name of the data field which has the error
	FieldName string `json:"field_name"`

	// DataHash - Base64-encoded data hash
	DataHash string `json:"data_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorDataField - Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

func (*PassportElementErrorDataField) ErrorSource 

func (p *PassportElementErrorDataField) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorFile 

type PassportElementErrorFile struct {
	// Source - Error source, must be file
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the issue, one of “utility_bill”,
	// “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
	Type string `json:"type"`

	// FileHash - Base64-encoded file hash
	FileHash string `json:"file_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorFile - Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

func (*PassportElementErrorFile) ErrorSource 

func (p *PassportElementErrorFile) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorFiles 

type PassportElementErrorFiles struct {
	// Source - Error source, must be files
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the issue, one of “utility_bill”,
	// “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
	Type string `json:"type"`

	// FileHashes - List of base64-encoded file hashes
	FileHashes []string `json:"file_hashes"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorFiles - Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

func (*PassportElementErrorFiles) ErrorSource 

func (p *PassportElementErrorFiles) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorFrontSide 

type PassportElementErrorFrontSide struct {
	// Source - Error source, must be front_side
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the issue, one of “passport”,
	// “driver_license”, “identity_card”, “internal_passport”
	Type string `json:"type"`

	// FileHash - Base64-encoded hash of the file with the front side of the document
	FileHash string `json:"file_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorFrontSide - Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

func (*PassportElementErrorFrontSide) ErrorSource 

func (p *PassportElementErrorFrontSide) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorReverseSide 

type PassportElementErrorReverseSide struct {
	// Source - Error source, must be reverse_side
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the issue, one of “driver_license”,
	// “identity_card”
	Type string `json:"type"`

	// FileHash - Base64-encoded hash of the file with the reverse side of the document
	FileHash string `json:"file_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorReverseSide - Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

func (*PassportElementErrorReverseSide) ErrorSource 

func (p *PassportElementErrorReverseSide) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorSelfie 

type PassportElementErrorSelfie struct {
	// Source - Error source, must be selfie
	Source string `json:"source"`

	// Type - The section of the user's Telegram Passport which has the issue, one of “passport”,
	// “driver_license”, “identity_card”, “internal_passport”
	Type string `json:"type"`

	// FileHash - Base64-encoded hash of the file with the selfie
	FileHash string `json:"file_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorSelfie - Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

func (*PassportElementErrorSelfie) ErrorSource 

func (p *PassportElementErrorSelfie) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorTranslationFile 

type PassportElementErrorTranslationFile struct {
	// Source - Error source, must be translation_file
	Source string `json:"source"`

	// Type - Type of element of the user's Telegram Passport which has the issue, one of “passport”,
	// “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”,
	// “rental_agreement”, “passport_registration”, “temporary_registration”
	Type string `json:"type"`

	// FileHash - Base64-encoded file hash
	FileHash string `json:"file_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorTranslationFile - Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

func (*PassportElementErrorTranslationFile) ErrorSource 

func (p *PassportElementErrorTranslationFile) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorTranslationFiles 

type PassportElementErrorTranslationFiles struct {
	// Source - Error source, must be translation_files
	Source string `json:"source"`

	// Type - Type of element of the user's Telegram Passport which has the issue, one of “passport”,
	// “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”,
	// “rental_agreement”, “passport_registration”, “temporary_registration”
	Type string `json:"type"`

	// FileHashes - List of base64-encoded file hashes
	FileHashes []string `json:"file_hashes"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorTranslationFiles - Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

func (*PassportElementErrorTranslationFiles) ErrorSource 

func (p *PassportElementErrorTranslationFiles) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportElementErrorUnspecified 

type PassportElementErrorUnspecified struct {
	// Source - Error source, must be unspecified
	Source string `json:"source"`

	// Type - Type of element of the user's Telegram Passport which has the issue
	Type string `json:"type"`

	// ElementHash - Base64-encoded element hash
	ElementHash string `json:"element_hash"`

	// Message - Error message
	Message string `json:"message"`
}

PassportElementErrorUnspecified - Represents an issue in an unspecified place. The error is considered resolved when new data is added.

func (*PassportElementErrorUnspecified) ErrorSource 

func (p *PassportElementErrorUnspecified) ErrorSource() string

ErrorSource returns PassportElementError source

type PassportFile 

type PassportFile struct {
	// 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 - File size in bytes
	FileSize int `json:"file_size"`

	// FileDate - Unix time when the file was uploaded
	FileDate int64 `json:"file_date"`
}

PassportFile - This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

type PhotoSize 

type PhotoSize struct {
	// 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 - Photo width
	Width int `json:"width"`

	// Height - Photo height
	Height int `json:"height"`

	// FileSize - Optional. File size in bytes
	FileSize int `json:"file_size,omitempty"`
}

PhotoSize - This object represents one size of a photo or a file (https://core.telegram.org/bots/api#document) / sticker (https://core.telegram.org/bots/api#sticker) thumbnail.

type PinChatMessageParams 

type PinChatMessageParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message will be pinned
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageID - Identifier of a message to pin
	MessageID int `json:"message_id"`

	// DisableNotification - Optional. Pass True if it is not necessary to send a notification to all chat
	// members about the new pinned message. Notifications are always disabled in channels and private chats.
	DisableNotification bool `json:"disable_notification,omitempty"`
}

PinChatMessageParams - Represents parameters of pinChatMessage method.

func (*PinChatMessageParams) WithBusinessConnectionID added in v0.31.1 

func (p *PinChatMessageParams) WithBusinessConnectionID(businessConnectionID string) *PinChatMessageParams

WithBusinessConnectionID adds business connection ID parameter

func (*PinChatMessageParams) WithChatID added in v0.10.0 

func (p *PinChatMessageParams) WithChatID(chatID ChatID) *PinChatMessageParams

WithChatID adds chat ID parameter

func (*PinChatMessageParams) WithDisableNotification added in v0.10.0 

func (p *PinChatMessageParams) WithDisableNotification() *PinChatMessageParams

WithDisableNotification adds disable notification parameter

func (*PinChatMessageParams) WithMessageID added in v0.10.0 

func (p *PinChatMessageParams) WithMessageID(messageID int) *PinChatMessageParams

WithMessageID adds message ID parameter

type Poll 

type Poll struct {
	// 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,omitempty"`

	// 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"`

	// IsAnonymous - True, if the poll is anonymous
	IsAnonymous bool `json:"is_anonymous"`

	// Type - Poll type, currently can be “regular” or “quiz”
	Type string `json:"type"`

	// AllowsMultipleAnswers - True, if the poll allows multiple answers
	AllowsMultipleAnswers bool `json:"allows_multiple_answers"`

	// CorrectOptionID - Optional. 0-based identifier of the correct answer option. Available only for polls in
	// the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
	CorrectOptionID int `json:"correct_option_id,omitempty"`

	// Explanation - Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp
	// icon in a quiz-style poll, 0-200 characters
	Explanation string `json:"explanation,omitempty"`

	// ExplanationEntities - Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
	// the explanation
	ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`

	// OpenPeriod - Optional. Amount of time in seconds the poll will be active after creation
	OpenPeriod int `json:"open_period,omitempty"`

	// CloseDate - Optional. Point in time (Unix timestamp) when the poll will be automatically closed
	CloseDate int64 `json:"close_date,omitempty"`
}

Poll - This object contains information about a poll.

type PollAnswer 

type PollAnswer struct {
	// PollID - Unique poll identifier
	PollID string `json:"poll_id"`

	// VoterChat - Optional. The chat that changed the answer to the poll, if the voter is anonymous
	VoterChat *Chat `json:"voter_chat,omitempty"`

	// User - Optional. The user that changed the answer to the poll, if the voter isn't anonymous
	User *User `json:"user,omitempty"`

	// OptionIDs - 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
	OptionIDs []int `json:"option_ids"`
}

PollAnswer - This object represents an answer of a user in a non-anonymous poll.

type PollOption 

type PollOption struct {
	// 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,omitempty"`

	// VoterCount - Number of users that voted for this option
	VoterCount int `json:"voter_count"`
}

PollOption - This object contains information about one answer option in a poll.

type PostStoryParams added in v1.1.0 

type PostStoryParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Content - Content of the story
	Content InputStoryContent `json:"content"`

	// ActivePeriod - 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 - 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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 - Optional. A JSON-serialized list of clickable areas to be shown on the story
	Areas []StoryArea `json:"areas,omitempty"`

	// 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"`
}

PostStoryParams - Represents parameters of postStory method.

func (*PostStoryParams) WithActivePeriod added in v1.1.0 

func (p *PostStoryParams) WithActivePeriod(activePeriod int) *PostStoryParams

WithActivePeriod adds active period parameter

func (*PostStoryParams) WithAreas added in v1.1.0 

func (p *PostStoryParams) WithAreas(areas ...StoryArea) *PostStoryParams

WithAreas adds areas parameter

func (*PostStoryParams) WithBusinessConnectionID added in v1.1.0 

func (p *PostStoryParams) WithBusinessConnectionID(businessConnectionID string) *PostStoryParams

WithBusinessConnectionID adds business connection ID parameter

func (*PostStoryParams) WithCaption added in v1.1.0 

func (p *PostStoryParams) WithCaption(caption string) *PostStoryParams

WithCaption adds caption parameter

func (*PostStoryParams) WithCaptionEntities added in v1.1.0 

func (p *PostStoryParams) WithCaptionEntities(captionEntities ...MessageEntity) *PostStoryParams

WithCaptionEntities adds caption entities parameter

func (*PostStoryParams) WithContent added in v1.1.0 

func (p *PostStoryParams) WithContent(content InputStoryContent) *PostStoryParams

WithContent adds content parameter

func (*PostStoryParams) WithParseMode added in v1.1.0 

func (p *PostStoryParams) WithParseMode(parseMode string) *PostStoryParams

WithParseMode adds parse mode parameter

func (*PostStoryParams) WithPostToChatPage added in v1.1.0 

func (p *PostStoryParams) WithPostToChatPage() *PostStoryParams

WithPostToChatPage adds post to chat page parameter

func (*PostStoryParams) WithProtectContent added in v1.1.0 

func (p *PostStoryParams) WithProtectContent() *PostStoryParams

WithProtectContent adds protect content parameter

type PreCheckoutQuery 

type PreCheckoutQuery struct {
	// ID - Unique query identifier
	ID string `json:"id"`

	// From - User who sent the query
	From User `json:"from"`

	// Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies)
	// code, or “XTR” for payments in Telegram Stars (https://t.me/BotNews/90)
	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
	// (https://core.telegram.org/bots/payments/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,omitempty"`

	// OrderInfo - Optional. Order information provided by the user
	OrderInfo *OrderInfo `json:"order_info,omitempty"`
}

PreCheckoutQuery - This object contains information about an incoming pre-checkout query.

type PreparedInlineMessage added in v0.32.0 

type PreparedInlineMessage struct {
	// 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 int64 `json:"expiration_date"`
}

PreparedInlineMessage - Describes an inline message to be sent by a user of a Mini App.

type PromoteChatMemberParams 

type PromoteChatMemberParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// IsAnonymous - Optional. Pass True if the administrator's presence in the chat is hidden
	IsAnonymous *bool `json:"is_anonymous,omitempty"`

	// CanManageChat - Optional. Pass True if the administrator can access the chat event log, get boost list,
	// see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the
	// chat without paying Telegram Stars. Implied by any other administrator privilege.
	CanManageChat *bool `json:"can_manage_chat,omitempty"`

	// CanDeleteMessages - Optional. Pass True if the administrator can delete messages of other users
	CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`

	// CanManageVideoChats - Optional. Pass True if the administrator can manage video chats
	CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`

	// CanRestrictMembers - Optional. Pass True if the administrator can restrict, ban or unban chat members, or
	// access supergroup statistics. For backward compatibility, defaults to True for promotions of channel
	// administrators
	CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`

	// CanPromoteMembers - Optional. Pass True if the administrator can add new administrators with a subset of
	// their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by
	// administrators that were appointed by him)
	CanPromoteMembers *bool `json:"can_promote_members,omitempty"`

	// CanChangeInfo - Optional. Pass True if the administrator can change chat title, photo and other settings
	CanChangeInfo *bool `json:"can_change_info,omitempty"`

	// CanInviteUsers - Optional. Pass True if the administrator can invite new users to the chat
	CanInviteUsers *bool `json:"can_invite_users,omitempty"`

	// CanPostStories - Optional. Pass True if the administrator can post stories to the chat
	CanPostStories *bool `json:"can_post_stories,omitempty"`

	// CanEditStories - Optional. Pass True if the administrator can edit stories posted by other users, post
	// stories to the chat page, pin chat stories, and access the chat's story archive
	CanEditStories *bool `json:"can_edit_stories,omitempty"`

	// CanDeleteStories - Optional. Pass True if the administrator can delete stories posted by other users
	CanDeleteStories *bool `json:"can_delete_stories,omitempty"`

	// CanPostMessages - Optional. Pass True if the administrator can post messages in the channel, approve
	// suggested posts, or access channel statistics; for channels only
	CanPostMessages *bool `json:"can_post_messages,omitempty"`

	// CanEditMessages - Optional. Pass True if the administrator can edit messages of other users and can pin
	// messages; for channels only
	CanEditMessages *bool `json:"can_edit_messages,omitempty"`

	// CanPinMessages - Optional. Pass True if the administrator can pin messages; for supergroups only
	CanPinMessages *bool `json:"can_pin_messages,omitempty"`

	// CanManageTopics - Optional. Pass True if the user is allowed to create, rename, close, and reopen forum
	// topics; for supergroups only
	CanManageTopics *bool `json:"can_manage_topics,omitempty"`

	// CanManageDirectMessages - Optional. Pass True if the administrator can manage direct messages within the
	// channel and decline suggested posts; for channels only
	CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
}

PromoteChatMemberParams - Represents parameters of promoteChatMember method.

func (*PromoteChatMemberParams) WithCanChangeInfo added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanChangeInfo(canChangeInfo bool) *PromoteChatMemberParams

WithCanChangeInfo adds can change info parameter

func (*PromoteChatMemberParams) WithCanDeleteMessages added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanDeleteMessages(canDeleteMessages bool) *PromoteChatMemberParams

WithCanDeleteMessages adds can delete messages parameter

func (*PromoteChatMemberParams) WithCanDeleteStories added in v0.26.3 

func (p *PromoteChatMemberParams) WithCanDeleteStories(canDeleteStories bool) *PromoteChatMemberParams

WithCanDeleteStories adds can delete stories parameter

func (*PromoteChatMemberParams) WithCanEditMessages added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanEditMessages(canEditMessages bool) *PromoteChatMemberParams

WithCanEditMessages adds can edit messages parameter

func (*PromoteChatMemberParams) WithCanEditStories added in v0.26.3 

func (p *PromoteChatMemberParams) WithCanEditStories(canEditStories bool) *PromoteChatMemberParams

WithCanEditStories adds can edit stories parameter

func (*PromoteChatMemberParams) WithCanInviteUsers added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanInviteUsers(canInviteUsers bool) *PromoteChatMemberParams

WithCanInviteUsers adds can invite users parameter

func (*PromoteChatMemberParams) WithCanManageChat added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanManageChat(canManageChat bool) *PromoteChatMemberParams

WithCanManageChat adds can manage chat parameter

func (*PromoteChatMemberParams) WithCanManageDirectMessages added in v1.3.0 

func (p *PromoteChatMemberParams) WithCanManageDirectMessages(canManageDirectMessages bool) *PromoteChatMemberParams

WithCanManageDirectMessages adds can manage direct messages parameter

func (*PromoteChatMemberParams) WithCanManageTopics added in v0.17.1 

func (p *PromoteChatMemberParams) WithCanManageTopics(canManageTopics bool) *PromoteChatMemberParams

WithCanManageTopics adds can manage topics parameter

func (*PromoteChatMemberParams) WithCanManageVideoChats added in v0.11.0 

func (p *PromoteChatMemberParams) WithCanManageVideoChats(canManageVideoChats bool) *PromoteChatMemberParams

WithCanManageVideoChats adds can manage video chats parameter

func (*PromoteChatMemberParams) WithCanPinMessages added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanPinMessages(canPinMessages bool) *PromoteChatMemberParams

WithCanPinMessages adds can pin messages parameter

func (*PromoteChatMemberParams) WithCanPostMessages added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanPostMessages(canPostMessages bool) *PromoteChatMemberParams

WithCanPostMessages adds can post messages parameter

func (*PromoteChatMemberParams) WithCanPostStories added in v0.26.3 

func (p *PromoteChatMemberParams) WithCanPostStories(canPostStories bool) *PromoteChatMemberParams

WithCanPostStories adds can post stories parameter

func (*PromoteChatMemberParams) WithCanPromoteMembers added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanPromoteMembers(canPromoteMembers bool) *PromoteChatMemberParams

WithCanPromoteMembers adds can promote members parameter

func (*PromoteChatMemberParams) WithCanRestrictMembers added in v0.10.0 

func (p *PromoteChatMemberParams) WithCanRestrictMembers(canRestrictMembers bool) *PromoteChatMemberParams

WithCanRestrictMembers adds can restrict members parameter

func (*PromoteChatMemberParams) WithChatID added in v0.10.0 

func (p *PromoteChatMemberParams) WithChatID(chatID ChatID) *PromoteChatMemberParams

WithChatID adds chat ID parameter

func (*PromoteChatMemberParams) WithIsAnonymous added in v0.10.0 

func (p *PromoteChatMemberParams) WithIsAnonymous(isAnonymous bool) *PromoteChatMemberParams

WithIsAnonymous adds is anonymous parameter

func (*PromoteChatMemberParams) WithUserID added in v1.1.0 

func (p *PromoteChatMemberParams) WithUserID(userID int64) *PromoteChatMemberParams

WithUserID adds user ID parameter

type ProximityAlertTriggered 

type ProximityAlertTriggered struct {
	// Traveler - User that triggered the alert
	Traveler User `json:"traveler"`

	// Watcher - User that set the alert
	Watcher User `json:"watcher"`

	// Distance - The distance between the users
	Distance int `json:"distance"`
}

ProximityAlertTriggered - This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

type ReactionCount added in v0.29.0 

type ReactionCount struct {
	// Type - Type of the reaction
	Type ReactionType `json:"type"`

	// TotalCount - Number of times the reaction was added
	TotalCount int `json:"total_count"`
}

ReactionCount - Represents a reaction added to a message along with the number of times it was added.

func (*ReactionCount) UnmarshalJSON added in v0.29.0 

func (c *ReactionCount) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to ReactionCount

type ReactionType added in v0.29.0 

type ReactionType interface {
	// ReactionType returns reaction type
	ReactionType() string
	// contains filtered or unexported methods
}

ReactionType - This object describes the type of a reaction. Currently, it can be one of ReactionTypeEmoji (https://core.telegram.org/bots/api#reactiontypeemoji) ReactionTypeCustomEmoji (https://core.telegram.org/bots/api#reactiontypecustomemoji) ReactionTypePaid (https://core.telegram.org/bots/api#reactiontypepaid)

type ReactionTypeCustomEmoji added in v0.29.0 

type ReactionTypeCustomEmoji struct {
	// Type - Type of the reaction, always “custom_emoji”
	Type string `json:"type"`

	// CustomEmojiID - Custom emoji identifier
	CustomEmojiID string `json:"custom_emoji_id"`
}

ReactionTypeCustomEmoji - The reaction is based on a custom emoji.

func (*ReactionTypeCustomEmoji) ReactionType added in v0.29.0 

func (r *ReactionTypeCustomEmoji) ReactionType() string

ReactionType returns reaction type

type ReactionTypeEmoji added in v0.29.0 

type ReactionTypeEmoji struct {
	// Type - Type of the reaction, always “emoji”
	Type string `json:"type"`

	// Emoji - Reaction emoji. Currently, it can be one of "❤", "👍", "👎", "🔥", "🥰", "👏",
	// "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊",
	// "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆",
	// "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻",
	// "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃",
	// "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂",
	// "🤷", "🤷‍♀", "😡"
	Emoji string `json:"emoji"`
}

ReactionTypeEmoji - The reaction is based on an emoji.

func (*ReactionTypeEmoji) ReactionType added in v0.29.0 

func (r *ReactionTypeEmoji) ReactionType() string

ReactionType returns reaction type

type ReactionTypePaid added in v0.31.2 

type ReactionTypePaid struct {
	// Type - Type of the reaction, always “paid”
	Type string `json:"type"`
}

ReactionTypePaid - The reaction is paid.

func (*ReactionTypePaid) ReactionType added in v0.31.2 

func (r *ReactionTypePaid) ReactionType() string

ReactionType returns reaction type

type ReadBusinessMessageParams added in v1.1.0 

type ReadBusinessMessageParams struct {
	// BusinessConnectionID - Unique identifier of the business connection on behalf of which to read the
	// message
	BusinessConnectionID string `json:"business_connection_id"`

	// ChatID - 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 - Unique identifier of the message to mark as read
	MessageID int `json:"message_id"`
}

ReadBusinessMessageParams - Represents parameters of readBusinessMessage method.

func (*ReadBusinessMessageParams) WithBusinessConnectionID added in v1.1.0 

func (p *ReadBusinessMessageParams) WithBusinessConnectionID(businessConnectionID string) *ReadBusinessMessageParams

WithBusinessConnectionID adds business connection ID parameter

func (*ReadBusinessMessageParams) WithChatID added in v1.1.0 

func (p *ReadBusinessMessageParams) WithChatID(chatID int64) *ReadBusinessMessageParams

WithChatID adds chat ID parameter

func (*ReadBusinessMessageParams) WithMessageID added in v1.1.0 

func (p *ReadBusinessMessageParams) WithMessageID(messageID int) *ReadBusinessMessageParams

WithMessageID adds message ID parameter

type RefundStarPaymentParams added in v0.30.2 

type RefundStarPaymentParams struct {
	// UserID - Identifier of the user whose payment will be refunded
	UserID int64 `json:"user_id"`

	// TelegramPaymentChargeID - Telegram payment identifier
	TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
}

RefundStarPaymentParams - Represents parameters of refundStarPayment method.

func (*RefundStarPaymentParams) WithTelegramPaymentChargeID added in v0.30.2 

func (p *RefundStarPaymentParams) WithTelegramPaymentChargeID(telegramPaymentChargeID string) *RefundStarPaymentParams

WithTelegramPaymentChargeID adds telegram payment charge ID parameter

func (*RefundStarPaymentParams) WithUserID added in v1.1.0 

func (p *RefundStarPaymentParams) WithUserID(userID int64) *RefundStarPaymentParams

WithUserID adds user ID parameter

type RefundedPayment added in v0.31.0 

type RefundedPayment struct {
	// Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies)
	// code, or “XTR” for payments in Telegram Stars (https://t.me/BotNews/90). 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
	// (https://core.telegram.org/bots/payments/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 - Optional. Provider payment identifier
	ProviderPaymentChargeID string `json:"provider_payment_charge_id,omitempty"`
}

RefundedPayment - This object contains basic information about a refunded payment.

type RemoveBusinessAccountProfilePhotoParams added in v1.1.0 

type RemoveBusinessAccountProfilePhotoParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// IsPublic - Optional. Pass True to remove the public photo, which is visible even if the main photo is
	// hidden by the business account's privacy settings. After the main photo is removed, the previous profile
	// photo (if present) becomes the main photo.
	IsPublic bool `json:"is_public,omitempty"`
}

RemoveBusinessAccountProfilePhotoParams - Represents parameters of removeBusinessAccountProfilePhoto method.

func (*RemoveBusinessAccountProfilePhotoParams) WithBusinessConnectionID added in v1.1.0 

func (p *RemoveBusinessAccountProfilePhotoParams) WithBusinessConnectionID(businessConnectionID string,
) *RemoveBusinessAccountProfilePhotoParams

WithBusinessConnectionID adds business connection ID parameter

func (*RemoveBusinessAccountProfilePhotoParams) WithIsPublic added in v1.1.0 

func (p *RemoveBusinessAccountProfilePhotoParams) WithIsPublic() *RemoveBusinessAccountProfilePhotoParams

WithIsPublic adds is public parameter

type RemoveChatVerificationParams added in v0.32.0 

type RemoveChatVerificationParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`
}

RemoveChatVerificationParams - Represents parameters of removeChatVerification method.

func (*RemoveChatVerificationParams) WithChatID added in v0.32.0 

func (p *RemoveChatVerificationParams) WithChatID(chatID ChatID) *RemoveChatVerificationParams

WithChatID adds chat ID parameter

type RemoveUserVerificationParams added in v0.32.0 

type RemoveUserVerificationParams struct {
	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`
}

RemoveUserVerificationParams - Represents parameters of removeUserVerification method.

func (*RemoveUserVerificationParams) WithUserID added in v1.1.0 

func (p *RemoveUserVerificationParams) WithUserID(userID int64) *RemoveUserVerificationParams

WithUserID adds user ID parameter

type ReopenForumTopicParams added in v0.17.1 

type ReopenForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Unique identifier for the target message thread of the forum topic
	MessageThreadID int `json:"message_thread_id"`
}

ReopenForumTopicParams - Represents parameters of reopenForumTopic method.

func (*ReopenForumTopicParams) WithChatID added in v0.17.1 

func (p *ReopenForumTopicParams) WithChatID(chatID ChatID) *ReopenForumTopicParams

WithChatID adds chat ID parameter

func (*ReopenForumTopicParams) WithMessageThreadID added in v0.17.1 

func (p *ReopenForumTopicParams) WithMessageThreadID(messageThreadID int) *ReopenForumTopicParams

WithMessageThreadID adds message thread ID parameter

type ReopenGeneralForumTopicParams added in v0.18.1 

type ReopenGeneralForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

ReopenGeneralForumTopicParams - Represents parameters of reopenGeneralForumTopic method.

func (*ReopenGeneralForumTopicParams) WithChatID added in v0.18.1 

func (p *ReopenGeneralForumTopicParams) WithChatID(chatID ChatID) *ReopenGeneralForumTopicParams

WithChatID adds chat ID parameter

type ReplaceStickerInSetParams added in v0.29.2 

type ReplaceStickerInSetParams struct {
	// UserID - User identifier of the sticker set owner
	UserID int64 `json:"user_id"`

	// Name - Sticker set name
	Name string `json:"name"`

	// OldSticker - File identifier of the replaced sticker
	OldSticker string `json:"old_sticker"`

	// Sticker - 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"`
}

ReplaceStickerInSetParams - Represents parameters of replaceStickerInSet method.

func (*ReplaceStickerInSetParams) WithName added in v0.29.2 

func (p *ReplaceStickerInSetParams) WithName(name string) *ReplaceStickerInSetParams

WithName adds name parameter

func (*ReplaceStickerInSetParams) WithOldSticker added in v0.29.2 

func (p *ReplaceStickerInSetParams) WithOldSticker(oldSticker string) *ReplaceStickerInSetParams

WithOldSticker adds old sticker parameter

func (*ReplaceStickerInSetParams) WithSticker added in v0.29.2 

func (p *ReplaceStickerInSetParams) WithSticker(sticker InputSticker) *ReplaceStickerInSetParams

WithSticker adds sticker parameter

func (*ReplaceStickerInSetParams) WithUserID added in v1.1.0 

func (p *ReplaceStickerInSetParams) WithUserID(userID int64) *ReplaceStickerInSetParams

WithUserID adds user ID parameter

type ReplyKeyboardMarkup 

type ReplyKeyboardMarkup struct {
	// Keyboard - Array of button rows, each represented by an Array of KeyboardButton
	// (https://core.telegram.org/bots/api#keyboardbutton) objects
	Keyboard [][]KeyboardButton `json:"keyboard"`

	// IsPersistent - Optional. Requests clients to always show the keyboard when the regular keyboard is
	// hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
	IsPersistent bool `json:"is_persistent,omitempty"`

	// ResizeKeyboard - Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make
	// the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom
	// keyboard is always of the same height as the app's standard keyboard.
	ResizeKeyboard bool `json:"resize_keyboard,omitempty"`

	// OneTimeKeyboard - Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard
	// will still be available, but clients will automatically display the usual letter-keyboard in the chat - the
	// user can press a special button in the input field to see the custom keyboard again. Defaults to false.
	OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"`

	// InputFieldPlaceholder - Optional. The placeholder to be shown in the input field when the keyboard is
	// active; 1-64 characters
	InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`

	// Selective - Optional. Use this parameter if you want to show the keyboard to specific users only.
	// Targets: 1) users that are @mentioned in the text of the Message (https://core.telegram.org/bots/api#message)
	// object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the
	// original message.
	// Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select
	// the new language. Other users in the group don't see the keyboard.
	Selective bool `json:"selective,omitempty"`
}

ReplyKeyboardMarkup - This object represents a custom keyboard (https://core.telegram.org/bots/features#keyboards) with reply options (see Introduction to bots (https://core.telegram.org/bots/features#keyboards) for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.

func (*ReplyKeyboardMarkup) ReplyType 

func (r *ReplyKeyboardMarkup) ReplyType() string

ReplyType returns ReplyKeyboardMarkup type

func (*ReplyKeyboardMarkup) WithInputFieldPlaceholder added in v0.10.0 

func (r *ReplyKeyboardMarkup) WithInputFieldPlaceholder(inputFieldPlaceholder string) *ReplyKeyboardMarkup

WithInputFieldPlaceholder adds input field placeholder parameter

func (*ReplyKeyboardMarkup) WithIsPersistent added in v0.18.1 

func (r *ReplyKeyboardMarkup) WithIsPersistent() *ReplyKeyboardMarkup

WithIsPersistent adds is persistent parameter

func (*ReplyKeyboardMarkup) WithKeyboard added in v0.10.0 

func (r *ReplyKeyboardMarkup) WithKeyboard(keyboard ...[]KeyboardButton) *ReplyKeyboardMarkup

WithKeyboard adds keyboard parameter

func (*ReplyKeyboardMarkup) WithOneTimeKeyboard added in v0.10.0 

func (r *ReplyKeyboardMarkup) WithOneTimeKeyboard() *ReplyKeyboardMarkup

WithOneTimeKeyboard adds one time keyboard parameter

func (*ReplyKeyboardMarkup) WithResizeKeyboard added in v0.10.0 

func (r *ReplyKeyboardMarkup) WithResizeKeyboard() *ReplyKeyboardMarkup

WithResizeKeyboard adds resize keyboard parameter

func (*ReplyKeyboardMarkup) WithSelective added in v0.10.0 

func (r *ReplyKeyboardMarkup) WithSelective() *ReplyKeyboardMarkup

WithSelective adds selective parameter

type ReplyKeyboardRemove 

type ReplyKeyboardRemove struct {
	// RemoveKeyboard - Requests clients to remove the custom keyboard (user will not be able to summon this
	// keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in
	// ReplyKeyboardMarkup (https://core.telegram.org/bots/api#replykeyboardmarkup))
	RemoveKeyboard bool `json:"remove_keyboard"`

	// Selective - Optional. Use this parameter if you want to remove the keyboard for specific users only.
	// Targets: 1) users that are @mentioned in the text of the Message (https://core.telegram.org/bots/api#message)
	// object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the
	// original message.
	// Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the
	// keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
	Selective bool `json:"selective,omitempty"`
}

ReplyKeyboardRemove - Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup (https://core.telegram.org/bots/api#replykeyboardmarkup)). Not supported in channels and for messages sent on behalf of a Telegram Business account.

func (*ReplyKeyboardRemove) ReplyType 

func (r *ReplyKeyboardRemove) ReplyType() string

ReplyType returns ReplyKeyboardRemove type

func (*ReplyKeyboardRemove) WithRemoveKeyboard added in v0.10.0 

func (r *ReplyKeyboardRemove) WithRemoveKeyboard() *ReplyKeyboardRemove

WithRemoveKeyboard adds remove keyboard parameter

func (*ReplyKeyboardRemove) WithSelective added in v0.10.0 

func (r *ReplyKeyboardRemove) WithSelective() *ReplyKeyboardRemove

WithSelective adds selective parameter

type ReplyMarkup 

type ReplyMarkup interface {
	// ReplyType returns type of reply
	ReplyType() string
	// contains filtered or unexported methods
}

ReplyMarkup - Represents reply markup (inline keyboard, custom reply keyboard, etc.)

type ReplyParameters added in v0.29.0 

type ReplyParameters struct {
	// MessageID - Identifier of the message that will be replied to in the current chat, or in the chat chat_id
	// if it is specified
	MessageID int `json:"message_id"`

	// ChatID - Optional. If the message to be replied to is from a different chat, unique identifier for the
	// chat or username of the channel (in the format @channel_username). Not supported for messages sent on behalf
	// of a business account and messages from channel direct messages chats.
	ChatID ChatID `json:"chat_id,omitzero"`

	// AllowSendingWithoutReply - Optional. Pass True if the message should be sent even if the specified
	// message to be replied to is not found. Always False for replies in another chat or forum topic. Always True
	// for messages sent on behalf of a business account.
	AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"`

	// Quote - Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing.
	// The quote must be an exact substring of the message to be replied to, including bold, italic, underline,
	// strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in
	// the original message.
	Quote string `json:"quote,omitempty"`

	// QuoteParseMode - Optional. Mode for parsing entities in the quote. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	QuoteParseMode string `json:"quote_parse_mode,omitempty"`

	// QuoteEntities - Optional. A JSON-serialized list of special entities that appear in the quote. It can be
	// specified instead of quote_parse_mode.
	QuoteEntities []MessageEntity `json:"quote_entities,omitempty"`

	// QuotePosition - Optional. Position of the quote in the original message in UTF-16 code units
	QuotePosition int `json:"quote_position,omitempty"`

	// ChecklistTaskID - Optional. Identifier of the specific checklist task to be replied to
	ChecklistTaskID int `json:"checklist_task_id,omitempty"`
}

ReplyParameters - Describes reply parameters for the message that is being sent.

func (*ReplyParameters) WithAllowSendingWithoutReply added in v0.29.0 

func (r *ReplyParameters) WithAllowSendingWithoutReply() *ReplyParameters

WithAllowSendingWithoutReply adds allow sending without reply parameter

func (*ReplyParameters) WithChatID added in v0.29.0 

func (r *ReplyParameters) WithChatID(chatID ChatID) *ReplyParameters

WithChatID adds chat ID parameter

func (*ReplyParameters) WithChecklistTaskID added in v1.3.0 

func (r *ReplyParameters) WithChecklistTaskID(checklistTaskID int) *ReplyParameters

WithChecklistTaskID adds checklist task ID parameter

func (*ReplyParameters) WithMessageID added in v0.29.0 

func (r *ReplyParameters) WithMessageID(messageID int) *ReplyParameters

WithMessageID adds message ID parameter

func (*ReplyParameters) WithQuote added in v0.29.0 

func (r *ReplyParameters) WithQuote(quote string) *ReplyParameters

WithQuote adds quote parameter

func (*ReplyParameters) WithQuoteEntities added in v0.29.0 

func (r *ReplyParameters) WithQuoteEntities(quoteEntities ...MessageEntity) *ReplyParameters

WithQuoteEntities adds quote entities parameter

func (*ReplyParameters) WithQuoteParseMode added in v0.29.0 

func (r *ReplyParameters) WithQuoteParseMode(quoteParseMode string) *ReplyParameters

WithQuoteParseMode adds quote parse mode parameter

func (*ReplyParameters) WithQuotePosition added in v0.29.0 

func (r *ReplyParameters) WithQuotePosition(quotePosition int) *ReplyParameters

WithQuotePosition adds quote position parameter

type RepostStoryParams added in v1.4.0 

type RepostStoryParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// FromChatID - Unique identifier of the chat which posted the story that should be reposted
	FromChatID int `json:"from_chat_id"`

	// FromStoryID - Unique identifier of the story that should be reposted
	FromStoryID int `json:"from_story_id"`

	// ActivePeriod - 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"`
}

RepostStoryParams - Represents parameters of repostStory method.

func (*RepostStoryParams) WithActivePeriod added in v1.4.0 

func (p *RepostStoryParams) WithActivePeriod(activePeriod int) *RepostStoryParams

WithActivePeriod adds active period parameter

func (*RepostStoryParams) WithBusinessConnectionID added in v1.4.0 

func (p *RepostStoryParams) WithBusinessConnectionID(businessConnectionID string) *RepostStoryParams

WithBusinessConnectionID adds business connection ID parameter

func (*RepostStoryParams) WithFromChatID added in v1.4.0 

func (p *RepostStoryParams) WithFromChatID(fromChatID int) *RepostStoryParams

WithFromChatID adds from chat ID parameter

func (*RepostStoryParams) WithFromStoryID added in v1.4.0 

func (p *RepostStoryParams) WithFromStoryID(fromStoryID int) *RepostStoryParams

WithFromStoryID adds from story ID parameter

func (*RepostStoryParams) WithPostToChatPage added in v1.4.0 

func (p *RepostStoryParams) WithPostToChatPage() *RepostStoryParams

WithPostToChatPage adds post to chat page parameter

func (*RepostStoryParams) WithProtectContent added in v1.4.0 

func (p *RepostStoryParams) WithProtectContent() *RepostStoryParams

WithProtectContent adds protect content parameter

type RestrictChatMemberParams 

type RestrictChatMemberParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// Permissions - A JSON-serialized object for new user permissions
	Permissions ChatPermissions `json:"permissions"`

	// UseIndependentChatPermissions - Optional. Pass True if chat permissions are set independently. Otherwise,
	// the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
	// can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
	// can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
	UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`

	// UntilDate - Optional. Date when restrictions will be lifted for the user; Unix time. If user is
	// restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be
	// restricted forever
	UntilDate int64 `json:"until_date,omitempty"`
}

RestrictChatMemberParams - Represents parameters of restrictChatMember method.

func (*RestrictChatMemberParams) WithChatID added in v0.10.0 

func (p *RestrictChatMemberParams) WithChatID(chatID ChatID) *RestrictChatMemberParams

WithChatID adds chat ID parameter

func (*RestrictChatMemberParams) WithPermissions added in v0.10.0 

func (p *RestrictChatMemberParams) WithPermissions(permissions ChatPermissions) *RestrictChatMemberParams

WithPermissions adds permissions parameter

func (*RestrictChatMemberParams) WithUntilDate added in v1.1.0 

func (p *RestrictChatMemberParams) WithUntilDate(untilDate int64) *RestrictChatMemberParams

WithUntilDate adds until date parameter

func (*RestrictChatMemberParams) WithUseIndependentChatPermissions added in v0.20.1 

func (p *RestrictChatMemberParams) WithUseIndependentChatPermissions() *RestrictChatMemberParams

WithUseIndependentChatPermissions adds use independent chat permissions parameter

func (*RestrictChatMemberParams) WithUserID added in v1.1.0 

func (p *RestrictChatMemberParams) WithUserID(userID int64) *RestrictChatMemberParams

WithUserID adds user ID parameter

type RevenueWithdrawalState added in v0.31.0 

type RevenueWithdrawalState interface {
	// WithdrawalState returns RevenueWithdrawalState type
	WithdrawalState() string
	// contains filtered or unexported methods
}

RevenueWithdrawalState - This object describes the state of a revenue withdrawal operation. Currently, it can be one of RevenueWithdrawalStatePending (https://core.telegram.org/bots/api#revenuewithdrawalstatepending) RevenueWithdrawalStateSucceeded (https://core.telegram.org/bots/api#revenuewithdrawalstatesucceeded) RevenueWithdrawalStateFailed (https://core.telegram.org/bots/api#revenuewithdrawalstatefailed)

type RevenueWithdrawalStateFailed added in v0.31.0 

type RevenueWithdrawalStateFailed struct {
	// Type - Type of the state, always “failed”
	Type string `json:"type"`
}

RevenueWithdrawalStateFailed - The withdrawal failed and the transaction was refunded.

func (*RevenueWithdrawalStateFailed) WithdrawalState added in v0.31.0 

func (r *RevenueWithdrawalStateFailed) WithdrawalState() string

WithdrawalState returns RevenueWithdrawalState type

type RevenueWithdrawalStatePending added in v0.31.0 

type RevenueWithdrawalStatePending struct {
	// Type - Type of the state, always “pending”
	Type string `json:"type"`
}

RevenueWithdrawalStatePending - The withdrawal is in progress.

func (*RevenueWithdrawalStatePending) WithdrawalState added in v0.31.0 

func (r *RevenueWithdrawalStatePending) WithdrawalState() string

WithdrawalState returns RevenueWithdrawalState type

type RevenueWithdrawalStateSucceeded added in v0.31.0 

type RevenueWithdrawalStateSucceeded struct {
	// Type - Type of the state, always “succeeded”
	Type string `json:"type"`

	// Date - Date the withdrawal was completed in Unix time
	Date int64 `json:"date"`

	// URL - An HTTPS URL that can be used to see transaction details
	URL string `json:"url"`
}

RevenueWithdrawalStateSucceeded - The withdrawal succeeded.

func (*RevenueWithdrawalStateSucceeded) WithdrawalState added in v0.31.0 

func (r *RevenueWithdrawalStateSucceeded) WithdrawalState() string

WithdrawalState returns RevenueWithdrawalState type

type RevokeChatInviteLinkParams 

type RevokeChatInviteLinkParams struct {
	// ChatID - Unique identifier of the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// InviteLink - The invite link to revoke
	InviteLink string `json:"invite_link"`
}

RevokeChatInviteLinkParams - Represents parameters of revokeChatInviteLink method.

func (*RevokeChatInviteLinkParams) WithChatID added in v0.10.0 

func (p *RevokeChatInviteLinkParams) WithChatID(chatID ChatID) *RevokeChatInviteLinkParams

WithChatID adds chat ID parameter 

func (p *RevokeChatInviteLinkParams) WithInviteLink(inviteLink string) *RevokeChatInviteLinkParams

WithInviteLink adds invite link parameter

type SavePreparedInlineMessageParams added in v0.32.0 

type SavePreparedInlineMessageParams struct {
	// UserID - Unique identifier of the target user that can use the prepared message
	UserID int64 `json:"user_id"`

	// Result - 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"`
}

SavePreparedInlineMessageParams - Represents parameters of savePreparedInlineMessage method.

func (*SavePreparedInlineMessageParams) WithAllowBotChats added in v0.32.0 

func (p *SavePreparedInlineMessageParams) WithAllowBotChats() *SavePreparedInlineMessageParams

WithAllowBotChats adds allow bot chats parameter

func (*SavePreparedInlineMessageParams) WithAllowChannelChats added in v0.32.0 

func (p *SavePreparedInlineMessageParams) WithAllowChannelChats() *SavePreparedInlineMessageParams

WithAllowChannelChats adds allow channel chats parameter

func (*SavePreparedInlineMessageParams) WithAllowGroupChats added in v0.32.0 

func (p *SavePreparedInlineMessageParams) WithAllowGroupChats() *SavePreparedInlineMessageParams

WithAllowGroupChats adds allow group chats parameter

func (*SavePreparedInlineMessageParams) WithAllowUserChats added in v0.32.0 

func (p *SavePreparedInlineMessageParams) WithAllowUserChats() *SavePreparedInlineMessageParams

WithAllowUserChats adds allow user chats parameter

func (*SavePreparedInlineMessageParams) WithResult added in v0.32.0 

func (p *SavePreparedInlineMessageParams) WithResult(result InlineQueryResult) *SavePreparedInlineMessageParams

WithResult adds result parameter

func (*SavePreparedInlineMessageParams) WithUserID added in v1.1.0 

func (p *SavePreparedInlineMessageParams) WithUserID(userID int64) *SavePreparedInlineMessageParams

WithUserID adds user ID parameter

type SendAnimationParams 

type SendAnimationParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Animation - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Animation InputFile `json:"animation"`

	// 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"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendAnimationParams - Represents parameters of sendAnimation method.

func (*SendAnimationParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendAnimationParams) WithAllowPaidBroadcast() *SendAnimationParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendAnimationParams) WithAnimation added in v0.10.0 

func (p *SendAnimationParams) WithAnimation(animation InputFile) *SendAnimationParams

WithAnimation adds animation parameter

func (*SendAnimationParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendAnimationParams) WithBusinessConnectionID(businessConnectionID string) *SendAnimationParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendAnimationParams) WithCaption added in v0.10.0 

func (p *SendAnimationParams) WithCaption(caption string) *SendAnimationParams

WithCaption adds caption parameter

func (*SendAnimationParams) WithCaptionEntities added in v0.10.0 

func (p *SendAnimationParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendAnimationParams

WithCaptionEntities adds caption entities parameter

func (*SendAnimationParams) WithChatID added in v0.10.0 

func (p *SendAnimationParams) WithChatID(chatID ChatID) *SendAnimationParams

WithChatID adds chat ID parameter

func (*SendAnimationParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendAnimationParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendAnimationParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendAnimationParams) WithDisableNotification added in v0.10.0 

func (p *SendAnimationParams) WithDisableNotification() *SendAnimationParams

WithDisableNotification adds disable notification parameter

func (*SendAnimationParams) WithDuration added in v0.10.0 

func (p *SendAnimationParams) WithDuration(duration int) *SendAnimationParams

WithDuration adds duration parameter

func (*SendAnimationParams) WithHasSpoiler added in v0.18.1 

func (p *SendAnimationParams) WithHasSpoiler() *SendAnimationParams

WithHasSpoiler adds has spoiler parameter

func (*SendAnimationParams) WithHeight added in v0.10.0 

func (p *SendAnimationParams) WithHeight(height int) *SendAnimationParams

WithHeight adds height parameter

func (*SendAnimationParams) WithMessageEffectID added in v0.30.2 

func (p *SendAnimationParams) WithMessageEffectID(messageEffectID string) *SendAnimationParams

WithMessageEffectID adds message effect ID parameter

func (*SendAnimationParams) WithMessageThreadID added in v0.17.1 

func (p *SendAnimationParams) WithMessageThreadID(messageThreadID int) *SendAnimationParams

WithMessageThreadID adds message thread ID parameter

func (*SendAnimationParams) WithParseMode added in v0.10.0 

func (p *SendAnimationParams) WithParseMode(parseMode string) *SendAnimationParams

WithParseMode adds parse mode parameter

func (*SendAnimationParams) WithProtectContent added in v0.10.0 

func (p *SendAnimationParams) WithProtectContent() *SendAnimationParams

WithProtectContent adds protect content parameter

func (*SendAnimationParams) WithReplyMarkup added in v0.10.0 

func (p *SendAnimationParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendAnimationParams

WithReplyMarkup adds reply markup parameter

func (*SendAnimationParams) WithReplyParameters added in v0.29.0 

func (p *SendAnimationParams) WithReplyParameters(replyParameters *ReplyParameters) *SendAnimationParams

WithReplyParameters adds reply parameters parameter

func (*SendAnimationParams) WithShowCaptionAboveMedia added in v0.30.2 

func (p *SendAnimationParams) WithShowCaptionAboveMedia() *SendAnimationParams

WithShowCaptionAboveMedia adds show caption above media parameter

func (*SendAnimationParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendAnimationParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendAnimationParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendAnimationParams) WithThumbnail added in v0.22.0 

func (p *SendAnimationParams) WithThumbnail(thumbnail *InputFile) *SendAnimationParams

WithThumbnail adds thumbnail parameter

func (*SendAnimationParams) WithWidth added in v0.10.0 

func (p *SendAnimationParams) WithWidth(width int) *SendAnimationParams

WithWidth adds width parameter

type SendAudioParams 

type SendAudioParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Audio InputFile `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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendAudioParams - Represents parameters of sendAudio method.

func (*SendAudioParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendAudioParams) WithAllowPaidBroadcast() *SendAudioParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendAudioParams) WithAudio added in v0.10.0 

func (p *SendAudioParams) WithAudio(audio InputFile) *SendAudioParams

WithAudio adds audio parameter

func (*SendAudioParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendAudioParams) WithBusinessConnectionID(businessConnectionID string) *SendAudioParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendAudioParams) WithCaption added in v0.10.0 

func (p *SendAudioParams) WithCaption(caption string) *SendAudioParams

WithCaption adds caption parameter

func (*SendAudioParams) WithCaptionEntities added in v0.10.0 

func (p *SendAudioParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendAudioParams

WithCaptionEntities adds caption entities parameter

func (*SendAudioParams) WithChatID added in v0.10.0 

func (p *SendAudioParams) WithChatID(chatID ChatID) *SendAudioParams

WithChatID adds chat ID parameter

func (*SendAudioParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendAudioParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendAudioParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendAudioParams) WithDisableNotification added in v0.10.0 

func (p *SendAudioParams) WithDisableNotification() *SendAudioParams

WithDisableNotification adds disable notification parameter

func (*SendAudioParams) WithDuration added in v0.10.0 

func (p *SendAudioParams) WithDuration(duration int) *SendAudioParams

WithDuration adds duration parameter

func (*SendAudioParams) WithMessageEffectID added in v0.30.2 

func (p *SendAudioParams) WithMessageEffectID(messageEffectID string) *SendAudioParams

WithMessageEffectID adds message effect ID parameter

func (*SendAudioParams) WithMessageThreadID added in v0.17.1 

func (p *SendAudioParams) WithMessageThreadID(messageThreadID int) *SendAudioParams

WithMessageThreadID adds message thread ID parameter

func (*SendAudioParams) WithParseMode added in v0.10.0 

func (p *SendAudioParams) WithParseMode(parseMode string) *SendAudioParams

WithParseMode adds parse mode parameter

func (*SendAudioParams) WithPerformer added in v0.10.0 

func (p *SendAudioParams) WithPerformer(performer string) *SendAudioParams

WithPerformer adds performer parameter

func (*SendAudioParams) WithProtectContent added in v0.10.0 

func (p *SendAudioParams) WithProtectContent() *SendAudioParams

WithProtectContent adds protect content parameter

func (*SendAudioParams) WithReplyMarkup added in v0.10.0 

func (p *SendAudioParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendAudioParams

WithReplyMarkup adds reply markup parameter

func (*SendAudioParams) WithReplyParameters added in v0.29.0 

func (p *SendAudioParams) WithReplyParameters(replyParameters *ReplyParameters) *SendAudioParams

WithReplyParameters adds reply parameters parameter

func (*SendAudioParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendAudioParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendAudioParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendAudioParams) WithThumbnail added in v0.22.0 

func (p *SendAudioParams) WithThumbnail(thumbnail *InputFile) *SendAudioParams

WithThumbnail adds thumbnail parameter

func (*SendAudioParams) WithTitle added in v0.10.0 

func (p *SendAudioParams) WithTitle(title string) *SendAudioParams

WithTitle adds title parameter

type SendChatActionParams 

type SendChatActionParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// action will be sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username). Channel chats and channel direct messages chats aren't supported.
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Optional. Unique identifier for the target message thread or topic of a forum; for
	// supergroups and private chats of bots with forum topic mode enabled only
	MessageThreadID int `json:"message_thread_id,omitempty"`

	// Action - Type of action to broadcast. Choose one, depending on what the user is about to receive: typing
	// for text messages (https://core.telegram.org/bots/api#sendmessage), upload_photo for photos
	// (https://core.telegram.org/bots/api#sendphoto), record_video or upload_video for videos
	// (https://core.telegram.org/bots/api#sendvideo), record_voice or upload_voice for voice notes
	// (https://core.telegram.org/bots/api#sendvoice), upload_document for general files
	// (https://core.telegram.org/bots/api#senddocument), choose_sticker for stickers
	// (https://core.telegram.org/bots/api#sendsticker), find_location for location data
	// (https://core.telegram.org/bots/api#sendlocation), record_video_note or upload_video_note for video notes
	// (https://core.telegram.org/bots/api#sendvideonote).
	Action string `json:"action"`
}

SendChatActionParams - Represents parameters of sendChatAction method.

func (*SendChatActionParams) WithAction added in v0.10.0 

func (p *SendChatActionParams) WithAction(action string) *SendChatActionParams

WithAction adds action parameter

func (*SendChatActionParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendChatActionParams) WithBusinessConnectionID(businessConnectionID string) *SendChatActionParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendChatActionParams) WithChatID added in v0.10.0 

func (p *SendChatActionParams) WithChatID(chatID ChatID) *SendChatActionParams

WithChatID adds chat ID parameter

func (*SendChatActionParams) WithMessageThreadID added in v0.18.1 

func (p *SendChatActionParams) WithMessageThreadID(messageThreadID int) *SendChatActionParams

WithMessageThreadID adds message thread ID parameter

type SendChecklistParams added in v1.2.0 

type SendChecklistParams struct {
	// BusinessConnectionID - Unique identifier of the business connection on behalf of which the message will
	// be sent
	BusinessConnectionID string `json:"business_connection_id"`

	// ChatID - Unique identifier for the target chat
	ChatID int64 `json:"chat_id"`

	// Checklist - A JSON-serialized object for the checklist to send
	Checklist InputChecklist `json:"checklist"`

	// 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"`

	// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message
	MessageEffectID string `json:"message_effect_id,omitempty"`

	// ReplyParameters - Optional. A JSON-serialized object for description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

SendChecklistParams - Represents parameters of sendChecklist method.

func (*SendChecklistParams) WithBusinessConnectionID added in v1.2.0 

func (p *SendChecklistParams) WithBusinessConnectionID(businessConnectionID string) *SendChecklistParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendChecklistParams) WithChatID added in v1.2.0 

func (p *SendChecklistParams) WithChatID(chatID int64) *SendChecklistParams

WithChatID adds chat ID parameter

func (*SendChecklistParams) WithChecklist added in v1.2.0 

func (p *SendChecklistParams) WithChecklist(checklist InputChecklist) *SendChecklistParams

WithChecklist adds checklist parameter

func (*SendChecklistParams) WithDisableNotification added in v1.2.0 

func (p *SendChecklistParams) WithDisableNotification() *SendChecklistParams

WithDisableNotification adds disable notification parameter

func (*SendChecklistParams) WithMessageEffectID added in v1.2.0 

func (p *SendChecklistParams) WithMessageEffectID(messageEffectID string) *SendChecklistParams

WithMessageEffectID adds message effect ID parameter

func (*SendChecklistParams) WithProtectContent added in v1.2.0 

func (p *SendChecklistParams) WithProtectContent() *SendChecklistParams

WithProtectContent adds protect content parameter

func (*SendChecklistParams) WithReplyMarkup added in v1.2.0 

func (p *SendChecklistParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *SendChecklistParams

WithReplyMarkup adds reply markup parameter

func (*SendChecklistParams) WithReplyParameters added in v1.2.0 

func (p *SendChecklistParams) WithReplyParameters(replyParameters *ReplyParameters) *SendChecklistParams

WithReplyParameters adds reply parameters parameter

type SendContactParams 

type SendContactParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// PhoneNumber - Contact's phone number
	PhoneNumber string `json:"phone_number"`

	// FirstName - Contact's first name
	FirstName string `json:"first_name"`

	// LastName - Optional. Contact's last name
	LastName string `json:"last_name,omitempty"`

	// Vcard - Optional. Additional data about the contact in the form of a vCard
	// (https://en.wikipedia.org/wiki/VCard), 0-2048 bytes
	Vcard string `json:"vcard,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendContactParams - Represents parameters of sendContact method.

func (*SendContactParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendContactParams) WithAllowPaidBroadcast() *SendContactParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendContactParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendContactParams) WithBusinessConnectionID(businessConnectionID string) *SendContactParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendContactParams) WithChatID added in v0.10.0 

func (p *SendContactParams) WithChatID(chatID ChatID) *SendContactParams

WithChatID adds chat ID parameter

func (*SendContactParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendContactParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendContactParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendContactParams) WithDisableNotification added in v0.10.0 

func (p *SendContactParams) WithDisableNotification() *SendContactParams

WithDisableNotification adds disable notification parameter

func (*SendContactParams) WithFirstName added in v0.10.0 

func (p *SendContactParams) WithFirstName(firstName string) *SendContactParams

WithFirstName adds first name parameter

func (*SendContactParams) WithLastName added in v0.10.0 

func (p *SendContactParams) WithLastName(lastName string) *SendContactParams

WithLastName adds last name parameter

func (*SendContactParams) WithMessageEffectID added in v0.30.2 

func (p *SendContactParams) WithMessageEffectID(messageEffectID string) *SendContactParams

WithMessageEffectID adds message effect ID parameter

func (*SendContactParams) WithMessageThreadID added in v0.17.1 

func (p *SendContactParams) WithMessageThreadID(messageThreadID int) *SendContactParams

WithMessageThreadID adds message thread ID parameter

func (*SendContactParams) WithPhoneNumber added in v0.10.0 

func (p *SendContactParams) WithPhoneNumber(phoneNumber string) *SendContactParams

WithPhoneNumber adds phone number parameter

func (*SendContactParams) WithProtectContent added in v0.10.0 

func (p *SendContactParams) WithProtectContent() *SendContactParams

WithProtectContent adds protect content parameter

func (*SendContactParams) WithReplyMarkup added in v0.10.0 

func (p *SendContactParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendContactParams

WithReplyMarkup adds reply markup parameter

func (*SendContactParams) WithReplyParameters added in v0.29.0 

func (p *SendContactParams) WithReplyParameters(replyParameters *ReplyParameters) *SendContactParams

WithReplyParameters adds reply parameters parameter

func (*SendContactParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendContactParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendContactParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendContactParams) WithVcard added in v0.10.0 

func (p *SendContactParams) WithVcard(vcard string) *SendContactParams

WithVcard adds vcard parameter

type SendDiceParams 

type SendDiceParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Emoji - Optional. Emoji on which the dice throw animation is based. Currently, must be one of “🎲”,
	// “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”,
	// “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults
	// to “🎲”
	Emoji string `json:"emoji,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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
	ProtectContent bool `json:"protect_content,omitempty"`

	// AllowPaidBroadcast - Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
	// limits (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendDiceParams - Represents parameters of sendDice method.

func (*SendDiceParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendDiceParams) WithAllowPaidBroadcast() *SendDiceParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendDiceParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendDiceParams) WithBusinessConnectionID(businessConnectionID string) *SendDiceParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendDiceParams) WithChatID added in v0.10.0 

func (p *SendDiceParams) WithChatID(chatID ChatID) *SendDiceParams

WithChatID adds chat ID parameter

func (*SendDiceParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendDiceParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendDiceParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendDiceParams) WithDisableNotification added in v0.10.0 

func (p *SendDiceParams) WithDisableNotification() *SendDiceParams

WithDisableNotification adds disable notification parameter

func (*SendDiceParams) WithEmoji added in v0.10.0 

func (p *SendDiceParams) WithEmoji(emoji string) *SendDiceParams

WithEmoji adds emoji parameter

func (*SendDiceParams) WithMessageEffectID added in v0.30.2 

func (p *SendDiceParams) WithMessageEffectID(messageEffectID string) *SendDiceParams

WithMessageEffectID adds message effect ID parameter

func (*SendDiceParams) WithMessageThreadID added in v0.17.1 

func (p *SendDiceParams) WithMessageThreadID(messageThreadID int) *SendDiceParams

WithMessageThreadID adds message thread ID parameter

func (*SendDiceParams) WithProtectContent added in v0.10.0 

func (p *SendDiceParams) WithProtectContent() *SendDiceParams

WithProtectContent adds protect content parameter

func (*SendDiceParams) WithReplyMarkup added in v0.10.0 

func (p *SendDiceParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendDiceParams

WithReplyMarkup adds reply markup parameter

func (*SendDiceParams) WithReplyParameters added in v0.29.0 

func (p *SendDiceParams) WithReplyParameters(replyParameters *ReplyParameters) *SendDiceParams

WithReplyParameters adds reply parameters parameter

func (*SendDiceParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendDiceParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters) *SendDiceParams

WithSuggestedPostParameters adds suggested post parameters parameter

type SendDocumentParams 

type SendDocumentParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Document InputFile `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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendDocumentParams - Represents parameters of sendDocument method.

func (*SendDocumentParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendDocumentParams) WithAllowPaidBroadcast() *SendDocumentParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendDocumentParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendDocumentParams) WithBusinessConnectionID(businessConnectionID string) *SendDocumentParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendDocumentParams) WithCaption added in v0.10.0 

func (p *SendDocumentParams) WithCaption(caption string) *SendDocumentParams

WithCaption adds caption parameter

func (*SendDocumentParams) WithCaptionEntities added in v0.10.0 

func (p *SendDocumentParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendDocumentParams

WithCaptionEntities adds caption entities parameter

func (*SendDocumentParams) WithChatID added in v0.10.0 

func (p *SendDocumentParams) WithChatID(chatID ChatID) *SendDocumentParams

WithChatID adds chat ID parameter

func (*SendDocumentParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendDocumentParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendDocumentParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendDocumentParams) WithDisableContentTypeDetection added in v0.10.0 

func (p *SendDocumentParams) WithDisableContentTypeDetection() *SendDocumentParams

WithDisableContentTypeDetection adds disable content type detection parameter

func (*SendDocumentParams) WithDisableNotification added in v0.10.0 

func (p *SendDocumentParams) WithDisableNotification() *SendDocumentParams

WithDisableNotification adds disable notification parameter

func (*SendDocumentParams) WithDocument added in v0.10.0 

func (p *SendDocumentParams) WithDocument(document InputFile) *SendDocumentParams

WithDocument adds document parameter

func (*SendDocumentParams) WithMessageEffectID added in v0.30.2 

func (p *SendDocumentParams) WithMessageEffectID(messageEffectID string) *SendDocumentParams

WithMessageEffectID adds message effect ID parameter

func (*SendDocumentParams) WithMessageThreadID added in v0.17.1 

func (p *SendDocumentParams) WithMessageThreadID(messageThreadID int) *SendDocumentParams

WithMessageThreadID adds message thread ID parameter

func (*SendDocumentParams) WithParseMode added in v0.10.0 

func (p *SendDocumentParams) WithParseMode(parseMode string) *SendDocumentParams

WithParseMode adds parse mode parameter

func (*SendDocumentParams) WithProtectContent added in v0.10.0 

func (p *SendDocumentParams) WithProtectContent() *SendDocumentParams

WithProtectContent adds protect content parameter

func (*SendDocumentParams) WithReplyMarkup added in v0.10.0 

func (p *SendDocumentParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendDocumentParams

WithReplyMarkup adds reply markup parameter

func (*SendDocumentParams) WithReplyParameters added in v0.29.0 

func (p *SendDocumentParams) WithReplyParameters(replyParameters *ReplyParameters) *SendDocumentParams

WithReplyParameters adds reply parameters parameter

func (*SendDocumentParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendDocumentParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendDocumentParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendDocumentParams) WithThumbnail added in v0.22.0 

func (p *SendDocumentParams) WithThumbnail(thumbnail *InputFile) *SendDocumentParams

WithThumbnail adds thumbnail parameter

type SendGameParams 

type SendGameParams 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 - Unique identifier for the target chat. 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 - Short name of the game, serves as the unique identifier for the game. Set up your games
	// via @BotFather (https://t.me/botfather).
	GameShortName string `json:"game_short_name"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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
	// (https://core.telegram.org/bots/features#inline-keyboards). 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"`
}

SendGameParams - Represents parameters of sendGame method.

func (*SendGameParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendGameParams) WithAllowPaidBroadcast() *SendGameParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendGameParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendGameParams) WithBusinessConnectionID(businessConnectionID string) *SendGameParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendGameParams) WithChatID added in v1.1.0 

func (p *SendGameParams) WithChatID(chatID int64) *SendGameParams

WithChatID adds chat ID parameter

func (*SendGameParams) WithDisableNotification added in v0.10.0 

func (p *SendGameParams) WithDisableNotification() *SendGameParams

WithDisableNotification adds disable notification parameter

func (*SendGameParams) WithGameShortName added in v0.10.0 

func (p *SendGameParams) WithGameShortName(gameShortName string) *SendGameParams

WithGameShortName adds game short name parameter

func (*SendGameParams) WithMessageEffectID added in v0.30.2 

func (p *SendGameParams) WithMessageEffectID(messageEffectID string) *SendGameParams

WithMessageEffectID adds message effect ID parameter

func (*SendGameParams) WithMessageThreadID added in v0.17.1 

func (p *SendGameParams) WithMessageThreadID(messageThreadID int) *SendGameParams

WithMessageThreadID adds message thread ID parameter

func (*SendGameParams) WithProtectContent added in v0.10.0 

func (p *SendGameParams) WithProtectContent() *SendGameParams

WithProtectContent adds protect content parameter

func (*SendGameParams) WithReplyMarkup added in v0.10.0 

func (p *SendGameParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *SendGameParams

WithReplyMarkup adds reply markup parameter

func (*SendGameParams) WithReplyParameters added in v0.29.0 

func (p *SendGameParams) WithReplyParameters(replyParameters *ReplyParameters) *SendGameParams

WithReplyParameters adds reply parameters parameter

type SendGiftParams added in v0.32.0 

type SendGiftParams struct {
	// UserID - Optional. Required if chat_id is not specified. Unique identifier of the target user who will
	// receive the gift.
	UserID int64 `json:"user_id,omitempty"`

	// ChatID - Optional. Required if user_id is not specified. Unique identifier for the chat or username of
	// the channel (in the format @channel_username) that will receive the gift.
	ChatID ChatID `json:"chat_id,omitzero"`

	// GiftID - 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,omitempty"`

	// Text - Optional. Text that will be shown along with the gift; 0-128 characters
	Text string `json:"text,omitempty"`

	// TextParseMode - Optional. Mode for parsing entities in the text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details. Entities other than “bold”,
	// “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.
	TextParseMode string `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”, and “custom_emoji” are ignored.
	TextEntities []MessageEntity `json:"text_entities,omitempty"`
}

SendGiftParams - Represents parameters of sendGift method.

func (*SendGiftParams) WithChatID added in v1.0.2 

func (p *SendGiftParams) WithChatID(chatID ChatID) *SendGiftParams

WithChatID adds chat ID parameter

func (*SendGiftParams) WithGiftID added in v0.32.0 

func (p *SendGiftParams) WithGiftID(giftID string) *SendGiftParams

WithGiftID adds gift ID parameter

func (*SendGiftParams) WithPayForUpgrade added in v0.32.0 

func (p *SendGiftParams) WithPayForUpgrade() *SendGiftParams

WithPayForUpgrade adds pay for upgrade parameter

func (*SendGiftParams) WithText added in v0.32.0 

func (p *SendGiftParams) WithText(text string) *SendGiftParams

WithText adds text parameter

func (*SendGiftParams) WithTextEntities added in v0.32.0 

func (p *SendGiftParams) WithTextEntities(textEntities ...MessageEntity) *SendGiftParams

WithTextEntities adds text entities parameter

func (*SendGiftParams) WithTextParseMode added in v0.32.0 

func (p *SendGiftParams) WithTextParseMode(textParseMode string) *SendGiftParams

WithTextParseMode adds text parse mode parameter

func (*SendGiftParams) WithUserID added in v1.1.0 

func (p *SendGiftParams) WithUserID(userID int64) *SendGiftParams

WithUserID adds user ID parameter

type SendInvoiceParams 

type SendInvoiceParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - Product name, 1-32 characters
	Title string `json:"title"`

	// Description - Product description, 1-255 characters
	Description string `json:"description"`

	// Payload - 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 (https://t.me/botfather). Pass
	// an empty string for payments in Telegram Stars (https://t.me/BotNews/90).
	ProviderToken string `json:"provider_token,omitempty"`

	// Currency - Three-letter ISO 4217 currency code, see more on currencies
	// (https://core.telegram.org/bots/payments#supported-currencies). Pass “XTR” for payments in Telegram Stars
	// (https://t.me/BotNews/90).
	Currency string `json:"currency"`

	// Prices - 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
	// (https://t.me/BotNews/90).
	Prices []LabeledPrice `json:"prices"`

	// MaxTipAmount - Optional. The maximum accepted amount for tips in the smallest units of the currency
	// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the
	// exp parameter in currencies.json (https://core.telegram.org/bots/payments/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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	NeedShippingAddress bool `json:"need_shipping_address,omitempty"`

	// SendPhoneNumberToProvider - Optional. Pass True if the user's phone number should be sent to the
	// provider. Ignored for payments in Telegram Stars (https://t.me/BotNews/90).
	SendPhoneNumberToProvider 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 (https://t.me/BotNews/90).
	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 (https://t.me/BotNews/90).
	IsFlexible bool `json:"is_flexible,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - Optional. Description of the message to reply to
	ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for an inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards). 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"`
}

SendInvoiceParams - Represents parameters of sendInvoice method.

func (*SendInvoiceParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendInvoiceParams) WithAllowPaidBroadcast() *SendInvoiceParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendInvoiceParams) WithChatID added in v0.10.0 

func (p *SendInvoiceParams) WithChatID(chatID ChatID) *SendInvoiceParams

WithChatID adds chat ID parameter

func (*SendInvoiceParams) WithCurrency added in v0.10.0 

func (p *SendInvoiceParams) WithCurrency(currency string) *SendInvoiceParams

WithCurrency adds currency parameter

func (*SendInvoiceParams) WithDescription added in v0.10.0 

func (p *SendInvoiceParams) WithDescription(description string) *SendInvoiceParams

WithDescription adds description parameter

func (*SendInvoiceParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendInvoiceParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendInvoiceParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendInvoiceParams) WithDisableNotification added in v0.10.0 

func (p *SendInvoiceParams) WithDisableNotification() *SendInvoiceParams

WithDisableNotification adds disable notification parameter

func (*SendInvoiceParams) WithIsFlexible added in v0.10.0 

func (p *SendInvoiceParams) WithIsFlexible() *SendInvoiceParams

WithIsFlexible adds is flexible parameter

func (*SendInvoiceParams) WithMaxTipAmount added in v0.10.0 

func (p *SendInvoiceParams) WithMaxTipAmount(maxTipAmount int) *SendInvoiceParams

WithMaxTipAmount adds max tip amount parameter

func (*SendInvoiceParams) WithMessageEffectID added in v0.30.2 

func (p *SendInvoiceParams) WithMessageEffectID(messageEffectID string) *SendInvoiceParams

WithMessageEffectID adds message effect ID parameter

func (*SendInvoiceParams) WithMessageThreadID added in v0.17.1 

func (p *SendInvoiceParams) WithMessageThreadID(messageThreadID int) *SendInvoiceParams

WithMessageThreadID adds message thread ID parameter

func (*SendInvoiceParams) WithNeedEmail added in v0.10.0 

func (p *SendInvoiceParams) WithNeedEmail() *SendInvoiceParams

WithNeedEmail adds need email parameter

func (*SendInvoiceParams) WithNeedName added in v0.10.0 

func (p *SendInvoiceParams) WithNeedName() *SendInvoiceParams

WithNeedName adds need name parameter

func (*SendInvoiceParams) WithNeedPhoneNumber added in v0.10.0 

func (p *SendInvoiceParams) WithNeedPhoneNumber() *SendInvoiceParams

WithNeedPhoneNumber adds need phone number parameter

func (*SendInvoiceParams) WithNeedShippingAddress added in v0.10.0 

func (p *SendInvoiceParams) WithNeedShippingAddress() *SendInvoiceParams

WithNeedShippingAddress adds need shipping address parameter

func (*SendInvoiceParams) WithPayload added in v0.10.0 

func (p *SendInvoiceParams) WithPayload(payload string) *SendInvoiceParams

WithPayload adds payload parameter

func (*SendInvoiceParams) WithPhotoHeight added in v0.10.0 

func (p *SendInvoiceParams) WithPhotoHeight(photoHeight int) *SendInvoiceParams

WithPhotoHeight adds photo height parameter

func (*SendInvoiceParams) WithPhotoSize added in v0.10.0 

func (p *SendInvoiceParams) WithPhotoSize(photoSize int) *SendInvoiceParams

WithPhotoSize adds photo size parameter

func (*SendInvoiceParams) WithPhotoURL added in v0.10.0 

func (p *SendInvoiceParams) WithPhotoURL(photoURL string) *SendInvoiceParams

WithPhotoURL adds photo URL parameter

func (*SendInvoiceParams) WithPhotoWidth added in v0.10.0 

func (p *SendInvoiceParams) WithPhotoWidth(photoWidth int) *SendInvoiceParams

WithPhotoWidth adds photo width parameter

func (*SendInvoiceParams) WithPrices added in v0.10.0 

func (p *SendInvoiceParams) WithPrices(prices ...LabeledPrice) *SendInvoiceParams

WithPrices adds prices parameter

func (*SendInvoiceParams) WithProtectContent added in v0.10.0 

func (p *SendInvoiceParams) WithProtectContent() *SendInvoiceParams

WithProtectContent adds protect content parameter

func (*SendInvoiceParams) WithProviderData added in v0.10.0 

func (p *SendInvoiceParams) WithProviderData(providerData string) *SendInvoiceParams

WithProviderData adds provider data parameter

func (*SendInvoiceParams) WithProviderToken added in v0.10.0 

func (p *SendInvoiceParams) WithProviderToken(providerToken string) *SendInvoiceParams

WithProviderToken adds provider token parameter

func (*SendInvoiceParams) WithReplyMarkup added in v0.10.0 

func (p *SendInvoiceParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *SendInvoiceParams

WithReplyMarkup adds reply markup parameter

func (*SendInvoiceParams) WithReplyParameters added in v0.29.0 

func (p *SendInvoiceParams) WithReplyParameters(replyParameters *ReplyParameters) *SendInvoiceParams

WithReplyParameters adds reply parameters parameter

func (*SendInvoiceParams) WithSendEmailToProvider added in v0.10.0 

func (p *SendInvoiceParams) WithSendEmailToProvider() *SendInvoiceParams

WithSendEmailToProvider adds send email to provider parameter

func (*SendInvoiceParams) WithSendPhoneNumberToProvider added in v0.10.0 

func (p *SendInvoiceParams) WithSendPhoneNumberToProvider() *SendInvoiceParams

WithSendPhoneNumberToProvider adds send phone number to provider parameter

func (*SendInvoiceParams) WithStartParameter added in v0.10.0 

func (p *SendInvoiceParams) WithStartParameter(startParameter string) *SendInvoiceParams

WithStartParameter adds start parameter parameter

func (*SendInvoiceParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendInvoiceParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendInvoiceParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendInvoiceParams) WithSuggestedTipAmounts added in v0.10.0 

func (p *SendInvoiceParams) WithSuggestedTipAmounts(suggestedTipAmounts ...int) *SendInvoiceParams

WithSuggestedTipAmounts adds suggested tip amounts parameter

func (*SendInvoiceParams) WithTitle added in v0.10.0 

func (p *SendInvoiceParams) WithTitle(title string) *SendInvoiceParams

WithTitle adds title parameter

type SendLocationParams 

type SendLocationParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Latitude - Latitude of the location
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of the location
	Longitude float64 `json:"longitude"`

	// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
	HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`

	// LivePeriod - Optional. Period in seconds during which the location will be updated (see Live Locations
	// (https://telegram.org/blog/live-locations), should be between 60 and 86400, or 0x7FFFFFFF for live locations
	// that can be edited indefinitely.
	LivePeriod int `json:"live_period,omitempty"`

	// Heading - Optional. For live locations, a direction in which the user is moving, in degrees. Must be
	// between 1 and 360 if specified.
	Heading int `json:"heading,omitempty"`

	// ProximityAlertRadius - Optional. For live locations, a maximum distance for proximity alerts about
	// approaching another chat member, in meters. Must be between 1 and 100000 if specified.
	ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendLocationParams - Represents parameters of sendLocation method.

func (*SendLocationParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendLocationParams) WithAllowPaidBroadcast() *SendLocationParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendLocationParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendLocationParams) WithBusinessConnectionID(businessConnectionID string) *SendLocationParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendLocationParams) WithChatID added in v0.10.0 

func (p *SendLocationParams) WithChatID(chatID ChatID) *SendLocationParams

WithChatID adds chat ID parameter

func (*SendLocationParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendLocationParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendLocationParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendLocationParams) WithDisableNotification added in v0.10.0 

func (p *SendLocationParams) WithDisableNotification() *SendLocationParams

WithDisableNotification adds disable notification parameter

func (*SendLocationParams) WithHeading added in v0.10.0 

func (p *SendLocationParams) WithHeading(heading int) *SendLocationParams

WithHeading adds heading parameter

func (*SendLocationParams) WithHorizontalAccuracy added in v1.1.0 

func (p *SendLocationParams) WithHorizontalAccuracy(horizontalAccuracy float64) *SendLocationParams

WithHorizontalAccuracy adds horizontal accuracy parameter

func (*SendLocationParams) WithLatitude added in v1.1.0 

func (p *SendLocationParams) WithLatitude(latitude float64) *SendLocationParams

WithLatitude adds latitude parameter

func (*SendLocationParams) WithLivePeriod added in v0.10.0 

func (p *SendLocationParams) WithLivePeriod(livePeriod int) *SendLocationParams

WithLivePeriod adds live period parameter

func (*SendLocationParams) WithLongitude added in v1.1.0 

func (p *SendLocationParams) WithLongitude(longitude float64) *SendLocationParams

WithLongitude adds longitude parameter

func (*SendLocationParams) WithMessageEffectID added in v0.30.2 

func (p *SendLocationParams) WithMessageEffectID(messageEffectID string) *SendLocationParams

WithMessageEffectID adds message effect ID parameter

func (*SendLocationParams) WithMessageThreadID added in v0.17.1 

func (p *SendLocationParams) WithMessageThreadID(messageThreadID int) *SendLocationParams

WithMessageThreadID adds message thread ID parameter

func (*SendLocationParams) WithProtectContent added in v0.10.0 

func (p *SendLocationParams) WithProtectContent() *SendLocationParams

WithProtectContent adds protect content parameter

func (*SendLocationParams) WithProximityAlertRadius added in v0.10.0 

func (p *SendLocationParams) WithProximityAlertRadius(proximityAlertRadius int) *SendLocationParams

WithProximityAlertRadius adds proximity alert radius parameter

func (*SendLocationParams) WithReplyMarkup added in v0.10.0 

func (p *SendLocationParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendLocationParams

WithReplyMarkup adds reply markup parameter

func (*SendLocationParams) WithReplyParameters added in v0.29.0 

func (p *SendLocationParams) WithReplyParameters(replyParameters *ReplyParameters) *SendLocationParams

WithReplyParameters adds reply parameters parameter

func (*SendLocationParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendLocationParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendLocationParams

WithSuggestedPostParameters adds suggested post parameters parameter

type SendMediaGroupParams 

type SendMediaGroupParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - A JSON-serialized array describing messages to be sent, must include 2-10 items
	Media []InputMedia `json:"media"`

	// DisableNotification - Optional. Sends messages silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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"`
}

SendMediaGroupParams - Represents parameters of sendMediaGroup method.

func (*SendMediaGroupParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendMediaGroupParams) WithAllowPaidBroadcast() *SendMediaGroupParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendMediaGroupParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendMediaGroupParams) WithBusinessConnectionID(businessConnectionID string) *SendMediaGroupParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendMediaGroupParams) WithChatID added in v0.10.0 

func (p *SendMediaGroupParams) WithChatID(chatID ChatID) *SendMediaGroupParams

WithChatID adds chat ID parameter

func (*SendMediaGroupParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendMediaGroupParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendMediaGroupParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendMediaGroupParams) WithDisableNotification added in v0.10.0 

func (p *SendMediaGroupParams) WithDisableNotification() *SendMediaGroupParams

WithDisableNotification adds disable notification parameter

func (*SendMediaGroupParams) WithMedia added in v0.10.0 

func (p *SendMediaGroupParams) WithMedia(media ...InputMedia) *SendMediaGroupParams

WithMedia adds media parameter

func (*SendMediaGroupParams) WithMessageEffectID added in v0.30.2 

func (p *SendMediaGroupParams) WithMessageEffectID(messageEffectID string) *SendMediaGroupParams

WithMessageEffectID adds message effect ID parameter

func (*SendMediaGroupParams) WithMessageThreadID added in v0.17.1 

func (p *SendMediaGroupParams) WithMessageThreadID(messageThreadID int) *SendMediaGroupParams

WithMessageThreadID adds message thread ID parameter

func (*SendMediaGroupParams) WithProtectContent added in v0.10.0 

func (p *SendMediaGroupParams) WithProtectContent() *SendMediaGroupParams

WithProtectContent adds protect content parameter

func (*SendMediaGroupParams) WithReplyParameters added in v0.29.0 

func (p *SendMediaGroupParams) WithReplyParameters(replyParameters *ReplyParameters) *SendMediaGroupParams

WithReplyParameters adds reply parameters parameter

type SendMessageDraftParams added in v1.4.0 

type SendMessageDraftParams struct {
	// ChatID - Unique identifier for the target private chat
	ChatID int64 `json:"chat_id"`

	// MessageThreadID - Optional. Unique identifier for the target message thread
	MessageThreadID int `json:"message_thread_id,omitempty"`

	// DraftID - Unique identifier of the message draft; must be non-zero. Changes of drafts with the same
	// identifier are animated
	DraftID int `json:"draft_id"`

	// Text - Text of the message to be sent, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// ParseMode - Optional. Mode for parsing entities in the message text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `json:"parse_mode,omitempty"`

	// Entities - Optional. A JSON-serialized list of special entities that appear in message text, which can be
	// specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`
}

SendMessageDraftParams - Represents parameters of sendMessageDraft method.

func (*SendMessageDraftParams) WithChatID added in v1.4.0 

func (p *SendMessageDraftParams) WithChatID(chatID int64) *SendMessageDraftParams

WithChatID adds chat ID parameter

func (*SendMessageDraftParams) WithDraftID added in v1.4.0 

func (p *SendMessageDraftParams) WithDraftID(draftID int) *SendMessageDraftParams

WithDraftID adds draft ID parameter

func (*SendMessageDraftParams) WithEntities added in v1.4.0 

func (p *SendMessageDraftParams) WithEntities(entities ...MessageEntity) *SendMessageDraftParams

WithEntities adds entities parameter

func (*SendMessageDraftParams) WithMessageThreadID added in v1.4.0 

func (p *SendMessageDraftParams) WithMessageThreadID(messageThreadID int) *SendMessageDraftParams

WithMessageThreadID adds message thread ID parameter

func (*SendMessageDraftParams) WithParseMode added in v1.4.0 

func (p *SendMessageDraftParams) WithParseMode(parseMode string) *SendMessageDraftParams

WithParseMode adds parse mode parameter

func (*SendMessageDraftParams) WithText added in v1.4.0 

func (p *SendMessageDraftParams) WithText(text string) *SendMessageDraftParams

WithText adds text parameter

type SendMessageParams 

type SendMessageParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Text - Text of the message to be sent, 1-4096 characters after entities parsing
	Text string `json:"text"`

	// ParseMode - Optional. Mode for parsing entities in the message text. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `json:"parse_mode,omitempty"`

	// Entities - Optional. A JSON-serialized list of special entities that appear in message text, which can be
	// specified instead of parse_mode
	Entities []MessageEntity `json:"entities,omitempty"`

	// LinkPreviewOptions - Optional. Link preview generation options for the message
	LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendMessageParams - Represents parameters of sendMessage method.

func (*SendMessageParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendMessageParams) WithAllowPaidBroadcast() *SendMessageParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendMessageParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendMessageParams) WithBusinessConnectionID(businessConnectionID string) *SendMessageParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendMessageParams) WithChatID added in v0.10.0 

func (p *SendMessageParams) WithChatID(chatID ChatID) *SendMessageParams

WithChatID adds chat ID parameter

func (*SendMessageParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendMessageParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendMessageParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendMessageParams) WithDisableNotification added in v0.10.0 

func (p *SendMessageParams) WithDisableNotification() *SendMessageParams

WithDisableNotification adds disable notification parameter

func (*SendMessageParams) WithEntities added in v0.10.0 

func (p *SendMessageParams) WithEntities(entities ...MessageEntity) *SendMessageParams

WithEntities adds entities parameter

func (*SendMessageParams) WithLinkPreviewOptions added in v0.29.0 

func (p *SendMessageParams) WithLinkPreviewOptions(linkPreviewOptions *LinkPreviewOptions) *SendMessageParams

WithLinkPreviewOptions adds link preview options parameter

func (*SendMessageParams) WithMessageEffectID added in v0.30.2 

func (p *SendMessageParams) WithMessageEffectID(messageEffectID string) *SendMessageParams

WithMessageEffectID adds message effect ID parameter

func (*SendMessageParams) WithMessageThreadID added in v0.17.1 

func (p *SendMessageParams) WithMessageThreadID(messageThreadID int) *SendMessageParams

WithMessageThreadID adds message thread ID parameter

func (*SendMessageParams) WithParseMode added in v0.10.0 

func (p *SendMessageParams) WithParseMode(parseMode string) *SendMessageParams

WithParseMode adds parse mode parameter

func (*SendMessageParams) WithProtectContent added in v0.10.0 

func (p *SendMessageParams) WithProtectContent() *SendMessageParams

WithProtectContent adds protect content parameter

func (*SendMessageParams) WithReplyMarkup added in v0.10.0 

func (p *SendMessageParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendMessageParams

WithReplyMarkup adds reply markup parameter

func (*SendMessageParams) WithReplyParameters added in v0.29.0 

func (p *SendMessageParams) WithReplyParameters(replyParameters *ReplyParameters) *SendMessageParams

WithReplyParameters adds reply parameters parameter

func (*SendMessageParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendMessageParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendMessageParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendMessageParams) WithText added in v0.10.0 

func (p *SendMessageParams) WithText(text string) *SendMessageParams

WithText adds text parameter

type SendPaidMediaParams added in v0.31.0 

type SendPaidMediaParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_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 ChatID `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 - The number of Telegram Stars that must be paid to buy access to the media; 1-25000
	StarCount int `json:"star_count"`

	// Media - 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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendPaidMediaParams - Represents parameters of sendPaidMedia method.

func (*SendPaidMediaParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendPaidMediaParams) WithAllowPaidBroadcast() *SendPaidMediaParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendPaidMediaParams) WithBusinessConnectionID added in v0.31.2 

func (p *SendPaidMediaParams) WithBusinessConnectionID(businessConnectionID string) *SendPaidMediaParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendPaidMediaParams) WithCaption added in v0.31.0 

func (p *SendPaidMediaParams) WithCaption(caption string) *SendPaidMediaParams

WithCaption adds caption parameter

func (*SendPaidMediaParams) WithCaptionEntities added in v0.31.0 

func (p *SendPaidMediaParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendPaidMediaParams

WithCaptionEntities adds caption entities parameter

func (*SendPaidMediaParams) WithChatID added in v0.31.0 

func (p *SendPaidMediaParams) WithChatID(chatID ChatID) *SendPaidMediaParams

WithChatID adds chat ID parameter

func (*SendPaidMediaParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendPaidMediaParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendPaidMediaParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendPaidMediaParams) WithDisableNotification added in v0.31.0 

func (p *SendPaidMediaParams) WithDisableNotification() *SendPaidMediaParams

WithDisableNotification adds disable notification parameter

func (*SendPaidMediaParams) WithMedia added in v0.31.0 

func (p *SendPaidMediaParams) WithMedia(media ...InputPaidMedia) *SendPaidMediaParams

WithMedia adds media parameter

func (*SendPaidMediaParams) WithMessageThreadID added in v1.3.0 

func (p *SendPaidMediaParams) WithMessageThreadID(messageThreadID int) *SendPaidMediaParams

WithMessageThreadID adds message thread ID parameter

func (*SendPaidMediaParams) WithParseMode added in v0.31.0 

func (p *SendPaidMediaParams) WithParseMode(parseMode string) *SendPaidMediaParams

WithParseMode adds parse mode parameter

func (*SendPaidMediaParams) WithPayload added in v0.31.3 

func (p *SendPaidMediaParams) WithPayload(payload string) *SendPaidMediaParams

WithPayload adds payload parameter

func (*SendPaidMediaParams) WithProtectContent added in v0.31.0 

func (p *SendPaidMediaParams) WithProtectContent() *SendPaidMediaParams

WithProtectContent adds protect content parameter

func (*SendPaidMediaParams) WithReplyMarkup added in v0.31.0 

func (p *SendPaidMediaParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendPaidMediaParams

WithReplyMarkup adds reply markup parameter

func (*SendPaidMediaParams) WithReplyParameters added in v0.31.0 

func (p *SendPaidMediaParams) WithReplyParameters(replyParameters *ReplyParameters) *SendPaidMediaParams

WithReplyParameters adds reply parameters parameter

func (*SendPaidMediaParams) WithShowCaptionAboveMedia added in v0.31.0 

func (p *SendPaidMediaParams) WithShowCaptionAboveMedia() *SendPaidMediaParams

WithShowCaptionAboveMedia adds show caption above media parameter

func (*SendPaidMediaParams) WithStarCount added in v0.31.0 

func (p *SendPaidMediaParams) WithStarCount(starCount int) *SendPaidMediaParams

WithStarCount adds star count parameter

func (*SendPaidMediaParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendPaidMediaParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendPaidMediaParams

WithSuggestedPostParameters adds suggested post parameters parameter

type SendPhotoParams 

type SendPhotoParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Photo InputFile `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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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 photo needs to be covered with a spoiler animation
	HasSpoiler bool `json:"has_spoiler,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendPhotoParams - Represents parameters of sendPhoto method.

func (*SendPhotoParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendPhotoParams) WithAllowPaidBroadcast() *SendPhotoParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendPhotoParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendPhotoParams) WithBusinessConnectionID(businessConnectionID string) *SendPhotoParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendPhotoParams) WithCaption added in v0.10.0 

func (p *SendPhotoParams) WithCaption(caption string) *SendPhotoParams

WithCaption adds caption parameter

func (*SendPhotoParams) WithCaptionEntities added in v0.10.0 

func (p *SendPhotoParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendPhotoParams

WithCaptionEntities adds caption entities parameter

func (*SendPhotoParams) WithChatID added in v0.10.0 

func (p *SendPhotoParams) WithChatID(chatID ChatID) *SendPhotoParams

WithChatID adds chat ID parameter

func (*SendPhotoParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendPhotoParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendPhotoParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendPhotoParams) WithDisableNotification added in v0.10.0 

func (p *SendPhotoParams) WithDisableNotification() *SendPhotoParams

WithDisableNotification adds disable notification parameter

func (*SendPhotoParams) WithHasSpoiler added in v0.18.1 

func (p *SendPhotoParams) WithHasSpoiler() *SendPhotoParams

WithHasSpoiler adds has spoiler parameter

func (*SendPhotoParams) WithMessageEffectID added in v0.30.2 

func (p *SendPhotoParams) WithMessageEffectID(messageEffectID string) *SendPhotoParams

WithMessageEffectID adds message effect ID parameter

func (*SendPhotoParams) WithMessageThreadID added in v0.17.1 

func (p *SendPhotoParams) WithMessageThreadID(messageThreadID int) *SendPhotoParams

WithMessageThreadID adds message thread ID parameter

func (*SendPhotoParams) WithParseMode added in v0.10.0 

func (p *SendPhotoParams) WithParseMode(parseMode string) *SendPhotoParams

WithParseMode adds parse mode parameter

func (*SendPhotoParams) WithPhoto added in v0.10.0 

func (p *SendPhotoParams) WithPhoto(photo InputFile) *SendPhotoParams

WithPhoto adds photo parameter

func (*SendPhotoParams) WithProtectContent added in v0.10.0 

func (p *SendPhotoParams) WithProtectContent() *SendPhotoParams

WithProtectContent adds protect content parameter

func (*SendPhotoParams) WithReplyMarkup added in v0.10.0 

func (p *SendPhotoParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendPhotoParams

WithReplyMarkup adds reply markup parameter

func (*SendPhotoParams) WithReplyParameters added in v0.29.0 

func (p *SendPhotoParams) WithReplyParameters(replyParameters *ReplyParameters) *SendPhotoParams

WithReplyParameters adds reply parameters parameter

func (*SendPhotoParams) WithShowCaptionAboveMedia added in v0.30.2 

func (p *SendPhotoParams) WithShowCaptionAboveMedia() *SendPhotoParams

WithShowCaptionAboveMedia adds show caption above media parameter

func (*SendPhotoParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendPhotoParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendPhotoParams

WithSuggestedPostParameters adds suggested post parameters parameter

type SendPollParams 

type SendPollParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username). Polls can't be sent to channel direct messages chats.
	ChatID ChatID `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"`

	// Question - Poll question, 1-300 characters
	Question string `json:"question"`

	// QuestionParseMode - Optional. Mode for parsing entities in the question. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details. Currently, only custom emoji
	// entities are allowed
	QuestionParseMode string `json:"question_parse_mode,omitempty"`

	// QuestionEntities - Optional. A JSON-serialized list of special entities that appear in the poll question.
	// It can be specified instead of question_parse_mode
	QuestionEntities []MessageEntity `json:"question_entities,omitempty"`

	// Options - A JSON-serialized list of 2-12 answer options
	Options []InputPollOption `json:"options"`

	// IsAnonymous - Optional. True, if the poll needs to be anonymous, defaults to True
	IsAnonymous *bool `json:"is_anonymous,omitempty"`

	// Type - Optional. Poll type, “quiz” or “regular”, defaults to “regular”
	Type string `json:"type,omitempty"`

	// AllowsMultipleAnswers - Optional. True, if the poll allows multiple answers, ignored for polls in quiz
	// mode, defaults to False
	AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"`

	// CorrectOptionID - Optional. 0-based identifier of the correct answer option, required for polls in quiz
	// mode
	CorrectOptionID *int `json:"correct_option_id,omitempty"`

	// Explanation - Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp
	// icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
	Explanation string `json:"explanation,omitempty"`

	// ExplanationParseMode - Optional. Mode for parsing entities in the explanation. See formatting options
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ExplanationParseMode string `json:"explanation_parse_mode,omitempty"`

	// ExplanationEntities - Optional. A JSON-serialized list of special entities that appear in the poll
	// explanation. It can be specified instead of explanation_parse_mode
	ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`

	// OpenPeriod - Optional. Amount of time in seconds the poll will be active after creation, 5-600. Can't be
	// used together with close_date.
	OpenPeriod int `json:"open_period,omitempty"`

	// CloseDate - Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be
	// at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
	CloseDate int64 `json:"close_date,omitempty"`

	// IsClosed - Optional. Pass True if the poll needs to be immediately closed. This can be useful for poll
	// preview.
	IsClosed bool `json:"is_closed,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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. Additional interface options. A JSON-serialized object for an inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendPollParams - Represents parameters of sendPoll method.

func (*SendPollParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendPollParams) WithAllowPaidBroadcast() *SendPollParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendPollParams) WithAllowsMultipleAnswers added in v0.10.0 

func (p *SendPollParams) WithAllowsMultipleAnswers() *SendPollParams

WithAllowsMultipleAnswers adds allows multiple answers parameter

func (*SendPollParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendPollParams) WithBusinessConnectionID(businessConnectionID string) *SendPollParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendPollParams) WithChatID added in v0.10.0 

func (p *SendPollParams) WithChatID(chatID ChatID) *SendPollParams

WithChatID adds chat ID parameter

func (*SendPollParams) WithCloseDate added in v1.1.0 

func (p *SendPollParams) WithCloseDate(closeDate int64) *SendPollParams

WithCloseDate adds close date parameter

func (*SendPollParams) WithCorrectOptionID added in v0.10.0 

func (p *SendPollParams) WithCorrectOptionID(correctOptionID int) *SendPollParams

WithCorrectOptionID adds correct option ID parameter

func (*SendPollParams) WithDisableNotification added in v0.10.0 

func (p *SendPollParams) WithDisableNotification() *SendPollParams

WithDisableNotification adds disable notification parameter

func (*SendPollParams) WithExplanation added in v0.10.0 

func (p *SendPollParams) WithExplanation(explanation string) *SendPollParams

WithExplanation adds explanation parameter

func (*SendPollParams) WithExplanationEntities added in v0.10.0 

func (p *SendPollParams) WithExplanationEntities(explanationEntities ...MessageEntity) *SendPollParams

WithExplanationEntities adds explanation entities parameter

func (*SendPollParams) WithExplanationParseMode added in v0.10.0 

func (p *SendPollParams) WithExplanationParseMode(explanationParseMode string) *SendPollParams

WithExplanationParseMode adds explanation parse mode parameter

func (*SendPollParams) WithIsAnonymous added in v0.10.0 

func (p *SendPollParams) WithIsAnonymous(isAnonymous bool) *SendPollParams

WithIsAnonymous adds is anonymous parameter

func (*SendPollParams) WithIsClosed added in v0.10.0 

func (p *SendPollParams) WithIsClosed() *SendPollParams

WithIsClosed adds is closed parameter

func (*SendPollParams) WithMessageEffectID added in v0.30.2 

func (p *SendPollParams) WithMessageEffectID(messageEffectID string) *SendPollParams

WithMessageEffectID adds message effect ID parameter

func (*SendPollParams) WithMessageThreadID added in v0.17.1 

func (p *SendPollParams) WithMessageThreadID(messageThreadID int) *SendPollParams

WithMessageThreadID adds message thread ID parameter

func (*SendPollParams) WithOpenPeriod added in v0.10.0 

func (p *SendPollParams) WithOpenPeriod(openPeriod int) *SendPollParams

WithOpenPeriod adds open period parameter

func (*SendPollParams) WithOptions added in v0.10.0 

func (p *SendPollParams) WithOptions(options ...InputPollOption) *SendPollParams

WithOptions adds options parameter

func (*SendPollParams) WithProtectContent added in v0.10.0 

func (p *SendPollParams) WithProtectContent() *SendPollParams

WithProtectContent adds protect content parameter

func (*SendPollParams) WithQuestion added in v0.10.0 

func (p *SendPollParams) WithQuestion(question string) *SendPollParams

WithQuestion adds question parameter

func (*SendPollParams) WithQuestionEntities added in v0.30.1 

func (p *SendPollParams) WithQuestionEntities(questionEntities ...MessageEntity) *SendPollParams

WithQuestionEntities adds question entities parameter

func (*SendPollParams) WithQuestionParseMode added in v0.30.1 

func (p *SendPollParams) WithQuestionParseMode(questionParseMode string) *SendPollParams

WithQuestionParseMode adds question parse mode parameter

func (*SendPollParams) WithReplyMarkup added in v0.10.0 

func (p *SendPollParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendPollParams

WithReplyMarkup adds reply markup parameter

func (*SendPollParams) WithReplyParameters added in v0.29.0 

func (p *SendPollParams) WithReplyParameters(replyParameters *ReplyParameters) *SendPollParams

WithReplyParameters adds reply parameters parameter

func (*SendPollParams) WithType added in v0.10.0 

func (p *SendPollParams) WithType(pollType string) *SendPollParams

WithType adds type parameter

type SendStickerParams 

type SendStickerParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Sticker - 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 »
	// (https://core.telegram.org/bots/api#sending-files). Video and animated stickers can't be sent via an HTTP
	// URL.
	Sticker InputFile `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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendStickerParams - Represents parameters of sendSticker method.

func (*SendStickerParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendStickerParams) WithAllowPaidBroadcast() *SendStickerParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendStickerParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendStickerParams) WithBusinessConnectionID(businessConnectionID string) *SendStickerParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendStickerParams) WithChatID added in v0.10.0 

func (p *SendStickerParams) WithChatID(chatID ChatID) *SendStickerParams

WithChatID adds chat ID parameter

func (*SendStickerParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendStickerParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendStickerParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendStickerParams) WithDisableNotification added in v0.10.0 

func (p *SendStickerParams) WithDisableNotification() *SendStickerParams

WithDisableNotification adds disable notification parameter

func (*SendStickerParams) WithEmoji added in v0.22.0 

func (p *SendStickerParams) WithEmoji(emoji string) *SendStickerParams

WithEmoji adds emoji parameter

func (*SendStickerParams) WithMessageEffectID added in v0.30.2 

func (p *SendStickerParams) WithMessageEffectID(messageEffectID string) *SendStickerParams

WithMessageEffectID adds message effect ID parameter

func (*SendStickerParams) WithMessageThreadID added in v0.17.1 

func (p *SendStickerParams) WithMessageThreadID(messageThreadID int) *SendStickerParams

WithMessageThreadID adds message thread ID parameter

func (*SendStickerParams) WithProtectContent added in v0.10.0 

func (p *SendStickerParams) WithProtectContent() *SendStickerParams

WithProtectContent adds protect content parameter

func (*SendStickerParams) WithReplyMarkup added in v0.10.0 

func (p *SendStickerParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendStickerParams

WithReplyMarkup adds reply markup parameter

func (*SendStickerParams) WithReplyParameters added in v0.29.0 

func (p *SendStickerParams) WithReplyParameters(replyParameters *ReplyParameters) *SendStickerParams

WithReplyParameters adds reply parameters parameter

func (*SendStickerParams) WithSticker added in v0.10.0 

func (p *SendStickerParams) WithSticker(sticker InputFile) *SendStickerParams

WithSticker adds sticker parameter

func (*SendStickerParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendStickerParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendStickerParams

WithSuggestedPostParameters adds suggested post parameters parameter

type SendVenueParams 

type SendVenueParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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"`

	// Latitude - Latitude of the venue
	Latitude float64 `json:"latitude"`

	// Longitude - Longitude of the venue
	Longitude float64 `json:"longitude"`

	// Title - Name of the venue
	Title string `json:"title"`

	// Address - Address of the venue
	Address string `json:"address"`

	// 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
	// (https://developers.google.com/places/web-service/supported_types).)
	GooglePlaceType string `json:"google_place_type,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendVenueParams - Represents parameters of sendVenue method.

func (*SendVenueParams) WithAddress added in v0.10.0 

func (p *SendVenueParams) WithAddress(address string) *SendVenueParams

WithAddress adds address parameter

func (*SendVenueParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendVenueParams) WithAllowPaidBroadcast() *SendVenueParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendVenueParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendVenueParams) WithBusinessConnectionID(businessConnectionID string) *SendVenueParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendVenueParams) WithChatID added in v0.10.0 

func (p *SendVenueParams) WithChatID(chatID ChatID) *SendVenueParams

WithChatID adds chat ID parameter

func (*SendVenueParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendVenueParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendVenueParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendVenueParams) WithDisableNotification added in v0.10.0 

func (p *SendVenueParams) WithDisableNotification() *SendVenueParams

WithDisableNotification adds disable notification parameter

func (*SendVenueParams) WithFoursquareID added in v0.10.0 

func (p *SendVenueParams) WithFoursquareID(foursquareID string) *SendVenueParams

WithFoursquareID adds foursquare ID parameter

func (*SendVenueParams) WithFoursquareType added in v0.10.0 

func (p *SendVenueParams) WithFoursquareType(foursquareType string) *SendVenueParams

WithFoursquareType adds foursquare type parameter

func (*SendVenueParams) WithGooglePlaceID added in v0.10.0 

func (p *SendVenueParams) WithGooglePlaceID(googlePlaceID string) *SendVenueParams

WithGooglePlaceID adds google place ID parameter

func (*SendVenueParams) WithGooglePlaceType added in v0.10.0 

func (p *SendVenueParams) WithGooglePlaceType(googlePlaceType string) *SendVenueParams

WithGooglePlaceType adds google place type parameter

func (*SendVenueParams) WithLatitude added in v1.1.0 

func (p *SendVenueParams) WithLatitude(latitude float64) *SendVenueParams

WithLatitude adds latitude parameter

func (*SendVenueParams) WithLongitude added in v1.1.0 

func (p *SendVenueParams) WithLongitude(longitude float64) *SendVenueParams

WithLongitude adds longitude parameter

func (*SendVenueParams) WithMessageEffectID added in v0.30.2 

func (p *SendVenueParams) WithMessageEffectID(messageEffectID string) *SendVenueParams

WithMessageEffectID adds message effect ID parameter

func (*SendVenueParams) WithMessageThreadID added in v0.17.1 

func (p *SendVenueParams) WithMessageThreadID(messageThreadID int) *SendVenueParams

WithMessageThreadID adds message thread ID parameter

func (*SendVenueParams) WithProtectContent added in v0.10.0 

func (p *SendVenueParams) WithProtectContent() *SendVenueParams

WithProtectContent adds protect content parameter

func (*SendVenueParams) WithReplyMarkup added in v0.10.0 

func (p *SendVenueParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendVenueParams

WithReplyMarkup adds reply markup parameter

func (*SendVenueParams) WithReplyParameters added in v0.29.0 

func (p *SendVenueParams) WithReplyParameters(replyParameters *ReplyParameters) *SendVenueParams

WithReplyParameters adds reply parameters parameter

func (*SendVenueParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendVenueParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendVenueParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendVenueParams) WithTitle added in v0.10.0 

func (p *SendVenueParams) WithTitle(title string) *SendVenueParams

WithTitle adds title parameter

type SendVideoNoteParams 

type SendVideoNoteParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files). Sending video notes by a URL is currently unsupported
	VideoNote InputFile `json:"video_note"`

	// 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"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,omitempty"`

	// DisableNotification - Optional. Sends the message silently
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendVideoNoteParams - Represents parameters of sendVideoNote method.

func (*SendVideoNoteParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendVideoNoteParams) WithAllowPaidBroadcast() *SendVideoNoteParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendVideoNoteParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendVideoNoteParams) WithBusinessConnectionID(businessConnectionID string) *SendVideoNoteParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendVideoNoteParams) WithChatID added in v0.10.0 

func (p *SendVideoNoteParams) WithChatID(chatID ChatID) *SendVideoNoteParams

WithChatID adds chat ID parameter

func (*SendVideoNoteParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendVideoNoteParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendVideoNoteParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendVideoNoteParams) WithDisableNotification added in v0.10.0 

func (p *SendVideoNoteParams) WithDisableNotification() *SendVideoNoteParams

WithDisableNotification adds disable notification parameter

func (*SendVideoNoteParams) WithDuration added in v0.10.0 

func (p *SendVideoNoteParams) WithDuration(duration int) *SendVideoNoteParams

WithDuration adds duration parameter

func (*SendVideoNoteParams) WithLength added in v0.10.0 

func (p *SendVideoNoteParams) WithLength(length int) *SendVideoNoteParams

WithLength adds length parameter

func (*SendVideoNoteParams) WithMessageEffectID added in v0.30.2 

func (p *SendVideoNoteParams) WithMessageEffectID(messageEffectID string) *SendVideoNoteParams

WithMessageEffectID adds message effect ID parameter

func (*SendVideoNoteParams) WithMessageThreadID added in v0.17.1 

func (p *SendVideoNoteParams) WithMessageThreadID(messageThreadID int) *SendVideoNoteParams

WithMessageThreadID adds message thread ID parameter

func (*SendVideoNoteParams) WithProtectContent added in v0.10.0 

func (p *SendVideoNoteParams) WithProtectContent() *SendVideoNoteParams

WithProtectContent adds protect content parameter

func (*SendVideoNoteParams) WithReplyMarkup added in v0.10.0 

func (p *SendVideoNoteParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendVideoNoteParams

WithReplyMarkup adds reply markup parameter

func (*SendVideoNoteParams) WithReplyParameters added in v0.29.0 

func (p *SendVideoNoteParams) WithReplyParameters(replyParameters *ReplyParameters) *SendVideoNoteParams

WithReplyParameters adds reply parameters parameter

func (*SendVideoNoteParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendVideoNoteParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendVideoNoteParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendVideoNoteParams) WithThumbnail added in v0.22.0 

func (p *SendVideoNoteParams) WithThumbnail(thumbnail *InputFile) *SendVideoNoteParams

WithThumbnail adds thumbnail parameter

func (*SendVideoNoteParams) WithVideoNote added in v0.10.0 

func (p *SendVideoNoteParams) WithVideoNote(videoNote InputFile) *SendVideoNoteParams

WithVideoNote adds video note parameter

type SendVideoParams 

type SendVideoParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Video InputFile `json:"video"`

	// 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"`

	// 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 » (https://core.telegram.org/bots/api#sending-files)
	Thumbnail *InputFile `json:"thumbnail,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 » (https://core.telegram.org/bots/api#sending-files)
	Cover *InputFile `json:"cover,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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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 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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendVideoParams - Represents parameters of sendVideo method.

func (*SendVideoParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendVideoParams) WithAllowPaidBroadcast() *SendVideoParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendVideoParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendVideoParams) WithBusinessConnectionID(businessConnectionID string) *SendVideoParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendVideoParams) WithCaption added in v0.10.0 

func (p *SendVideoParams) WithCaption(caption string) *SendVideoParams

WithCaption adds caption parameter

func (*SendVideoParams) WithCaptionEntities added in v0.10.0 

func (p *SendVideoParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendVideoParams

WithCaptionEntities adds caption entities parameter

func (*SendVideoParams) WithChatID added in v0.10.0 

func (p *SendVideoParams) WithChatID(chatID ChatID) *SendVideoParams

WithChatID adds chat ID parameter

func (*SendVideoParams) WithCover added in v1.0.2 

func (p *SendVideoParams) WithCover(cover *InputFile) *SendVideoParams

WithCover adds cover parameter

func (*SendVideoParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendVideoParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendVideoParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendVideoParams) WithDisableNotification added in v0.10.0 

func (p *SendVideoParams) WithDisableNotification() *SendVideoParams

WithDisableNotification adds disable notification parameter

func (*SendVideoParams) WithDuration added in v0.10.0 

func (p *SendVideoParams) WithDuration(duration int) *SendVideoParams

WithDuration adds duration parameter

func (*SendVideoParams) WithHasSpoiler added in v0.18.1 

func (p *SendVideoParams) WithHasSpoiler() *SendVideoParams

WithHasSpoiler adds has spoiler parameter

func (*SendVideoParams) WithHeight added in v0.10.0 

func (p *SendVideoParams) WithHeight(height int) *SendVideoParams

WithHeight adds height parameter

func (*SendVideoParams) WithMessageEffectID added in v0.30.2 

func (p *SendVideoParams) WithMessageEffectID(messageEffectID string) *SendVideoParams

WithMessageEffectID adds message effect ID parameter

func (*SendVideoParams) WithMessageThreadID added in v0.17.1 

func (p *SendVideoParams) WithMessageThreadID(messageThreadID int) *SendVideoParams

WithMessageThreadID adds message thread ID parameter

func (*SendVideoParams) WithParseMode added in v0.10.0 

func (p *SendVideoParams) WithParseMode(parseMode string) *SendVideoParams

WithParseMode adds parse mode parameter

func (*SendVideoParams) WithProtectContent added in v0.10.0 

func (p *SendVideoParams) WithProtectContent() *SendVideoParams

WithProtectContent adds protect content parameter

func (*SendVideoParams) WithReplyMarkup added in v0.10.0 

func (p *SendVideoParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendVideoParams

WithReplyMarkup adds reply markup parameter

func (*SendVideoParams) WithReplyParameters added in v0.29.0 

func (p *SendVideoParams) WithReplyParameters(replyParameters *ReplyParameters) *SendVideoParams

WithReplyParameters adds reply parameters parameter

func (*SendVideoParams) WithShowCaptionAboveMedia added in v0.30.2 

func (p *SendVideoParams) WithShowCaptionAboveMedia() *SendVideoParams

WithShowCaptionAboveMedia adds show caption above media parameter

func (*SendVideoParams) WithStartTimestamp added in v1.0.2 

func (p *SendVideoParams) WithStartTimestamp(startTimestamp int) *SendVideoParams

WithStartTimestamp adds start timestamp parameter

func (*SendVideoParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendVideoParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendVideoParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendVideoParams) WithSupportsStreaming added in v0.10.0 

func (p *SendVideoParams) WithSupportsStreaming() *SendVideoParams

WithSupportsStreaming adds supports streaming parameter

func (*SendVideoParams) WithThumbnail added in v0.22.0 

func (p *SendVideoParams) WithThumbnail(thumbnail *InputFile) *SendVideoParams

WithThumbnail adds thumbnail parameter

func (*SendVideoParams) WithVideo added in v0.10.0 

func (p *SendVideoParams) WithVideo(video InputFile) *SendVideoParams

WithVideo adds video parameter

func (*SendVideoParams) WithWidth added in v0.10.0 

func (p *SendVideoParams) WithWidth(width int) *SendVideoParams

WithWidth adds width parameter

type SendVoiceParams 

type SendVoiceParams 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 - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `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 - 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 »
	// (https://core.telegram.org/bots/api#sending-files)
	Voice InputFile `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
	// (https://core.telegram.org/bots/api#formatting-options) for more details.
	ParseMode string `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
	// (https://telegram.org/blog/channels-2-0#silent-messages). 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 (https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once) 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 - 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
	// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
	// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
	// reply from the user
	ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}

SendVoiceParams - Represents parameters of sendVoice method.

func (*SendVoiceParams) WithAllowPaidBroadcast added in v0.32.0 

func (p *SendVoiceParams) WithAllowPaidBroadcast() *SendVoiceParams

WithAllowPaidBroadcast adds allow paid broadcast parameter

func (*SendVoiceParams) WithBusinessConnectionID added in v0.29.2 

func (p *SendVoiceParams) WithBusinessConnectionID(businessConnectionID string) *SendVoiceParams

WithBusinessConnectionID adds business connection ID parameter

func (*SendVoiceParams) WithCaption added in v0.10.0 

func (p *SendVoiceParams) WithCaption(caption string) *SendVoiceParams

WithCaption adds caption parameter

func (*SendVoiceParams) WithCaptionEntities added in v0.10.0 

func (p *SendVoiceParams) WithCaptionEntities(captionEntities ...MessageEntity) *SendVoiceParams

WithCaptionEntities adds caption entities parameter

func (*SendVoiceParams) WithChatID added in v0.10.0 

func (p *SendVoiceParams) WithChatID(chatID ChatID) *SendVoiceParams

WithChatID adds chat ID parameter

func (*SendVoiceParams) WithDirectMessagesTopicID added in v1.3.0 

func (p *SendVoiceParams) WithDirectMessagesTopicID(directMessagesTopicID int) *SendVoiceParams

WithDirectMessagesTopicID adds direct messages topic ID parameter

func (*SendVoiceParams) WithDisableNotification added in v0.10.0 

func (p *SendVoiceParams) WithDisableNotification() *SendVoiceParams

WithDisableNotification adds disable notification parameter

func (*SendVoiceParams) WithDuration added in v0.10.0 

func (p *SendVoiceParams) WithDuration(duration int) *SendVoiceParams

WithDuration adds duration parameter

func (*SendVoiceParams) WithMessageEffectID added in v0.30.2 

func (p *SendVoiceParams) WithMessageEffectID(messageEffectID string) *SendVoiceParams

WithMessageEffectID adds message effect ID parameter

func (*SendVoiceParams) WithMessageThreadID added in v0.17.1 

func (p *SendVoiceParams) WithMessageThreadID(messageThreadID int) *SendVoiceParams

WithMessageThreadID adds message thread ID parameter

func (*SendVoiceParams) WithParseMode added in v0.10.0 

func (p *SendVoiceParams) WithParseMode(parseMode string) *SendVoiceParams

WithParseMode adds parse mode parameter

func (*SendVoiceParams) WithProtectContent added in v0.10.0 

func (p *SendVoiceParams) WithProtectContent() *SendVoiceParams

WithProtectContent adds protect content parameter

func (*SendVoiceParams) WithReplyMarkup added in v0.10.0 

func (p *SendVoiceParams) WithReplyMarkup(replyMarkup ReplyMarkup) *SendVoiceParams

WithReplyMarkup adds reply markup parameter

func (*SendVoiceParams) WithReplyParameters added in v0.29.0 

func (p *SendVoiceParams) WithReplyParameters(replyParameters *ReplyParameters) *SendVoiceParams

WithReplyParameters adds reply parameters parameter

func (*SendVoiceParams) WithSuggestedPostParameters added in v1.3.0 

func (p *SendVoiceParams) WithSuggestedPostParameters(suggestedPostParameters *SuggestedPostParameters,
) *SendVoiceParams

WithSuggestedPostParameters adds suggested post parameters parameter

func (*SendVoiceParams) WithVoice added in v0.10.0 

func (p *SendVoiceParams) WithVoice(voice InputFile) *SendVoiceParams

WithVoice adds voice parameter

type SentWebAppMessage added in v0.11.0 

type SentWebAppMessage struct {
	// InlineMessageID - Optional. Identifier of the sent inline message. Available only if there is an inline
	// keyboard (https://core.telegram.org/bots/api#inlinekeyboardmarkup) attached to the message.
	InlineMessageID string `json:"inline_message_id,omitempty"`
}

SentWebAppMessage - Describes an inline message sent by a Web App (https://core.telegram.org/bots/webapps) on behalf of a user.

type SetBusinessAccountBioParams added in v1.1.0 

type SetBusinessAccountBioParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Bio - Optional. The new value of the bio for the business account; 0-140 characters
	Bio string `json:"bio,omitempty"`
}

SetBusinessAccountBioParams - Represents parameters of setBusinessAccountBio method.

func (*SetBusinessAccountBioParams) WithBio added in v1.1.0 

func (p *SetBusinessAccountBioParams) WithBio(bio string) *SetBusinessAccountBioParams

WithBio adds bio parameter

func (*SetBusinessAccountBioParams) WithBusinessConnectionID added in v1.1.0 

func (p *SetBusinessAccountBioParams) WithBusinessConnectionID(businessConnectionID string,
) *SetBusinessAccountBioParams

WithBusinessConnectionID adds business connection ID parameter

type SetBusinessAccountGiftSettingsParams added in v1.1.0 

type SetBusinessAccountGiftSettingsParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// ShowGiftButton - 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 - Types of gifts accepted by the business account
	AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
}

SetBusinessAccountGiftSettingsParams - Represents parameters of setBusinessAccountGiftSettings method.

func (*SetBusinessAccountGiftSettingsParams) WithAcceptedGiftTypes added in v1.1.0 

func (p *SetBusinessAccountGiftSettingsParams) WithAcceptedGiftTypes(acceptedGiftTypes AcceptedGiftTypes,
) *SetBusinessAccountGiftSettingsParams

WithAcceptedGiftTypes adds accepted gift types parameter

func (*SetBusinessAccountGiftSettingsParams) WithBusinessConnectionID added in v1.1.0 

func (p *SetBusinessAccountGiftSettingsParams) WithBusinessConnectionID(businessConnectionID string,
) *SetBusinessAccountGiftSettingsParams

WithBusinessConnectionID adds business connection ID parameter

func (*SetBusinessAccountGiftSettingsParams) WithShowGiftButton added in v1.1.0 

func (p *SetBusinessAccountGiftSettingsParams) WithShowGiftButton() *SetBusinessAccountGiftSettingsParams

WithShowGiftButton adds show gift button parameter

type SetBusinessAccountNameParams added in v1.1.0 

type SetBusinessAccountNameParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// FirstName - 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"`
}

SetBusinessAccountNameParams - Represents parameters of setBusinessAccountName method.

func (*SetBusinessAccountNameParams) WithBusinessConnectionID added in v1.1.0 

func (p *SetBusinessAccountNameParams) WithBusinessConnectionID(businessConnectionID string,
) *SetBusinessAccountNameParams

WithBusinessConnectionID adds business connection ID parameter

func (*SetBusinessAccountNameParams) WithFirstName added in v1.1.0 

func (p *SetBusinessAccountNameParams) WithFirstName(firstName string) *SetBusinessAccountNameParams

WithFirstName adds first name parameter

func (*SetBusinessAccountNameParams) WithLastName added in v1.1.0 

func (p *SetBusinessAccountNameParams) WithLastName(lastName string) *SetBusinessAccountNameParams

WithLastName adds last name parameter

type SetBusinessAccountProfilePhotoParams added in v1.1.0 

type SetBusinessAccountProfilePhotoParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Photo - The new profile photo to set
	Photo InputProfilePhoto `json:"photo"`

	// 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"`
}

SetBusinessAccountProfilePhotoParams - Represents parameters of setBusinessAccountProfilePhoto method.

func (*SetBusinessAccountProfilePhotoParams) WithBusinessConnectionID added in v1.1.0 

func (p *SetBusinessAccountProfilePhotoParams) WithBusinessConnectionID(businessConnectionID string,
) *SetBusinessAccountProfilePhotoParams

WithBusinessConnectionID adds business connection ID parameter

func (*SetBusinessAccountProfilePhotoParams) WithIsPublic added in v1.1.0 

func (p *SetBusinessAccountProfilePhotoParams) WithIsPublic() *SetBusinessAccountProfilePhotoParams

WithIsPublic adds is public parameter

func (*SetBusinessAccountProfilePhotoParams) WithPhoto added in v1.1.0 

func (p *SetBusinessAccountProfilePhotoParams) WithPhoto(photo InputProfilePhoto,
) *SetBusinessAccountProfilePhotoParams

WithPhoto adds photo parameter

type SetBusinessAccountUsernameParams added in v1.1.0 

type SetBusinessAccountUsernameParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// Username - Optional. The new value of the username for the business account; 0-32 characters
	Username string `json:"username,omitempty"`
}

SetBusinessAccountUsernameParams - Represents parameters of setBusinessAccountUsername method.

func (*SetBusinessAccountUsernameParams) WithBusinessConnectionID added in v1.1.0 

func (p *SetBusinessAccountUsernameParams) WithBusinessConnectionID(businessConnectionID string,
) *SetBusinessAccountUsernameParams

WithBusinessConnectionID adds business connection ID parameter

func (*SetBusinessAccountUsernameParams) WithUsername added in v1.1.0 

func (p *SetBusinessAccountUsernameParams) WithUsername(username string) *SetBusinessAccountUsernameParams

WithUsername adds username parameter

type SetChatAdministratorCustomTitleParams 

type SetChatAdministratorCustomTitleParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// CustomTitle - New custom title for the administrator; 0-16 characters, emoji are not allowed
	CustomTitle string `json:"custom_title"`
}

SetChatAdministratorCustomTitleParams - Represents parameters of setChatAdministratorCustomTitle method.

func (*SetChatAdministratorCustomTitleParams) WithChatID added in v0.10.0 

func (p *SetChatAdministratorCustomTitleParams) WithChatID(chatID ChatID) *SetChatAdministratorCustomTitleParams

WithChatID adds chat ID parameter

func (*SetChatAdministratorCustomTitleParams) WithCustomTitle added in v0.10.0 

func (p *SetChatAdministratorCustomTitleParams) WithCustomTitle(customTitle string,
) *SetChatAdministratorCustomTitleParams

WithCustomTitle adds custom title parameter

func (*SetChatAdministratorCustomTitleParams) WithUserID added in v1.1.0 

func (p *SetChatAdministratorCustomTitleParams) WithUserID(userID int64) *SetChatAdministratorCustomTitleParams

WithUserID adds user ID parameter

type SetChatDescriptionParams 

type SetChatDescriptionParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// Description - Optional. New chat description, 0-255 characters
	Description string `json:"description,omitempty"`
}

SetChatDescriptionParams - Represents parameters of setChatDescription method.

func (*SetChatDescriptionParams) WithChatID added in v0.10.0 

func (p *SetChatDescriptionParams) WithChatID(chatID ChatID) *SetChatDescriptionParams

WithChatID adds chat ID parameter

func (*SetChatDescriptionParams) WithDescription added in v0.10.0 

func (p *SetChatDescriptionParams) WithDescription(description string) *SetChatDescriptionParams

WithDescription adds description parameter

type SetChatMenuButtonParams added in v0.11.0 

type SetChatMenuButtonParams struct {
	// ChatID - Optional. Unique identifier for the target private chat. If not specified, default bot's 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 (https://core.telegram.org/bots/api#menubuttondefault)
	MenuButton MenuButton `json:"menu_button,omitempty"`
}

SetChatMenuButtonParams - Represents parameters of setChatMenuButton method.

func (*SetChatMenuButtonParams) WithChatID added in v1.1.0 

func (p *SetChatMenuButtonParams) WithChatID(chatID int64) *SetChatMenuButtonParams

WithChatID adds chat ID parameter

func (*SetChatMenuButtonParams) WithMenuButton added in v0.11.0 

func (p *SetChatMenuButtonParams) WithMenuButton(menuButton MenuButton) *SetChatMenuButtonParams

WithMenuButton adds menu button parameter

type SetChatPermissionsParams 

type SetChatPermissionsParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// Permissions - A JSON-serialized object for new default chat permissions
	Permissions ChatPermissions `json:"permissions"`

	// UseIndependentChatPermissions - Optional. Pass True if chat permissions are set independently. Otherwise,
	// the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages,
	// can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and
	// can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
	UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
}

SetChatPermissionsParams - Represents parameters of setChatPermissions method.

func (*SetChatPermissionsParams) WithChatID added in v0.10.0 

func (p *SetChatPermissionsParams) WithChatID(chatID ChatID) *SetChatPermissionsParams

WithChatID adds chat ID parameter

func (*SetChatPermissionsParams) WithPermissions added in v0.10.0 

func (p *SetChatPermissionsParams) WithPermissions(permissions ChatPermissions) *SetChatPermissionsParams

WithPermissions adds permissions parameter

func (*SetChatPermissionsParams) WithUseIndependentChatPermissions added in v0.20.1 

func (p *SetChatPermissionsParams) WithUseIndependentChatPermissions() *SetChatPermissionsParams

WithUseIndependentChatPermissions adds use independent chat permissions parameter

type SetChatPhotoParams 

type SetChatPhotoParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// Photo - New chat photo, uploaded using multipart/form-data
	Photo InputFile `json:"photo"`
}

SetChatPhotoParams - Represents parameters of setChatPhoto method.

func (*SetChatPhotoParams) WithChatID added in v0.10.0 

func (p *SetChatPhotoParams) WithChatID(chatID ChatID) *SetChatPhotoParams

WithChatID adds chat ID parameter

func (*SetChatPhotoParams) WithPhoto added in v0.10.0 

func (p *SetChatPhotoParams) WithPhoto(photo InputFile) *SetChatPhotoParams

WithPhoto adds photo parameter

type SetChatStickerSetParams 

type SetChatStickerSetParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// StickerSetName - Name of the sticker set to be set as the group sticker set
	StickerSetName string `json:"sticker_set_name"`
}

SetChatStickerSetParams - Represents parameters of setChatStickerSet method.

func (*SetChatStickerSetParams) WithChatID added in v0.10.0 

func (p *SetChatStickerSetParams) WithChatID(chatID ChatID) *SetChatStickerSetParams

WithChatID adds chat ID parameter

func (*SetChatStickerSetParams) WithStickerSetName added in v0.10.0 

func (p *SetChatStickerSetParams) WithStickerSetName(stickerSetName string) *SetChatStickerSetParams

WithStickerSetName adds sticker set name parameter

type SetChatTitleParams 

type SetChatTitleParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// Title - New chat title, 1-128 characters
	Title string `json:"title"`
}

SetChatTitleParams - Represents parameters of setChatTitle method.

func (*SetChatTitleParams) WithChatID added in v0.10.0 

func (p *SetChatTitleParams) WithChatID(chatID ChatID) *SetChatTitleParams

WithChatID adds chat ID parameter

func (*SetChatTitleParams) WithTitle added in v0.10.0 

func (p *SetChatTitleParams) WithTitle(title string) *SetChatTitleParams

WithTitle adds title parameter

type SetCustomEmojiStickerSetThumbnailParams added in v0.22.0 

type SetCustomEmojiStickerSetThumbnailParams struct {
	// Name - 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"`
}

SetCustomEmojiStickerSetThumbnailParams - Represents parameters of setCustomEmojiStickerSetThumbnail method.

func (*SetCustomEmojiStickerSetThumbnailParams) WithCustomEmojiID added in v0.22.0 

func (p *SetCustomEmojiStickerSetThumbnailParams) WithCustomEmojiID(customEmojiID string,
) *SetCustomEmojiStickerSetThumbnailParams

WithCustomEmojiID adds custom emoji ID parameter

func (*SetCustomEmojiStickerSetThumbnailParams) WithName added in v0.22.0 

func (p *SetCustomEmojiStickerSetThumbnailParams) WithName(name string) *SetCustomEmojiStickerSetThumbnailParams

WithName adds name parameter

type SetGameScoreParams 

type SetGameScoreParams struct {
	// UserID - User identifier
	UserID int64 `json:"user_id"`

	// Score - 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"`
}

SetGameScoreParams - Represents parameters of setGameScore method.

func (*SetGameScoreParams) WithChatID added in v1.1.0 

func (p *SetGameScoreParams) WithChatID(chatID int64) *SetGameScoreParams

WithChatID adds chat ID parameter

func (*SetGameScoreParams) WithDisableEditMessage added in v0.10.0 

func (p *SetGameScoreParams) WithDisableEditMessage() *SetGameScoreParams

WithDisableEditMessage adds disable edit message parameter

func (*SetGameScoreParams) WithForce added in v0.10.0 

func (p *SetGameScoreParams) WithForce() *SetGameScoreParams

WithForce adds force parameter

func (*SetGameScoreParams) WithInlineMessageID added in v0.10.0 

func (p *SetGameScoreParams) WithInlineMessageID(inlineMessageID string) *SetGameScoreParams

WithInlineMessageID adds inline message ID parameter

func (*SetGameScoreParams) WithMessageID added in v0.10.0 

func (p *SetGameScoreParams) WithMessageID(messageID int) *SetGameScoreParams

WithMessageID adds message ID parameter

func (*SetGameScoreParams) WithScore added in v0.10.0 

func (p *SetGameScoreParams) WithScore(score int) *SetGameScoreParams

WithScore adds score parameter

func (*SetGameScoreParams) WithUserID added in v1.1.0 

func (p *SetGameScoreParams) WithUserID(userID int64) *SetGameScoreParams

WithUserID adds user ID parameter

type SetMessageReactionParams added in v0.29.0 

type SetMessageReactionParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageID - Identifier of the target message. If the message belongs to a media group, the reaction is
	// set to the first non-deleted message in the group instead.
	MessageID int `json:"message_id"`

	// Reaction - Optional. A JSON-serialized list of reaction types to set on the message. Currently, as
	// non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is
	// either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be
	// used by bots.
	Reaction []ReactionType `json:"reaction,omitempty"`

	// IsBig - Optional. Pass True to set the reaction with a big animation
	IsBig bool `json:"is_big,omitempty"`
}

SetMessageReactionParams - Represents parameters of setMessageReaction method.

func (*SetMessageReactionParams) WithChatID added in v0.29.0 

func (p *SetMessageReactionParams) WithChatID(chatID ChatID) *SetMessageReactionParams

WithChatID adds chat ID parameter

func (*SetMessageReactionParams) WithIsBig added in v0.29.0 

func (p *SetMessageReactionParams) WithIsBig() *SetMessageReactionParams

WithIsBig adds is big parameter

func (*SetMessageReactionParams) WithMessageID added in v0.29.0 

func (p *SetMessageReactionParams) WithMessageID(messageID int) *SetMessageReactionParams

WithMessageID adds message ID parameter

func (*SetMessageReactionParams) WithReaction added in v0.29.0 

func (p *SetMessageReactionParams) WithReaction(reaction ...ReactionType) *SetMessageReactionParams

WithReaction adds reaction parameter

type SetMyCommandsParams 

type SetMyCommandsParams struct {
	// Commands - 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 (https://core.telegram.org/bots/api#botcommandscopedefault).
	Scope BotCommandScope `json:"scope,omitempty"`

	// LanguageCode - 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
	LanguageCode string `json:"language_code,omitempty"`
}

SetMyCommandsParams - Represents parameters of setMyCommands method.

func (*SetMyCommandsParams) WithCommands added in v0.10.0 

func (p *SetMyCommandsParams) WithCommands(commands ...BotCommand) *SetMyCommandsParams

WithCommands adds commands parameter

func (*SetMyCommandsParams) WithLanguageCode added in v0.10.0 

func (p *SetMyCommandsParams) WithLanguageCode(languageCode string) *SetMyCommandsParams

WithLanguageCode adds language code parameter

func (*SetMyCommandsParams) WithScope added in v0.10.0 

func (p *SetMyCommandsParams) WithScope(scope BotCommandScope) *SetMyCommandsParams

WithScope adds scope parameter

type SetMyDefaultAdministratorRightsParams added in v0.11.0 

type SetMyDefaultAdministratorRightsParams struct {
	// Rights - Optional. A JSON-serialized object describing new default administrator rights. If not
	// specified, the default administrator rights will be cleared.
	Rights *ChatAdministratorRights `json:"rights,omitempty"`

	// 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,omitempty"`
}

SetMyDefaultAdministratorRightsParams - Represents parameters of setMyDefaultAdministratorRights method.

func (*SetMyDefaultAdministratorRightsParams) WithForChannels added in v0.11.0 

func (p *SetMyDefaultAdministratorRightsParams) WithForChannels() *SetMyDefaultAdministratorRightsParams

WithForChannels adds for channels parameter

func (*SetMyDefaultAdministratorRightsParams) WithRights added in v0.11.0 

func (p *SetMyDefaultAdministratorRightsParams) WithRights(rights *ChatAdministratorRights,
) *SetMyDefaultAdministratorRightsParams

WithRights adds rights parameter

type SetMyDescriptionParams added in v0.22.0 

type SetMyDescriptionParams 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,omitempty"`

	// LanguageCode - 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.
	LanguageCode string `json:"language_code,omitempty"`
}

SetMyDescriptionParams - Represents parameters of setMyDescription method.

func (*SetMyDescriptionParams) WithDescription added in v0.22.0 

func (p *SetMyDescriptionParams) WithDescription(description string) *SetMyDescriptionParams

WithDescription adds description parameter

func (*SetMyDescriptionParams) WithLanguageCode added in v0.22.0 

func (p *SetMyDescriptionParams) WithLanguageCode(languageCode string) *SetMyDescriptionParams

WithLanguageCode adds language code parameter

type SetMyNameParams added in v0.22.1 

type SetMyNameParams struct {
	// Name - Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the
	// given language.
	Name string `json:"name,omitempty"`

	// LanguageCode - 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.
	LanguageCode string `json:"language_code,omitempty"`
}

SetMyNameParams - Represents parameters of setMyName method.

func (*SetMyNameParams) WithLanguageCode added in v0.22.1 

func (p *SetMyNameParams) WithLanguageCode(languageCode string) *SetMyNameParams

WithLanguageCode adds language code parameter

func (*SetMyNameParams) WithName added in v0.22.1 

func (p *SetMyNameParams) WithName(name string) *SetMyNameParams

WithName adds name parameter

type SetMyShortDescriptionParams added in v0.22.0 

type SetMyShortDescriptionParams 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"`

	// LanguageCode - 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.
	LanguageCode string `json:"language_code,omitempty"`
}

SetMyShortDescriptionParams - Represents parameters of setMyShortDescription method.

func (*SetMyShortDescriptionParams) WithLanguageCode added in v0.22.0 

func (p *SetMyShortDescriptionParams) WithLanguageCode(languageCode string) *SetMyShortDescriptionParams

WithLanguageCode adds language code parameter

func (*SetMyShortDescriptionParams) WithShortDescription added in v0.22.0 

func (p *SetMyShortDescriptionParams) WithShortDescription(shortDescription string) *SetMyShortDescriptionParams

WithShortDescription adds short description parameter

type SetPassportDataErrorsParams 

type SetPassportDataErrorsParams struct {
	// UserID - User identifier
	UserID int64 `json:"user_id"`

	// Errors - A JSON-serialized array describing the errors
	Errors []PassportElementError `json:"errors"`
}

SetPassportDataErrorsParams - Represents parameters of setPassportDataErrors method.

func (*SetPassportDataErrorsParams) WithErrors added in v0.10.0 

func (p *SetPassportDataErrorsParams) WithErrors(errors ...PassportElementError) *SetPassportDataErrorsParams

WithErrors adds errors parameter

func (*SetPassportDataErrorsParams) WithUserID added in v1.1.0 

func (p *SetPassportDataErrorsParams) WithUserID(userID int64) *SetPassportDataErrorsParams

WithUserID adds user ID parameter

type SetStickerEmojiListParams added in v0.22.0 

type SetStickerEmojiListParams struct {
	// Sticker - File identifier of the sticker
	Sticker string `json:"sticker"`

	// EmojiList - A JSON-serialized list of 1-20 emoji associated with the sticker
	EmojiList []string `json:"emoji_list"`
}

SetStickerEmojiListParams - Represents parameters of setStickerEmojiList method.

func (*SetStickerEmojiListParams) WithEmojiList added in v0.22.0 

func (p *SetStickerEmojiListParams) WithEmojiList(emojiList ...string) *SetStickerEmojiListParams

WithEmojiList adds emoji list parameter

func (*SetStickerEmojiListParams) WithSticker added in v0.22.0 

func (p *SetStickerEmojiListParams) WithSticker(sticker string) *SetStickerEmojiListParams

WithSticker adds sticker parameter

type SetStickerKeywordsParams added in v0.22.0 

type SetStickerKeywordsParams struct {
	// Sticker - 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,omitempty"`
}

SetStickerKeywordsParams - Represents parameters of setStickerKeywords method.

func (*SetStickerKeywordsParams) WithKeywords added in v0.22.0 

func (p *SetStickerKeywordsParams) WithKeywords(keywords ...string) *SetStickerKeywordsParams

WithKeywords adds keywords parameter

func (*SetStickerKeywordsParams) WithSticker added in v0.22.0 

func (p *SetStickerKeywordsParams) WithSticker(sticker string) *SetStickerKeywordsParams

WithSticker adds sticker parameter

type SetStickerMaskPositionParams added in v0.22.0 

type SetStickerMaskPositionParams struct {
	// Sticker - 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"`
}

SetStickerMaskPositionParams - Represents parameters of setStickerMaskPosition method.

func (*SetStickerMaskPositionParams) WithMaskPosition added in v0.22.0 

func (p *SetStickerMaskPositionParams) WithMaskPosition(maskPosition *MaskPosition) *SetStickerMaskPositionParams

WithMaskPosition adds mask position parameter

func (*SetStickerMaskPositionParams) WithSticker added in v0.22.0 

func (p *SetStickerMaskPositionParams) WithSticker(sticker string) *SetStickerMaskPositionParams

WithSticker adds sticker parameter

type SetStickerPositionInSetParams 

type SetStickerPositionInSetParams struct {
	// Sticker - File identifier of the sticker
	Sticker string `json:"sticker"`

	// Position - New sticker position in the set, zero-based
	Position int `json:"position"`
}

SetStickerPositionInSetParams - Represents parameters of setStickerPositionInSet method.

func (*SetStickerPositionInSetParams) WithPosition added in v0.10.0 

func (p *SetStickerPositionInSetParams) WithPosition(position int) *SetStickerPositionInSetParams

WithPosition adds position parameter

func (*SetStickerPositionInSetParams) WithSticker added in v0.10.0 

func (p *SetStickerPositionInSetParams) WithSticker(sticker string) *SetStickerPositionInSetParams

WithSticker adds sticker parameter

type SetStickerSetThumbnailParams added in v0.22.0 

type SetStickerSetThumbnailParams struct {
	// Name - Sticker set name
	Name string `json:"name"`

	// UserID - 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
	// (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 (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 »
	// (https://core.telegram.org/bots/api#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 *InputFile `json:"thumbnail,omitempty"`

	// Format - 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 string `json:"format"`
}

SetStickerSetThumbnailParams - Represents parameters of setStickerSetThumbnail method.

func (*SetStickerSetThumbnailParams) WithFormat added in v0.29.2 

func (p *SetStickerSetThumbnailParams) WithFormat(format string) *SetStickerSetThumbnailParams

WithFormat adds format parameter

func (*SetStickerSetThumbnailParams) WithName added in v0.22.0 

func (p *SetStickerSetThumbnailParams) WithName(name string) *SetStickerSetThumbnailParams

WithName adds name parameter

func (*SetStickerSetThumbnailParams) WithThumbnail added in v0.22.0 

func (p *SetStickerSetThumbnailParams) WithThumbnail(thumbnail *InputFile) *SetStickerSetThumbnailParams

WithThumbnail adds thumbnail parameter

func (*SetStickerSetThumbnailParams) WithUserID added in v1.1.0 

func (p *SetStickerSetThumbnailParams) WithUserID(userID int64) *SetStickerSetThumbnailParams

WithUserID adds user ID parameter

type SetStickerSetTitleParams added in v0.22.0 

type SetStickerSetTitleParams struct {
	// Name - Sticker set name
	Name string `json:"name"`

	// Title - Sticker set title, 1-64 characters
	Title string `json:"title"`
}

SetStickerSetTitleParams - Represents parameters of setStickerSetTitle method.

func (*SetStickerSetTitleParams) WithName added in v0.22.0 

func (p *SetStickerSetTitleParams) WithName(name string) *SetStickerSetTitleParams

WithName adds name parameter

func (*SetStickerSetTitleParams) WithTitle added in v0.22.0 

func (p *SetStickerSetTitleParams) WithTitle(title string) *SetStickerSetTitleParams

WithTitle adds title parameter

type SetUserEmojiStatusParams added in v0.32.0 

type SetUserEmojiStatusParams struct {
	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// EmojiStatusCustomEmojiID - Optional. Custom emoji identifier of the emoji status to set. Pass an empty
	// string to remove the status.
	EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`

	// EmojiStatusExpirationDate - Optional. Expiration date of the emoji status, if any
	EmojiStatusExpirationDate int64 `json:"emoji_status_expiration_date,omitempty"`
}

SetUserEmojiStatusParams - Represents parameters of setUserEmojiStatus method.

func (*SetUserEmojiStatusParams) WithEmojiStatusCustomEmojiID added in v0.32.0 

func (p *SetUserEmojiStatusParams) WithEmojiStatusCustomEmojiID(emojiStatusCustomEmojiID string,
) *SetUserEmojiStatusParams

WithEmojiStatusCustomEmojiID adds emoji status custom emoji ID parameter

func (*SetUserEmojiStatusParams) WithEmojiStatusExpirationDate added in v1.1.0 

func (p *SetUserEmojiStatusParams) WithEmojiStatusExpirationDate(emojiStatusExpirationDate int64,
) *SetUserEmojiStatusParams

WithEmojiStatusExpirationDate adds emoji status expiration date parameter

func (*SetUserEmojiStatusParams) WithUserID added in v1.1.0 

func (p *SetUserEmojiStatusParams) WithUserID(userID int64) *SetUserEmojiStatusParams

WithUserID adds user ID parameter

type SetWebhookParams 

type SetWebhookParams struct {
	// URL - HTTPS URL to send updates to. Use an empty string to remove webhook integration
	URL string `json:"url"`

	// Certificate - Optional. Upload your public key certificate so that the root certificate in use can be
	// checked. See our self-signed guide (https://core.telegram.org/bots/self-signed) for details.
	// Please upload as File, sending a FileID or URL will not work.
	Certificate *InputFile `json:"certificate,omitempty"`

	// 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 int `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 (https://core.telegram.org/bots/api#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 []string `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"`
}

SetWebhookParams - Represents parameters of setWebhook method.

func (*SetWebhookParams) WithAllowedUpdates added in v0.10.0 

func (p *SetWebhookParams) WithAllowedUpdates(allowedUpdates ...string) *SetWebhookParams

WithAllowedUpdates adds allowed updates parameter

func (*SetWebhookParams) WithCertificate added in v0.10.0 

func (p *SetWebhookParams) WithCertificate(certificate *InputFile) *SetWebhookParams

WithCertificate adds certificate parameter

func (*SetWebhookParams) WithDropPendingUpdates added in v0.10.0 

func (p *SetWebhookParams) WithDropPendingUpdates() *SetWebhookParams

WithDropPendingUpdates adds drop pending updates parameter

func (*SetWebhookParams) WithIPAddress added in v0.10.0 

func (p *SetWebhookParams) WithIPAddress(ipAddress string) *SetWebhookParams

WithIPAddress adds ip address parameter

func (*SetWebhookParams) WithMaxConnections added in v0.10.0 

func (p *SetWebhookParams) WithMaxConnections(maxConnections int) *SetWebhookParams

WithMaxConnections adds max connections parameter

func (*SetWebhookParams) WithSecretToken added in v0.13.1 

func (p *SetWebhookParams) WithSecretToken(secretToken string) *SetWebhookParams

WithSecretToken adds secret token parameter

func (*SetWebhookParams) WithURL added in v0.10.0 

func (p *SetWebhookParams) WithURL(url string) *SetWebhookParams

WithURL adds URL parameter

type SharedUser added in v0.29.2 

type SharedUser struct {
	// UserID - Identifier of the shared user. 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 64-bit integers or double-precision float types are safe for storing these identifiers.
	// The bot may not have access to the user and could be unable to use this identifier, unless the user is
	// already known to the bot by some other means.
	UserID int64 `json:"user_id"`

	// FirstName - Optional. First name of the user, if the name was requested by the bot
	FirstName string `json:"first_name,omitempty"`

	// LastName - Optional. Last name of the user, if the name was requested by the bot
	LastName string `json:"last_name,omitempty"`

	// Username - Optional. Username of the user, if the username was requested by the bot
	Username string `json:"username,omitempty"`

	// Photo - Optional. Available sizes of the chat photo, if the photo was requested by the bot
	Photo []PhotoSize `json:"photo,omitempty"`
}

SharedUser - This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers (https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.

type ShippingAddress 

type ShippingAddress struct {
	// CountryCode - Two-letter ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country
	// code
	CountryCode string `json:"country_code"`

	// 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 - Address post code
	PostCode string `json:"post_code"`
}

ShippingAddress - This object represents a shipping address.

type ShippingOption 

type ShippingOption struct {
	// ID - Shipping option identifier
	ID string `json:"id"`

	// Title - Option title
	Title string `json:"title"`

	// Prices - List of price portions
	Prices []LabeledPrice `json:"prices"`
}

ShippingOption - This object represents one shipping option.

type ShippingQuery 

type ShippingQuery struct {
	// 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"`
}

ShippingQuery - This object contains information about an incoming shipping query.

type StarAmount added in v1.1.0 

type StarAmount struct {
	// Amount - Integer amount of Telegram Stars, rounded to 0; can be negative
	Amount int `json:"amount"`

	// NanostarAmount - Optional. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to
	// 999999999; can be negative if and only if amount is non-positive
	NanostarAmount int `json:"nanostar_amount,omitempty"`
}

StarAmount - Describes an amount of Telegram Stars.

type StarTransaction added in v0.31.0 

type StarTransaction struct {
	// ID - Unique identifier of the transaction. Coincides with the identifier of the original transaction for
	// refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming
	// payments from users.
	ID string `json:"id"`

	// 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 int64 `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 TransactionPartner `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 TransactionPartner `json:"receiver,omitempty"`
}

StarTransaction - Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

func (*StarTransaction) UnmarshalJSON added in v0.31.0 

func (t *StarTransaction) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to Chat

type StarTransactions added in v0.31.0 

type StarTransactions struct {
	// Transactions - The list of transactions
	Transactions []StarTransaction `json:"transactions"`
}

StarTransactions - Contains a list of Telegram Star transactions.

type Sticker 

type Sticker struct {
	// 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"`

	// 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 string `json:"type"`

	// Width - Sticker width
	Width int `json:"width"`

	// Height - Sticker height
	Height int `json:"height"`

	// IsAnimated - True, if the sticker is animated (https://telegram.org/blog/animated-stickers)
	IsAnimated bool `json:"is_animated"`

	// IsVideo - True, if the sticker is a video sticker
	// (https://telegram.org/blog/video-stickers-better-reactions)
	IsVideo bool `json:"is_video"`

	// Thumbnail - Optional. Sticker thumbnail in the .WEBP or .JPG format
	Thumbnail *PhotoSize `json:"thumbnail,omitempty"`

	// 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"`

	// PremiumAnimation - Optional. For premium regular stickers, premium animation for the sticker
	PremiumAnimation *File `json:"premium_animation,omitempty"`

	// MaskPosition - Optional. For mask stickers, the position where the mask should be placed
	MaskPosition *MaskPosition `json:"mask_position,omitempty"`

	// CustomEmojiID - Optional. For custom emoji stickers, unique identifier of the custom emoji
	CustomEmojiID string `json:"custom_emoji_id,omitempty"`

	// NeedsRepainting - Optional. True, if the sticker must be repainted to a text color in messages, the color
	// of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in
	// other places
	NeedsRepainting bool `json:"needs_repainting,omitempty"`

	// FileSize - Optional. File size in bytes
	FileSize int `json:"file_size,omitempty"`
}

Sticker - This object represents a sticker.

type StickerSet 

type StickerSet struct {
	// 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 string `json:"sticker_type"`

	// 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"`
}

StickerSet - This object represents a sticker set.

type StopMessageLiveLocationParams 

type StopMessageLiveLocationParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Optional. Required if inline_message_id is not specified. Unique identifier for the target chat
	// or username of the target channel (in the format @channel_username)
	ChatID ChatID `json:"chat_id,omitzero"`

	// MessageID - Optional. Required if inline_message_id is not specified. Identifier of the message with live
	// location to stop
	MessageID int `json:"message_id,omitempty"`

	// InlineMessageID - Optional. Required if chat_id and message_id are not specified. Identifier of the
	// inline message
	InlineMessageID string `json:"inline_message_id,omitempty"`

	// ReplyMarkup - Optional. A JSON-serialized object for a new inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

StopMessageLiveLocationParams - Represents parameters of stopMessageLiveLocation method.

func (*StopMessageLiveLocationParams) WithBusinessConnectionID added in v0.31.0 

func (p *StopMessageLiveLocationParams) WithBusinessConnectionID(businessConnectionID string,
) *StopMessageLiveLocationParams

WithBusinessConnectionID adds business connection ID parameter

func (*StopMessageLiveLocationParams) WithChatID added in v0.10.0 

func (p *StopMessageLiveLocationParams) WithChatID(chatID ChatID) *StopMessageLiveLocationParams

WithChatID adds chat ID parameter

func (*StopMessageLiveLocationParams) WithInlineMessageID added in v0.10.0 

func (p *StopMessageLiveLocationParams) WithInlineMessageID(inlineMessageID string) *StopMessageLiveLocationParams

WithInlineMessageID adds inline message ID parameter

func (*StopMessageLiveLocationParams) WithMessageID added in v0.10.0 

func (p *StopMessageLiveLocationParams) WithMessageID(messageID int) *StopMessageLiveLocationParams

WithMessageID adds message ID parameter

func (*StopMessageLiveLocationParams) WithReplyMarkup added in v0.10.0 

func (p *StopMessageLiveLocationParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup,
) *StopMessageLiveLocationParams

WithReplyMarkup adds reply markup parameter

type StopPollParams 

type StopPollParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message to be edited was sent
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageID - Identifier of the original message with the poll
	MessageID int `json:"message_id"`

	// ReplyMarkup - Optional. A JSON-serialized object for a new message inline keyboard
	// (https://core.telegram.org/bots/features#inline-keyboards).
	ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}

StopPollParams - Represents parameters of stopPoll method.

func (*StopPollParams) WithBusinessConnectionID added in v0.31.0 

func (p *StopPollParams) WithBusinessConnectionID(businessConnectionID string) *StopPollParams

WithBusinessConnectionID adds business connection ID parameter

func (*StopPollParams) WithChatID added in v0.10.0 

func (p *StopPollParams) WithChatID(chatID ChatID) *StopPollParams

WithChatID adds chat ID parameter

func (*StopPollParams) WithMessageID added in v0.10.0 

func (p *StopPollParams) WithMessageID(messageID int) *StopPollParams

WithMessageID adds message ID parameter

func (*StopPollParams) WithReplyMarkup added in v0.10.0 

func (p *StopPollParams) WithReplyMarkup(replyMarkup *InlineKeyboardMarkup) *StopPollParams

WithReplyMarkup adds reply markup parameter

type Story added in v0.26.1 

type Story struct {
	// Chat - Chat that posted the story
	Chat Chat `json:"chat"`

	// ID - Unique identifier for the story in the chat
	ID int `json:"id"`
}

Story - This object represents a story.

type StoryArea added in v1.1.0 

type StoryArea struct {
	// Position - Position of the area
	Position StoryAreaPosition `json:"position"`

	// Type - Type of the area
	Type StoryAreaType `json:"type"`
}

StoryArea - Describes a clickable area on a story media.

type StoryAreaPosition added in v1.1.0 

type StoryAreaPosition struct {
	// 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"`
}

StoryAreaPosition - Describes the position of a clickable area within a story.

type StoryAreaType added in v1.1.0 

type StoryAreaType interface {
	// StoryAreaType return StoryAreaType type
	StoryAreaType() string
	// contains filtered or unexported methods
}

StoryAreaType - Describes the type of a clickable area on a story. Currently, it can be one of StoryAreaTypeLocation (https://core.telegram.org/bots/api#storyareatypelocation) StoryAreaTypeSuggestedReaction (https://core.telegram.org/bots/api#storyareatypesuggestedreaction) StoryAreaTypeLink (https://core.telegram.org/bots/api#storyareatypelink) StoryAreaTypeWeather (https://core.telegram.org/bots/api#storyareatypeweather) StoryAreaTypeUniqueGift (https://core.telegram.org/bots/api#storyareatypeuniquegift) 

type StoryAreaTypeLink struct {
	// Type - Type of the area, always “link”
	Type string `json:"type"`

	// URL - HTTP or tg:// URL to be opened when the area is clicked
	URL string `json:"url"`
}

StoryAreaTypeLink - Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.

func (*StoryAreaTypeLink) StoryAreaType added in v1.1.0 

func (s *StoryAreaTypeLink) StoryAreaType() string

StoryAreaType returns StoryAreaType type

type StoryAreaTypeLocation added in v1.1.0 

type StoryAreaTypeLocation struct {
	// Type - Type of the area, always “location”
	Type string `json:"type"`

	// Latitude - Location latitude in degrees
	Latitude float64 `json:"latitude"`

	// Longitude - Location longitude in degrees
	Longitude float64 `json:"longitude"`

	// Address - Optional. Address of the location
	Address *LocationAddress `json:"address,omitempty"`
}

StoryAreaTypeLocation - Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.

func (*StoryAreaTypeLocation) StoryAreaType added in v1.1.0 

func (s *StoryAreaTypeLocation) StoryAreaType() string

StoryAreaType returns StoryAreaType type

type StoryAreaTypeSuggestedReaction added in v1.1.0 

type StoryAreaTypeSuggestedReaction struct {
	// Type - Type of the area, always “suggested_reaction”
	Type string `json:"type"`

	// ReactionType - Type of the reaction
	ReactionType ReactionType `json:"reaction_type"`

	// 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"`
}

StoryAreaTypeSuggestedReaction - Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.

func (*StoryAreaTypeSuggestedReaction) StoryAreaType added in v1.1.0 

func (s *StoryAreaTypeSuggestedReaction) StoryAreaType() string

StoryAreaType returns StoryAreaType type

type StoryAreaTypeUniqueGift added in v1.1.0 

type StoryAreaTypeUniqueGift struct {
	// Type - Type of the area, always “unique_gift”
	Type string `json:"type"`

	// Name - Unique name of the gift
	Name string `json:"name"`
}

StoryAreaTypeUniqueGift - Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.

func (*StoryAreaTypeUniqueGift) StoryAreaType added in v1.1.0 

func (s *StoryAreaTypeUniqueGift) StoryAreaType() string

StoryAreaType returns StoryAreaType type

type StoryAreaTypeWeather added in v1.1.0 

type StoryAreaTypeWeather struct {
	// Type - Type of the area, always “weather”
	Type string `json:"type"`

	// Temperature - Temperature, in degree Celsius
	Temperature float64 `json:"temperature"`

	// Emoji - Emoji representing the weather
	Emoji string `json:"emoji"`

	// BackgroundColor - A color of the area background in the ARGB format
	BackgroundColor int `json:"background_color"`
}

StoryAreaTypeWeather - Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.

func (*StoryAreaTypeWeather) StoryAreaType added in v1.1.0 

func (s *StoryAreaTypeWeather) StoryAreaType() string

StoryAreaType returns StoryAreaType type

type SuccessfulPayment 

type SuccessfulPayment struct {
	// Currency - Three-letter ISO 4217 currency (https://core.telegram.org/bots/payments#supported-currencies)
	// code, or “XTR” for payments in Telegram Stars (https://t.me/BotNews/90)
	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
	// (https://core.telegram.org/bots/payments/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 - Optional. Expiration date of the subscription, in Unix time; for recurring
	// payments only
	SubscriptionExpirationDate int64 `json:"subscription_expiration_date,omitempty"`

	// IsRecurring - Optional. True, if the payment is a recurring payment for a subscription
	IsRecurring bool `json:"is_recurring,omitempty"`

	// IsFirstRecurring - Optional. True, if the payment is the first payment for a subscription
	IsFirstRecurring bool `json:"is_first_recurring,omitempty"`

	// 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 - Provider payment identifier
	ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
}

SuccessfulPayment - This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

type SuggestedPostApprovalFailed added in v1.3.0 

type SuggestedPostApprovalFailed struct {
	// SuggestedPostMessage - Optional. Message containing the suggested post whose approval has failed. Note
	// that the Message (https://core.telegram.org/bots/api#message) object in this field will not contain the
	// reply_to_message field even if it itself is a reply.
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Price - Expected price of the post
	Price SuggestedPostPrice `json:"price"`
}

SuggestedPostApprovalFailed - Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.

type SuggestedPostApproved added in v1.3.0 

type SuggestedPostApproved struct {
	// SuggestedPostMessage - Optional. Message containing the suggested post. Note that the Message
	// (https://core.telegram.org/bots/api#message) object in this field will not contain the reply_to_message field
	// even if it itself is a reply.
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Price - Optional. Amount paid for the post
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// SendDate - Date when the post will be published
	SendDate int64 `json:"send_date"`
}

SuggestedPostApproved - Describes a service message about the approval of a suggested post.

type SuggestedPostDeclined added in v1.3.0 

type SuggestedPostDeclined struct {
	// SuggestedPostMessage - Optional. Message containing the suggested post. Note that the Message
	// (https://core.telegram.org/bots/api#message) object in this field will not contain the reply_to_message field
	// even if it itself is a reply.
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Comment - Optional. Comment with which the post was declined
	Comment string `json:"comment,omitempty"`
}

SuggestedPostDeclined - Describes a service message about the rejection of a suggested post.

type SuggestedPostInfo added in v1.3.0 

type SuggestedPostInfo struct {
	// State - State of the suggested post. Currently, it can be one of “pending”, “approved”,
	// “declined”.
	State string `json:"state"`

	// Price - Optional. Proposed price of the post. If the field is omitted, then the post is unpaid.
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// SendDate - Optional. Proposed send date of the post. If the field is omitted, then the post can be
	// published at any time within 30 days at the sole discretion of the user or administrator who approves it.
	SendDate int64 `json:"send_date,omitempty"`
}

SuggestedPostInfo - Contains information about a suggested post.

type SuggestedPostPaid added in v1.3.0 

type SuggestedPostPaid struct {
	// SuggestedPostMessage - Optional. Message containing the suggested post. Note that the Message
	// (https://core.telegram.org/bots/api#message) object in this field will not contain the reply_to_message field
	// even if it itself is a reply.
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Currency - Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or
	// “TON” for toncoins
	Currency string `json:"currency"`

	// Amount - Optional. The amount of the currency that was received by the channel in nanotoncoins; for
	// payments in toncoins only
	Amount int `json:"amount,omitempty"`

	// StarAmount - Optional. The amount of Telegram Stars that was received by the channel; for payments in
	// Telegram Stars only
	StarAmount *StarAmount `json:"star_amount,omitempty"`
}

SuggestedPostPaid - Describes a service message about a successful payment for a suggested post.

type SuggestedPostParameters added in v1.3.0 

type SuggestedPostParameters struct {
	// Price - Optional. Proposed price for the post. If the field is omitted, then the post is unpaid.
	Price *SuggestedPostPrice `json:"price,omitempty"`

	// SendDate - Optional. Proposed send date of the post. If specified, then the date must be between 300
	// second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published
	// at any time within 30 days at the sole discretion of the user who approves it.
	SendDate int64 `json:"send_date,omitempty"`
}

SuggestedPostParameters - Contains parameters of a post that is being suggested by the bot.

type SuggestedPostPrice added in v1.3.0 

type SuggestedPostPrice struct {
	// Currency - Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram
	// Stars or “TON” for toncoins
	Currency string `json:"currency"`

	// Amount - The amount of the currency that will be paid for the post in the smallest units of the currency,
	// i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and
	// price in nanotoncoins must be between 10000000 and 10000000000000.
	Amount int `json:"amount"`
}

SuggestedPostPrice - Describes the price of a suggested post.

type SuggestedPostRefunded added in v1.3.0 

type SuggestedPostRefunded struct {
	// SuggestedPostMessage - Optional. Message containing the suggested post. Note that the Message
	// (https://core.telegram.org/bots/api#message) object in this field will not contain the reply_to_message field
	// even if it itself is a reply.
	SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`

	// Reason - Reason for the refund. Currently, one of “post_deleted” if the post was deleted within 24
	// hours of being posted or removed from scheduled messages without being posted, or “payment_refunded” if
	// the payer refunded their payment.
	Reason string `json:"reason"`
}

SuggestedPostRefunded - Describes a service message about a payment refund for a suggested post.

type SwitchInlineQueryChosenChat added in v0.22.1 

type SwitchInlineQueryChosenChat struct {
	// Query - Optional. The default inline query to be inserted in the input field. If left empty, only the
	// bot's username will be inserted
	Query string `json:"query,omitempty"`

	// AllowUserChats - Optional. True, if private chats with users can be chosen
	AllowUserChats bool `json:"allow_user_chats,omitempty"`

	// AllowBotChats - Optional. True, if private chats with bots can be chosen
	AllowBotChats bool `json:"allow_bot_chats,omitempty"`

	// AllowGroupChats - Optional. True, if group and supergroup chats can be chosen
	AllowGroupChats bool `json:"allow_group_chats,omitempty"`

	// AllowChannelChats - Optional. True, if channel chats can be chosen
	AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
}

SwitchInlineQueryChosenChat - This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

type TextQuote added in v0.29.0 

type TextQuote struct {
	// Text - Text of the quoted part of a message that is replied to by the given message
	Text string `json:"text"`

	// Entities - Optional. Special entities that appear in the quote. Currently, only bold, italic, underline,
	// strikethrough, spoiler, and custom_emoji entities are kept in quotes.
	Entities []MessageEntity `json:"entities,omitempty"`

	// Position - Approximate quote position in the original message in UTF-16 code units as specified by the
	// sender
	Position int `json:"position"`

	// IsManual - Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote
	// was added automatically by the server.
	IsManual bool `json:"is_manual,omitempty"`
}

TextQuote - This object contains information about the quoted part of a message that is replied to by the given message.

type TransactionPartner added in v0.31.0 

type TransactionPartner interface {
	// PartnerType returns TransactionPartner type
	PartnerType() string
	// contains filtered or unexported methods
}

TransactionPartner - This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of TransactionPartnerUser (https://core.telegram.org/bots/api#transactionpartneruser) TransactionPartnerChat (https://core.telegram.org/bots/api#transactionpartnerchat) TransactionPartnerAffiliateProgram (https://core.telegram.org/bots/api#transactionpartneraffiliateprogram) TransactionPartnerFragment (https://core.telegram.org/bots/api#transactionpartnerfragment) TransactionPartnerTelegramAds (https://core.telegram.org/bots/api#transactionpartnertelegramads) TransactionPartnerTelegramApi (https://core.telegram.org/bots/api#transactionpartnertelegramapi) TransactionPartnerOther (https://core.telegram.org/bots/api#transactionpartnerother)

type TransactionPartnerAffiliateProgram added in v0.32.0 

type TransactionPartnerAffiliateProgram struct {
	// Type - Type of the transaction partner, always “affiliate_program”
	Type string `json:"type"`

	// SponsorUser - Optional. Information about the bot that sponsored the affiliate program
	SponsorUser *User `json:"sponsor_user,omitempty"`

	// CommissionPerMille - The number of Telegram Stars received by the bot for each 1000 Telegram Stars
	// received by the affiliate program sponsor from referred users
	CommissionPerMille int `json:"commission_per_mille"`
}

TransactionPartnerAffiliateProgram - Describes the affiliate program that issued the affiliate commission received via this transaction.

func (*TransactionPartnerAffiliateProgram) PartnerType added in v0.32.0 

func (p *TransactionPartnerAffiliateProgram) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerChat added in v1.0.2 

type TransactionPartnerChat struct {
	// Type - Type of the transaction partner, always “chat”
	Type string `json:"type"`

	// Chat - Information about the chat
	Chat Chat `json:"chat"`

	// Gift - Optional. The gift sent to the chat by the bot
	Gift *Gift `json:"gift,omitempty"`
}

TransactionPartnerChat - Describes a transaction with a chat.

func (*TransactionPartnerChat) PartnerType added in v1.0.2 

func (p *TransactionPartnerChat) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerFragment added in v0.31.0 

type TransactionPartnerFragment struct {
	// Type - Type of the transaction partner, always “fragment”
	Type string `json:"type"`

	// WithdrawalState - Optional. State of the transaction if the transaction is outgoing
	WithdrawalState RevenueWithdrawalState `json:"withdrawal_state,omitempty"`
}

TransactionPartnerFragment - Describes a withdrawal transaction with Fragment.

func (*TransactionPartnerFragment) PartnerType added in v0.31.0 

func (p *TransactionPartnerFragment) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerOther added in v0.31.0 

type TransactionPartnerOther struct {
	// Type - Type of the transaction partner, always “other”
	Type string `json:"type"`
}

TransactionPartnerOther - Describes a transaction with an unknown source or recipient.

func (*TransactionPartnerOther) PartnerType added in v0.31.0 

func (p *TransactionPartnerOther) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerTelegramAds added in v0.31.0 

type TransactionPartnerTelegramAds struct {
	// Type - Type of the transaction partner, always “telegram_ads”
	Type string `json:"type"`
}

TransactionPartnerTelegramAds - Describes a withdrawal transaction to the Telegram Ads platform.

func (*TransactionPartnerTelegramAds) PartnerType added in v0.31.0 

func (p *TransactionPartnerTelegramAds) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerTelegramApi added in v0.32.0 

type TransactionPartnerTelegramApi struct {
	// Type - Type of the transaction partner, always “telegram_api”
	Type string `json:"type"`

	// RequestCount - The number of successful requests that exceeded regular limits and were therefore billed
	RequestCount int `json:"request_count"`
}

TransactionPartnerTelegramApi - Describes a transaction with payment for paid broadcasting (https://core.telegram.org/bots/api#paid-broadcasts).

func (*TransactionPartnerTelegramApi) PartnerType added in v0.32.0 

func (p *TransactionPartnerTelegramApi) PartnerType() string

PartnerType returns TransactionPartner type

type TransactionPartnerUser added in v0.31.0 

type TransactionPartnerUser struct {
	// Type - Type of the transaction partner, always “user”
	Type string `json:"type"`

	// TransactionType - Type of the transaction, currently one of “invoice_payment” for payments via
	// invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the
	// bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot,
	// “business_account_transfer” for direct transfers from managed business accounts
	TransactionType string `json:"transaction_type"`

	// User - Information about the user
	User User `json:"user"`

	// Affiliate - Optional. Information about the affiliate that received a commission via this transaction.
	// Can be available only for “invoice_payment” and “paid_media_payment” transactions.
	Affiliate *AffiliateInfo `json:"affiliate,omitempty"`

	// InvoicePayload - Optional. Bot-specified invoice payload. Can be available only for “invoice_payment”
	// transactions.
	InvoicePayload string `json:"invoice_payload,omitempty"`

	// SubscriptionPeriod - Optional. The duration of the paid subscription. Can be available only for
	// “invoice_payment” transactions.
	SubscriptionPeriod int `json:"subscription_period,omitempty"`

	// PaidMedia - Optional. Information about the paid media bought by the user; for “paid_media_payment”
	// transactions only
	PaidMedia []PaidMedia `json:"paid_media,omitempty"`

	// PaidMediaPayload - Optional. Bot-specified paid media payload. Can be available only for
	// “paid_media_payment” transactions.
	PaidMediaPayload string `json:"paid_media_payload,omitempty"`

	// Gift - Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only
	Gift *Gift `json:"gift,omitempty"`

	// PremiumSubscriptionDuration - Optional. Number of months the gifted Telegram Premium subscription will be
	// active for; for “premium_purchase” transactions only
	PremiumSubscriptionDuration int `json:"premium_subscription_duration,omitempty"`
}

TransactionPartnerUser - Describes a transaction with a user.

func (*TransactionPartnerUser) PartnerType added in v0.31.0 

func (p *TransactionPartnerUser) PartnerType() string

PartnerType returns TransactionPartner type

func (*TransactionPartnerUser) UnmarshalJSON added in v0.31.2 

func (p *TransactionPartnerUser) UnmarshalJSON(data []byte) error

UnmarshalJSON converts JSON to PaidMediaInfo

type TransferBusinessAccountStarsParams added in v1.1.0 

type TransferBusinessAccountStarsParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// StarCount - Number of Telegram Stars to transfer; 1-10000
	StarCount int `json:"star_count"`
}

TransferBusinessAccountStarsParams - Represents parameters of transferBusinessAccountStars method.

func (*TransferBusinessAccountStarsParams) WithBusinessConnectionID added in v1.1.0 

func (p *TransferBusinessAccountStarsParams) WithBusinessConnectionID(businessConnectionID string,
) *TransferBusinessAccountStarsParams

WithBusinessConnectionID adds business connection ID parameter

func (*TransferBusinessAccountStarsParams) WithStarCount added in v1.1.0 

func (p *TransferBusinessAccountStarsParams) WithStarCount(starCount int) *TransferBusinessAccountStarsParams

WithStarCount adds star count parameter

type TransferGiftParams added in v1.1.0 

type TransferGiftParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// OwnedGiftID - Unique identifier of the regular gift that should be transferred
	OwnedGiftID string `json:"owned_gift_id"`

	// NewOwnerChatID - 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"`
}

TransferGiftParams - Represents parameters of transferGift method.

func (*TransferGiftParams) WithBusinessConnectionID added in v1.1.0 

func (p *TransferGiftParams) WithBusinessConnectionID(businessConnectionID string) *TransferGiftParams

WithBusinessConnectionID adds business connection ID parameter

func (*TransferGiftParams) WithNewOwnerChatID added in v1.1.0 

func (p *TransferGiftParams) WithNewOwnerChatID(newOwnerChatID int64) *TransferGiftParams

WithNewOwnerChatID adds new owner chat ID parameter

func (*TransferGiftParams) WithOwnedGiftID added in v1.1.0 

func (p *TransferGiftParams) WithOwnedGiftID(ownedGiftID string) *TransferGiftParams

WithOwnedGiftID adds owned gift ID parameter

func (*TransferGiftParams) WithStarCount added in v1.1.0 

func (p *TransferGiftParams) WithStarCount(starCount int) *TransferGiftParams

WithStarCount adds star count parameter

type UnbanChatMemberParams 

type UnbanChatMemberParams struct {
	// ChatID - Unique identifier for the target group or username of the target supergroup or channel (in the
	// format @channel_username)
	ChatID ChatID `json:"chat_id"`

	// UserID - Unique identifier of the target user
	UserID int64 `json:"user_id"`

	// OnlyIfBanned - Optional. Do nothing if the user is not banned
	OnlyIfBanned bool `json:"only_if_banned,omitempty"`
}

UnbanChatMemberParams - Represents parameters of unbanChatMember method.

func (*UnbanChatMemberParams) WithChatID added in v0.10.0 

func (p *UnbanChatMemberParams) WithChatID(chatID ChatID) *UnbanChatMemberParams

WithChatID adds chat ID parameter

func (*UnbanChatMemberParams) WithOnlyIfBanned added in v0.10.0 

func (p *UnbanChatMemberParams) WithOnlyIfBanned() *UnbanChatMemberParams

WithOnlyIfBanned adds only if banned parameter

func (*UnbanChatMemberParams) WithUserID added in v1.1.0 

func (p *UnbanChatMemberParams) WithUserID(userID int64) *UnbanChatMemberParams

WithUserID adds user ID parameter

type UnbanChatSenderChatParams added in v0.7.2 

type UnbanChatSenderChatParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// SenderChatID - Unique identifier of the target sender chat
	SenderChatID int64 `json:"sender_chat_id"`
}

UnbanChatSenderChatParams - Represents parameters of unbanChatSenderChat method.

func (*UnbanChatSenderChatParams) WithChatID added in v0.10.0 

func (p *UnbanChatSenderChatParams) WithChatID(chatID ChatID) *UnbanChatSenderChatParams

WithChatID adds chat ID parameter

func (*UnbanChatSenderChatParams) WithSenderChatID added in v1.1.0 

func (p *UnbanChatSenderChatParams) WithSenderChatID(senderChatID int64) *UnbanChatSenderChatParams

WithSenderChatID adds sender chat ID parameter

type UnhideGeneralForumTopicParams added in v0.18.1 

type UnhideGeneralForumTopicParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

UnhideGeneralForumTopicParams - Represents parameters of unhideGeneralForumTopic method.

func (*UnhideGeneralForumTopicParams) WithChatID added in v0.18.1 

func (p *UnhideGeneralForumTopicParams) WithChatID(chatID ChatID) *UnhideGeneralForumTopicParams

WithChatID adds chat ID parameter

type UniqueGift added in v1.1.0 

type UniqueGift struct {
	// GiftID - Identifier of the regular gift from which the gift was upgraded
	GiftID string `json:"gift_id"`

	// BaseName - Human-readable name of the regular gift from which this unique gift was upgraded
	BaseName string `json:"base_name"`

	// Name - Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas
	Name string `json:"name"`

	// Number - Unique number of the upgraded gift among gifts upgraded from the same regular gift
	Number int `json:"number"`

	// Model - Model of the gift
	Model UniqueGiftModel `json:"model"`

	// Symbol - Symbol of the gift
	Symbol UniqueGiftSymbol `json:"symbol"`

	// Backdrop - Backdrop of the gift
	Backdrop UniqueGiftBackdrop `json:"backdrop"`

	// IsPremium - Optional. True, if the original regular gift was exclusively purchaseable by Telegram Premium
	// subscribers
	IsPremium bool `json:"is_premium,omitempty"`

	// IsFromBlockchain - Optional. True, if the gift is assigned from the TON blockchain and can't be resold or
	// transferred in Telegram
	IsFromBlockchain bool `json:"is_from_blockchain,omitempty"`

	// Colors - Optional. The color scheme that can be used by the gift's owner for the chat's name, replies to
	// messages and link previews; for business account gifts and gifts that are currently on sale only
	Colors *UniqueGiftColors `json:"colors,omitempty"`

	// PublisherChat - Optional. Information about the chat that published the gift
	PublisherChat *Chat `json:"publisher_chat,omitempty"`
}

UniqueGift - This object describes a unique gift that was upgraded from a regular gift.

type UniqueGiftBackdrop added in v1.1.0 

type UniqueGiftBackdrop struct {
	// Name - Name of the backdrop
	Name string `json:"name"`

	// Colors - Colors of the backdrop
	Colors UniqueGiftBackdropColors `json:"colors"`

	// RarityPerMille - The number of unique gifts that receive this backdrop for every 1000 gifts upgraded
	RarityPerMille int `json:"rarity_per_mille"`
}

UniqueGiftBackdrop - This object describes the backdrop of a unique gift.

type UniqueGiftBackdropColors added in v1.1.0 

type UniqueGiftBackdropColors struct {
	// CenterColor - The color in the center of the backdrop in RGB format
	CenterColor int `json:"center_color"`

	// EdgeColor - The color on the edges of the backdrop in RGB format
	EdgeColor int `json:"edge_color"`

	// SymbolColor - The color to be applied to the symbol in RGB format
	SymbolColor int `json:"symbol_color"`

	// TextColor - The color for the text on the backdrop in RGB format
	TextColor int `json:"text_color"`
}

UniqueGiftBackdropColors - This object describes the colors of the backdrop of a unique gift.

type UniqueGiftColors added in v1.4.0 

type UniqueGiftColors struct {
	// ModelCustomEmojiID - Custom emoji identifier of the unique gift's model
	ModelCustomEmojiID string `json:"model_custom_emoji_id"`

	// SymbolCustomEmojiID - Custom emoji identifier of the unique gift's symbol
	SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`

	// LightThemeMainColor - Main color used in light themes; RGB format
	LightThemeMainColor int `json:"light_theme_main_color"`

	// LightThemeOtherColors - List of 1-3 additional colors used in light themes; RGB format
	LightThemeOtherColors []int `json:"light_theme_other_colors"`

	// DarkThemeMainColor - Main color used in dark themes; RGB format
	DarkThemeMainColor int `json:"dark_theme_main_color"`

	// DarkThemeOtherColors - List of 1-3 additional colors used in dark themes; RGB format
	DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
}

UniqueGiftColors - This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

type UniqueGiftInfo added in v1.1.0 

type UniqueGiftInfo struct {
	// Gift - Information about the gift
	Gift UniqueGift `json:"gift"`

	// Origin - Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts,
	// “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other
	// users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought
	// or sold through gift purchase offers
	Origin string `json:"origin"`

	// LastResaleCurrency - Optional. For gifts bought from other users, the currency in which the payment for
	// the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
	LastResaleCurrency string `json:"last_resale_currency,omitempty"`

	// LastResaleAmount - Optional. For gifts bought from other users, the price paid for the gift in either
	// Telegram Stars or nanotoncoins
	LastResaleAmount int `json:"last_resale_amount,omitempty"`

	// OwnedGiftID - Optional. Unique identifier of the received gift for the bot; only present for gifts
	// received on behalf of business accounts
	OwnedGiftID string `json:"owned_gift_id,omitempty"`

	// TransferStarCount - Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if
	// the bot cannot transfer the gift
	TransferStarCount int `json:"transfer_star_count,omitempty"`

	// NextTransferDate - Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in
	// the past, then the gift can be transferred now
	NextTransferDate int64 `json:"next_transfer_date,omitempty"`
}

UniqueGiftInfo - Describes a service message about a unique gift that was sent or received.

type UniqueGiftModel added in v1.1.0 

type UniqueGiftModel struct {
	// Name - Name of the model
	Name string `json:"name"`

	// Sticker - The sticker that represents the unique gift
	Sticker Sticker `json:"sticker"`

	// RarityPerMille - The number of unique gifts that receive this model for every 1000 gifts upgraded
	RarityPerMille int `json:"rarity_per_mille"`
}

UniqueGiftModel - This object describes the model of a unique gift.

type UniqueGiftSymbol added in v1.1.0 

type UniqueGiftSymbol struct {
	// Name - Name of the symbol
	Name string `json:"name"`

	// Sticker - The sticker that represents the unique gift
	Sticker Sticker `json:"sticker"`

	// RarityPerMille - The number of unique gifts that receive this model for every 1000 gifts upgraded
	RarityPerMille int `json:"rarity_per_mille"`
}

UniqueGiftSymbol - This object describes the symbol shown on the pattern of a unique gift.

type UnpinAllChatMessagesParams 

type UnpinAllChatMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`
}

UnpinAllChatMessagesParams - Represents parameters of unpinAllChatMessages method.

func (*UnpinAllChatMessagesParams) WithChatID added in v0.10.0 

func (p *UnpinAllChatMessagesParams) WithChatID(chatID ChatID) *UnpinAllChatMessagesParams

WithChatID adds chat ID parameter

type UnpinAllForumTopicMessagesParams added in v0.17.1 

type UnpinAllForumTopicMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`

	// MessageThreadID - Unique identifier for the target message thread of the forum topic
	MessageThreadID int `json:"message_thread_id"`
}

UnpinAllForumTopicMessagesParams - Represents parameters of unpinAllForumTopicMessages method.

func (*UnpinAllForumTopicMessagesParams) WithChatID added in v0.17.1 

func (p *UnpinAllForumTopicMessagesParams) WithChatID(chatID ChatID) *UnpinAllForumTopicMessagesParams

WithChatID adds chat ID parameter

func (*UnpinAllForumTopicMessagesParams) WithMessageThreadID added in v0.17.1 

func (p *UnpinAllForumTopicMessagesParams) WithMessageThreadID(messageThreadID int) *UnpinAllForumTopicMessagesParams

WithMessageThreadID adds message thread ID parameter

type UnpinAllGeneralForumTopicMessagesParams added in v0.26.1 

type UnpinAllGeneralForumTopicMessagesParams struct {
	// ChatID - Unique identifier for the target chat or username of the target supergroup (in the format
	// @supergroup_username)
	ChatID ChatID `json:"chat_id"`
}

UnpinAllGeneralForumTopicMessagesParams - Represents parameters of unpinAllGeneralForumTopicMessages method.

func (*UnpinAllGeneralForumTopicMessagesParams) WithChatID added in v0.26.1 

func (p *UnpinAllGeneralForumTopicMessagesParams) WithChatID(chatID ChatID) *UnpinAllGeneralForumTopicMessagesParams

WithChatID adds chat ID parameter

type UnpinChatMessageParams 

type UnpinChatMessageParams struct {
	// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
	// message will be unpinned
	BusinessConnectionID string `json:"business_connection_id,omitempty"`

	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username)
	ChatID ChatID `json:"chat_id"`

	// MessageID - Optional. Identifier of the message to unpin. Required if business_connection_id is
	// specified. If not specified, the most recent pinned message (by sending date) will be unpinned.
	MessageID int `json:"message_id,omitempty"`
}

UnpinChatMessageParams - Represents parameters of unpinChatMessage method.

func (*UnpinChatMessageParams) WithBusinessConnectionID added in v0.31.1 

func (p *UnpinChatMessageParams) WithBusinessConnectionID(businessConnectionID string) *UnpinChatMessageParams

WithBusinessConnectionID adds business connection ID parameter

func (*UnpinChatMessageParams) WithChatID added in v0.10.0 

func (p *UnpinChatMessageParams) WithChatID(chatID ChatID) *UnpinChatMessageParams

WithChatID adds chat ID parameter

func (*UnpinChatMessageParams) WithMessageID added in v0.10.0 

func (p *UnpinChatMessageParams) WithMessageID(messageID int) *UnpinChatMessageParams

WithMessageID adds message ID parameter

type Update 

type Update struct {
	// UpdateID - The update's unique identifier. Update identifiers start from a certain positive number and
	// increase sequentially. This identifier becomes especially handy if you're using webhooks
	// (https://core.telegram.org/bots/api#setwebhook), since it allows you to ignore repeated updates or to restore
	// the correct update sequence, should they get out of order. If there are no new updates for at least a week,
	// then identifier of the next update will be chosen randomly instead of sequentially.
	UpdateID int `json:"update_id"`

	// Message - Optional. New incoming message of any kind - text, photo, sticker, etc.
	Message *Message `json:"message,omitempty"`

	// EditedMessage - Optional. New version of a message that is known to the bot and was edited. This update
	// may at times be triggered by changes to message fields that are either unavailable or not actively used by
	// your bot.
	EditedMessage *Message `json:"edited_message,omitempty"`

	// ChannelPost - Optional. New incoming channel post of any kind - text, photo, sticker, etc.
	ChannelPost *Message `json:"channel_post,omitempty"`

	// EditedChannelPost - Optional. New version of a channel post that is known to the bot and was edited. This
	// update may at times be triggered by changes to message fields that are either unavailable or not actively
	// used by your bot.
	EditedChannelPost *Message `json:"edited_channel_post,omitempty"`

	// BusinessConnection - Optional. The bot was connected to or disconnected from a business account, or a
	// user edited an existing connection with the bot
	BusinessConnection *BusinessConnection `json:"business_connection,omitempty"`

	// BusinessMessage - Optional. New message from a connected business account
	BusinessMessage *Message `json:"business_message,omitempty"`

	// EditedBusinessMessage - Optional. New version of a message from a connected business account
	EditedBusinessMessage *Message `json:"edited_business_message,omitempty"`

	// DeletedBusinessMessages - Optional. Messages were deleted from a connected business account
	DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,omitempty"`

	// MessageReaction - Optional. A reaction to a message was changed by a user. The bot must be an
	// administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to
	// receive these updates. The update isn't received for reactions set by bots.
	MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`

	// MessageReactionCount - Optional. Reactions to a message with anonymous reactions were changed. The bot
	// must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of
	// allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few
	// minutes.
	MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`

	// InlineQuery - Optional. New incoming inline (https://core.telegram.org/bots/api#inline-mode) query
	InlineQuery *InlineQuery `json:"inline_query,omitempty"`

	// ChosenInlineResult - Optional. The result of an inline (https://core.telegram.org/bots/api#inline-mode)
	// query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback
	// collecting (https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these
	// updates for your bot.
	ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"`

	// CallbackQuery - Optional. New incoming callback query
	CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`

	// ShippingQuery - Optional. New incoming shipping query. Only for invoices with flexible price
	ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"`

	// PreCheckoutQuery - Optional. New incoming pre-checkout query. Contains full information about checkout
	PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"`

	// PurchasedPaidMedia - Optional. A user purchased paid media with a non-empty payload sent by the bot in a
	// non-channel chat
	PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"`

	// Poll - Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which
	// are sent by the bot
	Poll *Poll `json:"poll,omitempty"`

	// PollAnswer - Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only
	// in polls that were sent by the bot itself.
	PollAnswer *PollAnswer `json:"poll_answer,omitempty"`

	// MyChatMember - Optional. The bot's chat member status was updated in a chat. For private chats, this
	// update is received only when the bot is blocked or unblocked by the user.
	MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`

	// ChatMember - Optional. A chat member's status was updated in a chat. The bot must be an administrator in
	// the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
	ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`

	// ChatJoinRequest - Optional. A request to join the chat has been sent. The bot must have the
	// can_invite_users administrator right in the chat to receive these updates.
	ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`

	// ChatBoost - Optional. A chat boost was added or changed. The bot must be an administrator in the chat to
	// receive these updates.
	ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"`

	// RemovedChatBoost - Optional. A boost was removed from a chat. The bot must be an administrator in the
	// chat to receive these updates.
	RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
	// contains filtered or unexported fields
}

Update - This object (https://core.telegram.org/bots/api#available-types) represents an incoming update. At most one of the optional parameters can be present in any given update.

func (Update) Clone added in v0.15.3 

func (u Update) Clone() Update

Clone returns a deep copy of Update.

Warning: Types like ChatMember and MenuButton require to have their mandatory fields (like status or type) to be filled properly, else Update.Clone method will panic. To safely clone, use Update.CloneSafe method.

func (Update) CloneSafe added in v0.15.3 

func (u Update) CloneSafe() (Update, error)

CloneSafe returns a deep copy of Update or an error.

Note: Update's context is carried to the copy as is, to change it use Update.WithContext method.

func (Update) Context added in v0.21.1 

func (u Update) Context() context.Context

Context returns the update's context. To change the context, use WithContext. The returned context is always non-nil; it defaults to the background context.

func (Update) WithContext added in v0.21.1 

func (u Update) WithContext(ctx context.Context) Update

WithContext returns a shallow copy of the update with its context changed to ctx.

Warning: Panics if nil context passed.

type UpgradeGiftParams added in v1.1.0 

type UpgradeGiftParams struct {
	// BusinessConnectionID - Unique identifier of the business connection
	BusinessConnectionID string `json:"business_connection_id"`

	// OwnedGiftID - 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"`
}

UpgradeGiftParams - Represents parameters of upgradeGift method.

func (*UpgradeGiftParams) WithBusinessConnectionID added in v1.1.0 

func (p *UpgradeGiftParams) WithBusinessConnectionID(businessConnectionID string) *UpgradeGiftParams

WithBusinessConnectionID adds business connection ID parameter

func (*UpgradeGiftParams) WithKeepOriginalDetails added in v1.1.0 

func (p *UpgradeGiftParams) WithKeepOriginalDetails() *UpgradeGiftParams

WithKeepOriginalDetails adds keep original details parameter

func (*UpgradeGiftParams) WithOwnedGiftID added in v1.1.0 

func (p *UpgradeGiftParams) WithOwnedGiftID(ownedGiftID string) *UpgradeGiftParams

WithOwnedGiftID adds owned gift ID parameter

func (*UpgradeGiftParams) WithStarCount added in v1.1.0 

func (p *UpgradeGiftParams) WithStarCount(starCount int) *UpgradeGiftParams

WithStarCount adds star count parameter

type UploadStickerFileParams 

type UploadStickerFileParams struct {
	// UserID - User identifier of sticker file owner
	UserID int64 `json:"user_id"`

	// Sticker - A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See
	// https://core.telegram.org/stickers (https://core.telegram.org/stickers) for technical requirements. More
	// information on Sending Files » (https://core.telegram.org/bots/api#sending-files)
	Sticker InputFile `json:"sticker"`

	// StickerFormat - Format of the sticker, must be one of “static”, “animated”, “video”
	StickerFormat string `json:"sticker_format"`
}

UploadStickerFileParams - Represents parameters of uploadStickerFile method.

func (*UploadStickerFileParams) WithSticker added in v0.22.0 

func (p *UploadStickerFileParams) WithSticker(sticker InputFile) *UploadStickerFileParams

WithSticker adds sticker parameter

func (*UploadStickerFileParams) WithStickerFormat added in v0.22.0 

func (p *UploadStickerFileParams) WithStickerFormat(stickerFormat string) *UploadStickerFileParams

WithStickerFormat adds sticker format parameter

func (*UploadStickerFileParams) WithUserID added in v1.1.0 

func (p *UploadStickerFileParams) WithUserID(userID int64) *UploadStickerFileParams

WithUserID adds user ID parameter

type User 

type User struct {
	// ID - Unique identifier for this user or bot. This number may have more than 32 significant bits and some
	// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
	// significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
	ID int64 `json:"id"`

	// IsBot - True, if this user is a bot
	IsBot bool `json:"is_bot"`

	// FirstName - User's or bot's first name
	FirstName string `json:"first_name"`

	// LastName - Optional. User's or bot's last name
	LastName string `json:"last_name,omitempty"`

	// Username - Optional. User's or bot's username
	Username string `json:"username,omitempty"`

	// LanguageCode - Optional. IETF language tag (https://en.wikipedia.org/wiki/IETF_language_tag) of the
	// user's language
	LanguageCode string `json:"language_code,omitempty"`

	// IsPremium - Optional. True, if this user is a Telegram Premium user
	IsPremium bool `json:"is_premium,omitempty"`

	// AddedToAttachmentMenu - Optional. True, if this user added the bot to the attachment menu
	AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"`

	// CanJoinGroups - Optional. True, if the bot can be invited to groups. Returned only in getMe
	// (https://core.telegram.org/bots/api#getme).
	CanJoinGroups bool `json:"can_join_groups,omitempty"`

	// CanReadAllGroupMessages - Optional. True, if privacy mode
	// (https://core.telegram.org/bots/features#privacy-mode) is disabled for the bot. Returned only in getMe
	// (https://core.telegram.org/bots/api#getme).
	CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"`

	// SupportsInlineQueries - Optional. True, if the bot supports inline queries. Returned only in getMe
	// (https://core.telegram.org/bots/api#getme).
	SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"`

	// CanConnectToBusiness - Optional. True, if the bot can be connected to a Telegram Business account to
	// receive its messages. Returned only in getMe (https://core.telegram.org/bots/api#getme).
	CanConnectToBusiness bool `json:"can_connect_to_business,omitempty"`

	// HasMainWebApp - Optional. True, if the bot has a main Web App. Returned only in getMe
	// (https://core.telegram.org/bots/api#getme).
	HasMainWebApp bool `json:"has_main_web_app,omitempty"`

	// HasTopicsEnabled - Optional. True, if the bot has forum topic mode enabled in private chats. Returned
	// only in getMe (https://core.telegram.org/bots/api#getme).
	HasTopicsEnabled bool `json:"has_topics_enabled,omitempty"`
}

User - This object represents a Telegram user or bot.

type UserChatBoosts added in v0.29.0 

type UserChatBoosts struct {
	// Boosts - The list of boosts added to the chat by the user
	Boosts []ChatBoost `json:"boosts"`
}

UserChatBoosts - This object represents a list of boosts added to a chat by a user.

type UserProfilePhotos 

type UserProfilePhotos struct {
	// TotalCount - Total number of profile pictures the target user has
	TotalCount int `json:"total_count"`

	// Photos - Requested profile pictures (in up to 4 sizes each)
	Photos [][]PhotoSize `json:"photos"`
}

UserProfilePhotos - This object represent a user's profile pictures.

type UserRating added in v1.4.0 

type UserRating struct {
	// Level - Current level of the user, indicating their reliability when purchasing digital goods and
	// services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.
	Level int `json:"level"`

	// Rating - Numerical value of the user's rating; the higher the rating, the better
	Rating int `json:"rating"`

	// CurrentLevelRating - The rating value required to get the current level
	CurrentLevelRating int `json:"current_level_rating"`

	// NextLevelRating - Optional. The rating value required to get to the next level; omitted if the maximum
	// level was reached
	NextLevelRating int `json:"next_level_rating,omitempty"`
}

UserRating - This object describes the rating of a user based on their Telegram Star spendings.

type UsersShared added in v0.29.0 

type UsersShared struct {
	// RequestID - Identifier of the request
	RequestID int `json:"request_id"`

	// Users - Information about users shared with the bot.
	Users []SharedUser `json:"users"`
}

UsersShared - This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers (https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.

type Venue 

type Venue struct {
	// Location - Venue location. Can't be a live location
	Location Location `json:"location"`

	// Title - Name of the venue
	Title string `json:"title"`

	// Address - Address of the venue
	Address string `json:"address"`

	// FoursquareID - Optional. Foursquare identifier of the venue
	FoursquareID string `json:"foursquare_id,omitempty"`

	// FoursquareType - Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”,
	// “arts_entertainment/aquarium” or “food/icecream”.)
	FoursquareType string `json:"foursquare_type,omitempty"`

	// 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
	// (https://developers.google.com/places/web-service/supported_types).)
	GooglePlaceType string `json:"google_place_type,omitempty"`
}

Venue - This object represents a venue.

type VerifyChatParams added in v0.32.0 

type VerifyChatParams struct {
	// ChatID - Unique identifier for the target chat or username of the target channel (in the format
	// @channel_username). Channel direct messages chats can't be verified.
	ChatID ChatID `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"`
}

VerifyChatParams - Represents parameters of verifyChat method.

func (*VerifyChatParams) WithChatID added in v0.32.0 

func (p *VerifyChatParams) WithChatID(chatID ChatID) *VerifyChatParams

WithChatID adds chat ID parameter

func (*VerifyChatParams) WithCustomDescription added in v0.32.0 

func (p *VerifyChatParams) WithCustomDescription(customDescription string) *VerifyChatParams

WithCustomDescription adds custom description parameter

type VerifyUserParams added in v0.32.0 

type VerifyUserParams struct {
	// UserID - 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"`
}

VerifyUserParams - Represents parameters of verifyUser method.

func (*VerifyUserParams) WithCustomDescription added in v0.32.0 

func (p *VerifyUserParams) WithCustomDescription(customDescription string) *VerifyUserParams

WithCustomDescription adds custom description parameter

func (*VerifyUserParams) WithUserID added in v1.1.0 

func (p *VerifyUserParams) WithUserID(userID int64) *VerifyUserParams

WithUserID adds user ID parameter

type Video 

type Video struct {
	// 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 - 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. 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"`

	// StartTimestamp - Optional. Timestamp in seconds from which the video will play in the message
	StartTimestamp int `json:"start_timestamp,omitempty"`

	// 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"`
}

Video - This object represents a video file.

type VideoChatEnded added in v0.11.0 

type VideoChatEnded struct {
	// Duration - Video chat duration in seconds
	Duration int `json:"duration"`
}

VideoChatEnded - This object represents a service message about a video chat ended in the chat.

type VideoChatParticipantsInvited added in v0.11.0 

type VideoChatParticipantsInvited struct {
	// Users - New members that were invited to the video chat
	Users []User `json:"users"`
}

VideoChatParticipantsInvited - This object represents a service message about new members invited to a video chat.

type VideoChatScheduled added in v0.11.0 

type VideoChatScheduled struct {
	// StartDate - Point in time (Unix timestamp) when the video chat is supposed to be started by a chat
	// administrator
	StartDate int64 `json:"start_date"`
}

VideoChatScheduled - This object represents a service message about a video chat scheduled in the chat.

type VideoChatStarted added in v0.11.0 

type VideoChatStarted struct{}

VideoChatStarted - This object represents a service message about a video chat started in the chat. Currently holds no information.

type VideoNote 

type VideoNote struct {
	// 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 int `json:"file_size,omitempty"`
}

VideoNote - This object represents a video message (https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of v.4.0 (https://telegram.org/blog/video-messages-and-telescope)).

type Voice 

type Voice struct {
	// 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 - 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 int64 `json:"file_size,omitempty"`
}

Voice - This object represents a voice note.

type WebAppData added in v0.11.0 

type WebAppData struct {
	// Data - The data. Be aware that a bad client can send arbitrary data in this field.
	Data string `json:"data"`

	// ButtonText - Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad
	// client can send arbitrary data in this field.
	ButtonText string `json:"button_text"`
}

WebAppData - Describes data sent from a Web App (https://core.telegram.org/bots/webapps) to the bot.

type WebAppInfo added in v0.11.0 

type WebAppInfo struct {
	// URL - An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
	// (https://core.telegram.org/bots/webapps#initializing-mini-apps)
	URL string `json:"url"`
}

WebAppInfo - Describes a Web App (https://core.telegram.org/bots/webapps).

type WebhookHandler added in v0.25.0 

type WebhookHandler func(ctx context.Context, data []byte) error

WebhookHandler user handler for incoming updates, context will be passed into update, user is responsible go pass JSON data of update from his own server, and it will be decoded and returned to update chan, also user is responsible for validating request (and secret token from headers)

Warning: Common approach of HTTP servers is to cancel context once request connection is closed, but in webhook handler update is sent to the channel and not processed in request lifetime, so remember to wrap context in context.WithoutCancel as webhook helper will not do that automatically

type WebhookInfo 

type WebhookInfo struct {
	// URL - Webhook URL, may be empty if webhook is not set up
	URL string `json:"url"`

	// HasCustomCertificate - True, if a custom certificate was provided for webhook certificate checks
	HasCustomCertificate bool `json:"has_custom_certificate"`

	// PendingUpdateCount - Number of updates awaiting delivery
	PendingUpdateCount int `json:"pending_update_count"`

	// IPAddress - Optional. Currently used webhook IP address
	IPAddress string `json:"ip_address,omitempty"`

	// LastErrorDate - Optional. Unix time for the most recent error that happened when trying to deliver an
	// update via webhook
	LastErrorDate int64 `json:"last_error_date,omitempty"`

	// LastErrorMessage - Optional. Error message in human-readable format for the most recent error that
	// happened when trying to deliver an update via webhook
	LastErrorMessage string `json:"last_error_message,omitempty"`

	// LastSynchronizationErrorDate - Optional. Unix time of the most recent error that happened when trying to
	// synchronize available updates with Telegram datacenters
	LastSynchronizationErrorDate int64 `json:"last_synchronization_error_date,omitempty"`

	// MaxConnections - Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook
	// for update delivery
	MaxConnections int `json:"max_connections,omitempty"`

	// AllowedUpdates - Optional. A list of update types the bot is subscribed to. Defaults to all update types
	// except chat_member
	AllowedUpdates []string `json:"allowed_updates,omitempty"`
}

WebhookInfo - Describes the current status of a webhook.

type WebhookOption added in v0.15.0 

type WebhookOption func(bot *Bot, ctx *webhook) error

WebhookOption represents an option that can be applied to webhook

func WithWebhookBuffer added in v0.15.0 

func WithWebhookBuffer(chanBuffer uint) WebhookOption

WithWebhookBuffer sets buffering for update chan. Default is 128.

func WithWebhookSet added in v0.20.0 

func WithWebhookSet(ctx context.Context, params *SetWebhookParams) WebhookOption

WithWebhookSet calls Bot.SetWebhook method before starting webhook Note: Calling Bot.SetWebhook method multiple times in a row may give "too many requests" errors

type WriteAccessAllowed added in v0.18.1 

type WriteAccessAllowed struct {
	// FromRequest - Optional. True, if the access was granted after the user accepted an explicit request from
	// a Web App sent by the method requestWriteAccess
	// (https://core.telegram.org/bots/webapps#initializing-mini-apps)
	FromRequest bool `json:"from_request,omitempty"`

	// WebAppName - Optional. Name of the Web App, if the access was granted when the Web App was launched from
	// a link
	WebAppName string `json:"web_app_name,omitempty"`

	// FromAttachmentMenu - Optional. True, if the access was granted when the bot was added to the attachment
	// or side menu
	FromAttachmentMenu bool `json:"from_attachment_menu,omitempty"`
}

WriteAccessAllowed - This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess (https://core.telegram.org/bots/webapps#initializing-mini-apps).

Source Files

View all Source files

Directories

Path Synopsis
examples module
internal
json
test command
Package telegoapi provides an API for calling Telegram for Telego.
 Package telegoapi provides an API for calling Telegram for Telego.
mock
Package mock is a generated GoMock package.
 Package mock is a generated GoMock package.
Package telegohandler provides handlers and predicates for Telego.
 Package telegohandler provides handlers and predicates for Telego.
Package telegoutil provides utility methods for Telego.
 Package telegoutil provides utility methods for Telego.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.