telegram-bot-api/configs.go

1718 lines
40 KiB
Go
Raw Normal View History

2015-11-20 11:42:26 +01:00
package tgbotapi
import (
2015-11-20 12:19:37 +01:00
"encoding/json"
2015-11-20 11:42:26 +01:00
"io"
"net/url"
2015-11-20 12:06:51 +01:00
"strconv"
2015-11-20 11:42:26 +01:00
)
// Telegram constants
const (
// APIEndpoint is the endpoint for all API methods,
// with formatting for Sprintf.
2015-11-20 11:42:26 +01:00
APIEndpoint = "https://api.telegram.org/bot%s/%s"
// FileEndpoint is the endpoint for downloading a file from Telegram.
2015-11-20 11:42:26 +01:00
FileEndpoint = "https://api.telegram.org/file/bot%s/%s"
)
// Constant values for ChatActions
const (
ChatTyping = "typing"
ChatUploadPhoto = "upload_photo"
ChatRecordVideo = "record_video"
ChatUploadVideo = "upload_video"
ChatRecordAudio = "record_audio"
ChatUploadAudio = "upload_audio"
ChatUploadDocument = "upload_document"
ChatFindLocation = "find_location"
)
// API errors
const (
// ErrAPIForbidden happens when a token is bad
ErrAPIForbidden = "forbidden"
2015-11-20 11:42:26 +01:00
)
// Constant values for ParseMode in MessageConfig
const (
ModeMarkdown = "Markdown"
ModeHTML = "HTML"
2015-11-20 11:42:26 +01:00
)
// Library errors
const (
// ErrBadFileType happens when you pass an unknown type
ErrBadFileType = "bad file type"
2016-04-14 00:06:18 +02:00
ErrBadURL = "bad or empty url"
)
// Chattable is any config type that can be sent.
2015-11-20 15:08:53 +01:00
type Chattable interface {
values() (url.Values, error)
method() string
2015-11-20 15:08:53 +01:00
}
// Fileable is any config type that can be sent that includes a file.
2015-11-20 15:08:53 +01:00
type Fileable interface {
Chattable
params() (map[string]string, error)
name() string
getFile() interface{}
useExistingFile() bool
2015-11-20 15:08:53 +01:00
}
// BaseChat is base type for all chat config types.
2015-11-20 15:08:53 +01:00
type BaseChat struct {
2016-03-24 19:22:40 +01:00
ChatID int64 // required
ChannelUsername string
ReplyToMessageID int
ReplyMarkup interface{}
DisableNotification bool
2015-11-20 11:42:26 +01:00
}
// values returns url.Values representation of BaseChat
func (chat *BaseChat) values() (url.Values, error) {
2015-11-20 12:06:51 +01:00
v := url.Values{}
2015-11-20 15:08:53 +01:00
if chat.ChannelUsername != "" {
v.Add("chat_id", chat.ChannelUsername)
2015-11-20 12:06:51 +01:00
} else {
2016-03-24 19:22:40 +01:00
v.Add("chat_id", strconv.FormatInt(chat.ChatID, 10))
2015-11-20 12:06:51 +01:00
}
2015-11-20 16:30:50 +01:00
if chat.ReplyToMessageID != 0 {
v.Add("reply_to_message_id", strconv.Itoa(chat.ReplyToMessageID))
}
if chat.ReplyMarkup != nil {
data, err := json.Marshal(chat.ReplyMarkup)
if err != nil {
return v, err
}
v.Add("reply_markup", string(data))
}
v.Add("disable_notification", strconv.FormatBool(chat.DisableNotification))
2015-11-20 12:06:51 +01:00
return v, nil
}
// BaseFile is a base type for all file config types.
2015-11-20 15:08:53 +01:00
type BaseFile struct {
BaseChat
File interface{}
FileID string
UseExisting bool
MimeType string
FileSize int
2015-11-20 15:08:53 +01:00
}
// params returns a map[string]string representation of BaseFile.
func (file BaseFile) params() (map[string]string, error) {
2015-11-20 15:08:53 +01:00
params := make(map[string]string)
if file.ChannelUsername != "" {
params["chat_id"] = file.ChannelUsername
} else {
2016-03-24 19:22:40 +01:00
params["chat_id"] = strconv.FormatInt(file.ChatID, 10)
2015-11-20 15:08:53 +01:00
}
2015-11-20 16:30:50 +01:00
if file.ReplyToMessageID != 0 {
params["reply_to_message_id"] = strconv.Itoa(file.ReplyToMessageID)
}
if file.ReplyMarkup != nil {
data, err := json.Marshal(file.ReplyMarkup)
if err != nil {
return params, err
}
params["reply_markup"] = string(data)
}
if file.MimeType != "" {
params["mime_type"] = file.MimeType
}
if file.FileSize > 0 {
params["file_size"] = strconv.Itoa(file.FileSize)
}
params["disable_notification"] = strconv.FormatBool(file.DisableNotification)
2015-11-20 15:08:53 +01:00
return params, nil
}
// getFile returns the file.
func (file BaseFile) getFile() interface{} {
2016-01-04 05:48:52 +01:00
return file.File
2015-11-20 15:08:53 +01:00
}
// useExistingFile returns if the BaseFile has already been uploaded.
func (file BaseFile) useExistingFile() bool {
2015-11-20 15:31:01 +01:00
return file.UseExisting
}
2016-04-12 19:53:19 +02:00
// BaseEdit is base type of all chat edits.
type BaseEdit struct {
ChatID int64
ChannelUsername string
MessageID int
InlineMessageID string
ReplyMarkup *InlineKeyboardMarkup
}
func (edit BaseEdit) values() (url.Values, error) {
v := url.Values{}
if edit.InlineMessageID == "" {
if edit.ChannelUsername != "" {
v.Add("chat_id", edit.ChannelUsername)
} else {
v.Add("chat_id", strconv.FormatInt(edit.ChatID, 10))
}
v.Add("message_id", strconv.Itoa(edit.MessageID))
2016-04-12 19:53:19 +02:00
} else {
v.Add("inline_message_id", edit.InlineMessageID)
2016-04-12 19:53:19 +02:00
}
if edit.ReplyMarkup != nil {
data, err := json.Marshal(edit.ReplyMarkup)
if err != nil {
return v, err
}
v.Add("reply_markup", string(data))
}
return v, nil
}
2015-11-20 11:42:26 +01:00
// MessageConfig contains information about a SendMessage request.
type MessageConfig struct {
2015-11-20 15:08:53 +01:00
BaseChat
2015-11-20 11:42:26 +01:00
Text string
ParseMode string
DisableWebPagePreview bool
}
// values returns a url.Values representation of MessageConfig.
func (config MessageConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add("text", config.Text)
v.Add("disable_web_page_preview", strconv.FormatBool(config.DisableWebPagePreview))
if config.ParseMode != "" {
v.Add("parse_mode", config.ParseMode)
}
return v, nil
}
// method returns Telegram API method name for sending Message.
func (config MessageConfig) method() string {
return "sendMessage"
2015-11-20 15:55:32 +01:00
}
2015-11-20 11:42:26 +01:00
// ForwardConfig contains information about a ForwardMessage request.
type ForwardConfig struct {
2015-11-20 15:08:53 +01:00
BaseChat
2016-03-24 19:22:40 +01:00
FromChatID int64 // required
2015-11-20 11:42:26 +01:00
FromChannelUsername string
MessageID int // required
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of ForwardConfig.
func (config ForwardConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2016-03-24 19:22:40 +01:00
v.Add("from_chat_id", strconv.FormatInt(config.FromChatID, 10))
2015-11-20 12:06:51 +01:00
v.Add("message_id", strconv.Itoa(config.MessageID))
return v, nil
}
// method returns Telegram API method name for sending Forward.
func (config ForwardConfig) method() string {
2015-11-20 15:55:32 +01:00
return "forwardMessage"
}
2015-11-20 11:42:26 +01:00
// PhotoConfig contains information about a SendPhoto request.
type PhotoConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
2015-11-20 16:30:50 +01:00
Caption string
2015-11-20 11:42:26 +01:00
}
// Params returns a map[string]string representation of PhotoConfig.
func (config PhotoConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
if config.Caption != "" {
params["caption"] = config.Caption
}
return params, nil
}
// Values returns a url.Values representation of PhotoConfig.
func (config PhotoConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2015-11-20 12:06:51 +01:00
if config.Caption != "" {
v.Add("caption", config.Caption)
}
return v, nil
}
// name returns the field name for the Photo.
func (config PhotoConfig) name() string {
2015-11-20 15:31:01 +01:00
return "photo"
}
// method returns Telegram API method name for sending Photo.
func (config PhotoConfig) method() string {
return "sendPhoto"
2015-11-20 15:55:32 +01:00
}
2015-11-20 11:42:26 +01:00
// AudioConfig contains information about a SendAudio request.
type AudioConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
Caption string
2015-11-20 16:30:50 +01:00
Duration int
Performer string
Title string
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of AudioConfig.
func (config AudioConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2015-11-20 12:06:51 +01:00
if config.Duration != 0 {
v.Add("duration", strconv.Itoa(config.Duration))
}
if config.Performer != "" {
v.Add("performer", config.Performer)
}
if config.Title != "" {
v.Add("title", config.Title)
}
if config.Caption != "" {
v.Add("caption", config.Caption)
}
2015-11-20 12:06:51 +01:00
return v, nil
}
// params returns a map[string]string representation of AudioConfig.
func (config AudioConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
if config.Duration != 0 {
params["duration"] = strconv.Itoa(config.Duration)
}
if config.Performer != "" {
params["performer"] = config.Performer
}
if config.Title != "" {
params["title"] = config.Title
}
if config.Caption != "" {
params["caption"] = config.Caption
}
2015-11-20 15:08:53 +01:00
return params, nil
}
// name returns the field name for the Audio.
func (config AudioConfig) name() string {
2015-11-20 15:31:01 +01:00
return "audio"
}
// method returns Telegram API method name for sending Audio.
func (config AudioConfig) method() string {
return "sendAudio"
2015-11-20 15:55:32 +01:00
}
2015-11-20 11:42:26 +01:00
// DocumentConfig contains information about a SendDocument request.
type DocumentConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
2017-02-11 15:13:49 +01:00
Caption string
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of DocumentConfig.
func (config DocumentConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2017-02-11 15:13:49 +01:00
if config.Caption != "" {
v.Add("caption", config.Caption)
}
2015-11-20 12:06:51 +01:00
return v, nil
}
// params returns a map[string]string representation of DocumentConfig.
func (config DocumentConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
2017-02-11 15:13:49 +01:00
if config.Caption != "" {
params["caption"] = config.Caption
}
2015-11-20 15:08:53 +01:00
return params, nil
}
// name returns the field name for the Document.
func (config DocumentConfig) name() string {
2015-11-20 15:31:01 +01:00
return "document"
}
// method returns Telegram API method name for sending Document.
func (config DocumentConfig) method() string {
2015-11-20 15:55:32 +01:00
return "sendDocument"
}
2015-11-20 11:42:26 +01:00
// StickerConfig contains information about a SendSticker request.
type StickerConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of StickerConfig.
func (config StickerConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2015-11-20 12:06:51 +01:00
return v, nil
}
// params returns a map[string]string representation of StickerConfig.
func (config StickerConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
return params, nil
}
// name returns the field name for the Sticker.
func (config StickerConfig) name() string {
2015-11-20 15:31:01 +01:00
return "sticker"
}
// method returns Telegram API method name for sending Sticker.
func (config StickerConfig) method() string {
2015-11-20 15:55:32 +01:00
return "sendSticker"
}
2015-11-20 11:42:26 +01:00
// VideoConfig contains information about a SendVideo request.
type VideoConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
2015-11-20 16:30:50 +01:00
Duration int
Caption string
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of VideoConfig.
func (config VideoConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2015-11-20 12:06:51 +01:00
if config.Duration != 0 {
v.Add("duration", strconv.Itoa(config.Duration))
}
if config.Caption != "" {
v.Add("caption", config.Caption)
}
return v, nil
}
// params returns a map[string]string representation of VideoConfig.
func (config VideoConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
2017-05-14 11:11:44 +02:00
if config.Caption != "" {
params["caption"] = config.Caption
}
2015-11-20 15:08:53 +01:00
return params, nil
}
// name returns the field name for the Video.
func (config VideoConfig) name() string {
2015-11-20 16:30:50 +01:00
return "video"
2015-11-20 15:31:01 +01:00
}
// method returns Telegram API method name for sending Video.
func (config VideoConfig) method() string {
2015-11-20 15:55:32 +01:00
return "sendVideo"
}
2017-05-22 00:04:12 +02:00
// VideoNoteConfig contains information about a SendVideoNote request.
type VideoNoteConfig struct {
BaseFile
Duration int
Length int
}
// values returns a url.Values representation of VideoNoteConfig.
func (config VideoNoteConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
v.Add(config.name(), config.FileID)
if config.Duration != 0 {
v.Add("duration", strconv.Itoa(config.Duration))
}
// Telegram API seems to have a bug, if no length is provided or it is 0, it will send an error response
if config.Length != 0 {
v.Add("length", strconv.Itoa(config.Length))
}
return v, nil
}
// params returns a map[string]string representation of VideoNoteConfig.
func (config VideoNoteConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
if config.Length != 0 {
params["length"] = strconv.Itoa(config.Length)
}
if config.Duration != 0 {
params["duration"] = strconv.Itoa(config.Duration)
}
return params, nil
}
// name returns the field name for the VideoNote.
func (config VideoNoteConfig) name() string {
return "video_note"
}
// method returns Telegram API method name for sending VideoNote.
func (config VideoNoteConfig) method() string {
return "sendVideoNote"
}
2015-11-20 11:42:26 +01:00
// VoiceConfig contains information about a SendVoice request.
type VoiceConfig struct {
2015-11-20 15:08:53 +01:00
BaseFile
Caption string
2015-11-20 16:30:50 +01:00
Duration int
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of VoiceConfig.
func (config VoiceConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add(config.name(), config.FileID)
2015-11-20 12:06:51 +01:00
if config.Duration != 0 {
v.Add("duration", strconv.Itoa(config.Duration))
}
if config.Caption != "" {
v.Add("caption", config.Caption)
}
2015-11-20 12:06:51 +01:00
return v, nil
}
// params returns a map[string]string representation of VoiceConfig.
func (config VoiceConfig) params() (map[string]string, error) {
params, _ := config.BaseFile.params()
2015-11-20 15:08:53 +01:00
if config.Duration != 0 {
params["duration"] = strconv.Itoa(config.Duration)
}
if config.Caption != "" {
params["caption"] = config.Caption
}
2015-11-20 15:08:53 +01:00
return params, nil
}
// name returns the field name for the Voice.
func (config VoiceConfig) name() string {
2015-11-20 15:31:01 +01:00
return "voice"
}
// method returns Telegram API method name for sending Voice.
func (config VoiceConfig) method() string {
2015-11-20 15:55:32 +01:00
return "sendVoice"
}
2015-11-20 11:42:26 +01:00
// LocationConfig contains information about a SendLocation request.
type LocationConfig struct {
2015-11-20 15:08:53 +01:00
BaseChat
2017-10-13 16:00:04 +02:00
Latitude float64 // required
Longitude float64 // required
LivePeriod int // optional
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of LocationConfig.
func (config LocationConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add("latitude", strconv.FormatFloat(config.Latitude, 'f', 6, 64))
v.Add("longitude", strconv.FormatFloat(config.Longitude, 'f', 6, 64))
2017-10-13 16:00:04 +02:00
if config.LivePeriod != 0 {
v.Add("live_period", strconv.Itoa(config.LivePeriod))
}
2015-11-20 12:19:37 +01:00
2015-11-20 12:06:51 +01:00
return v, nil
}
// method returns Telegram API method name for sending Location.
func (config LocationConfig) method() string {
2015-11-20 15:55:32 +01:00
return "sendLocation"
}
// LocationConfig contains information about a SendLocation request.
type EditMessageLiveLocationConfig struct {
BaseEdit
Latitude float64 // required
Longitude float64 // required
}
// values returns a url.Values representation of EditMessageLiveLocationConfig.
func (config EditMessageLiveLocationConfig) values() (url.Values, error) {
v, err := config.BaseEdit.values()
if err != nil {
return v, err
}
v.Add("latitude", strconv.FormatFloat(config.Latitude, 'f', 6, 64))
v.Add("longitude", strconv.FormatFloat(config.Longitude, 'f', 6, 64))
return v, nil
}
// method returns Telegram API method name for edit message Live Location.
func (config EditMessageLiveLocationConfig) method() string {
return "editMessageLiveLocation"
}
// LocationConfig contains information about a StopMessageLiveLocation request.
type StopMessageLiveLocationConfig struct {
BaseEdit
}
// values returns a url.Values representation of StopMessageLiveLocationConfig.
func (config StopMessageLiveLocationConfig) values() (url.Values, error) {
v, err := config.BaseEdit.values()
if err != nil {
return v, err
}
return v, nil
}
// method returns Telegram API method name for stop message Live Location.
func (config StopMessageLiveLocationConfig) method() string {
return "stopMessageLiveLocation"
}
2016-04-12 15:28:46 +02:00
// VenueConfig contains information about a SendVenue request.
type VenueConfig struct {
BaseChat
Latitude float64 // required
Longitude float64 // required
Title string // required
Address string // required
FoursquareID string
}
func (config VenueConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2016-04-12 15:28:46 +02:00
v.Add("latitude", strconv.FormatFloat(config.Latitude, 'f', 6, 64))
v.Add("longitude", strconv.FormatFloat(config.Longitude, 'f', 6, 64))
v.Add("title", config.Title)
v.Add("address", config.Address)
if config.FoursquareID != "" {
v.Add("foursquare_id", config.FoursquareID)
}
return v, nil
}
func (config VenueConfig) method() string {
return "sendVenue"
}
2016-04-12 20:02:08 +02:00
// ContactConfig allows you to send a contact.
type ContactConfig struct {
BaseChat
PhoneNumber string
FirstName string
LastName string
}
func (config ContactConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2016-04-12 20:02:08 +02:00
v.Add("phone_number", config.PhoneNumber)
v.Add("first_name", config.FirstName)
v.Add("last_name", config.LastName)
return v, nil
}
func (config ContactConfig) method() string {
return "sendContact"
}
// GameConfig allows you to send a game.
type GameConfig struct {
BaseChat
GameShortName string
}
func (config GameConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
v.Add("game_short_name", config.GameShortName)
return v, nil
}
func (config GameConfig) method() string {
return "sendGame"
}
// SetGameScoreConfig allows you to update the game score in a chat.
type SetGameScoreConfig struct {
UserID int
Score int
Force bool
DisableEditMessage bool
ChatID int
ChannelUsername string
MessageID int
InlineMessageID string
}
func (config SetGameScoreConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("user_id", strconv.Itoa(config.UserID))
v.Add("score", strconv.Itoa(config.Score))
if config.InlineMessageID == "" {
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.Itoa(config.ChatID))
} else {
v.Add("chat_id", config.ChannelUsername)
}
v.Add("message_id", strconv.Itoa(config.MessageID))
} else {
v.Add("inline_message_id", config.InlineMessageID)
}
v.Add("disable_edit_message", strconv.FormatBool(config.DisableEditMessage))
return v, nil
}
func (config SetGameScoreConfig) method() string {
return "setGameScore"
}
// GetGameHighScoresConfig allows you to fetch the high scores for a game.
type GetGameHighScoresConfig struct {
UserID int
ChatID int
ChannelUsername string
MessageID int
InlineMessageID string
}
func (config GetGameHighScoresConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("user_id", strconv.Itoa(config.UserID))
if config.InlineMessageID == "" {
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.Itoa(config.ChatID))
} else {
v.Add("chat_id", config.ChannelUsername)
}
v.Add("message_id", strconv.Itoa(config.MessageID))
} else {
v.Add("inline_message_id", config.InlineMessageID)
}
return v, nil
}
func (config GetGameHighScoresConfig) method() string {
return "getGameHighScores"
}
2015-11-20 11:42:26 +01:00
// ChatActionConfig contains information about a SendChatAction request.
type ChatActionConfig struct {
2015-11-20 15:08:53 +01:00
BaseChat
Action string // required
2015-11-20 11:42:26 +01:00
}
// values returns a url.Values representation of ChatActionConfig.
func (config ChatActionConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
2015-11-20 12:06:51 +01:00
v.Add("action", config.Action)
return v, nil
}
// method returns Telegram API method name for sending ChatAction.
func (config ChatActionConfig) method() string {
2015-11-21 12:44:26 +01:00
return "sendChatAction"
}
2016-04-12 19:53:19 +02:00
// EditMessageTextConfig allows you to modify the text in a message.
type EditMessageTextConfig struct {
BaseEdit
Text string
ParseMode string
DisableWebPagePreview bool
}
func (config EditMessageTextConfig) values() (url.Values, error) {
v, err := config.BaseEdit.values()
if err != nil {
return v, err
}
2016-04-12 19:53:19 +02:00
v.Add("text", config.Text)
v.Add("parse_mode", config.ParseMode)
v.Add("disable_web_page_preview", strconv.FormatBool(config.DisableWebPagePreview))
return v, nil
}
func (config EditMessageTextConfig) method() string {
return "editMessageText"
}
// EditMessageCaptionConfig allows you to modify the caption of a message.
type EditMessageCaptionConfig struct {
BaseEdit
Caption string
2016-04-12 19:53:19 +02:00
}
func (config EditMessageCaptionConfig) values() (url.Values, error) {
v, _ := config.BaseEdit.values()
v.Add("caption", config.Caption)
return v, nil
}
func (config EditMessageCaptionConfig) method() string {
return "editMessageCaption"
}
// EditMessageReplyMarkupConfig allows you to modify the reply markup
2016-04-12 19:53:19 +02:00
// of a message.
type EditMessageReplyMarkupConfig struct {
2016-04-12 19:53:19 +02:00
BaseEdit
}
func (config EditMessageReplyMarkupConfig) values() (url.Values, error) {
2016-04-12 19:53:19 +02:00
return config.BaseEdit.values()
}
func (config EditMessageReplyMarkupConfig) method() string {
2016-04-12 19:53:19 +02:00
return "editMessageReplyMarkup"
}
// UserProfilePhotosConfig contains information about a
// GetUserProfilePhotos request.
2015-11-20 11:42:26 +01:00
type UserProfilePhotosConfig struct {
UserID int
Offset int
Limit int
}
// FileConfig has information about a file hosted on Telegram.
2015-11-20 11:42:26 +01:00
type FileConfig struct {
FileID string
}
// UpdateConfig contains information about a GetUpdates request.
type UpdateConfig struct {
Offset int
Limit int
Timeout int
}
// WebhookConfig contains information about a SetWebhook request.
type WebhookConfig struct {
URL *url.URL
Certificate interface{}
MaxConnections int
2015-11-20 11:42:26 +01:00
}
func (config WebhookConfig) method() string {
return "setWebhook"
}
func (config WebhookConfig) values() (url.Values, error) {
v := url.Values{}
if config.URL != nil {
v.Add("url", config.URL.String())
}
if config.MaxConnections != 0 {
v.Add("max_connections", strconv.Itoa(config.MaxConnections))
}
return v, nil
}
func (config WebhookConfig) params() (map[string]string, error) {
params := make(map[string]string)
if config.URL != nil {
params["url"] = config.URL.String()
}
if config.MaxConnections != 0 {
params["max_connections"] = strconv.Itoa(config.MaxConnections)
}
return params, nil
}
func (config WebhookConfig) name() string {
return "certificate"
}
func (config WebhookConfig) getFile() interface{} {
return config.Certificate
}
func (config WebhookConfig) useExistingFile() bool {
return config.URL != nil
}
// RemoveWebhookConfig is a helper to remove a webhook.
type RemoveWebhookConfig struct {
}
func (config RemoveWebhookConfig) method() string {
return "setWebhook"
}
func (config RemoveWebhookConfig) values() (url.Values, error) {
return url.Values{}, nil
}
// FileBytes contains information about a set of bytes to upload
// as a File.
2015-11-20 11:42:26 +01:00
type FileBytes struct {
Name string
Bytes []byte
}
// FileReader contains information about a reader to upload as a File.
// If Size is -1, it will read the entire Reader into memory to
// calculate a Size.
2015-11-20 11:42:26 +01:00
type FileReader struct {
Name string
Reader io.Reader
Size int64
}
// InlineConfig contains information on making an InlineQuery response.
type InlineConfig struct {
2016-04-12 15:28:46 +02:00
InlineQueryID string `json:"inline_query_id"`
Results []interface{} `json:"results"`
CacheTime int `json:"cache_time"`
IsPersonal bool `json:"is_personal"`
NextOffset string `json:"next_offset"`
SwitchPMText string `json:"switch_pm_text"`
SwitchPMParameter string `json:"switch_pm_parameter"`
}
func (config InlineConfig) method() string {
return "answerInlineQuery"
}
func (config InlineConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("inline_query_id", config.InlineQueryID)
v.Add("cache_time", strconv.Itoa(config.CacheTime))
v.Add("is_personal", strconv.FormatBool(config.IsPersonal))
v.Add("next_offset", config.NextOffset)
data, err := json.Marshal(config.Results)
if err != nil {
return v, err
}
v.Add("results", string(data))
v.Add("switch_pm_text", config.SwitchPMText)
v.Add("switch_pm_parameter", config.SwitchPMParameter)
return v, nil
}
2016-04-12 15:28:46 +02:00
// CallbackConfig contains information on making a CallbackQuery response.
type CallbackConfig struct {
CallbackQueryID string `json:"callback_query_id"`
Text string `json:"text"`
ShowAlert bool `json:"show_alert"`
URL string `json:"url"`
CacheTime int `json:"cache_time"`
}
func (config CallbackConfig) method() string {
return "answerCallbackQuery"
}
func (config CallbackConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("callback_query_id", config.CallbackQueryID)
if config.Text != "" {
v.Add("text", config.Text)
}
v.Add("show_alert", strconv.FormatBool(config.ShowAlert))
if config.URL != "" {
v.Add("url", config.URL)
}
v.Add("cache_time", strconv.Itoa(config.CacheTime))
return v, nil
}
2016-04-12 15:59:47 +02:00
// ChatMemberConfig contains information about a user in a chat for use
// with administrative functions such as kicking or unbanning a user.
type ChatMemberConfig struct {
ChatID int64
SuperGroupUsername string
ChannelUsername string
UserID int
}
2016-05-22 17:16:28 +02:00
// UnbanChatMemberConfig allows you to unban a user.
type UnbanChatMemberConfig struct {
ChatMemberConfig
}
func (config UnbanChatMemberConfig) method() string {
return "unbanChatMember"
}
func (config UnbanChatMemberConfig) values() (url.Values, error) {
v := url.Values{}
if config.SuperGroupUsername != "" {
v.Add("chat_id", config.SuperGroupUsername)
} else if config.ChannelUsername != "" {
v.Add("chat_id", config.ChannelUsername)
} else {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
}
v.Add("user_id", strconv.Itoa(config.UserID))
return v, nil
}
2017-07-01 06:34:09 +02:00
// KickChatMemberConfig contains extra fields to kick user
type KickChatMemberConfig struct {
ChatMemberConfig
UntilDate int64
}
func (config KickChatMemberConfig) method() string {
return "kickChatMember"
}
func (config KickChatMemberConfig) values() (url.Values, error) {
v := url.Values{}
if config.SuperGroupUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.SuperGroupUsername)
}
v.Add("user_id", strconv.Itoa(config.UserID))
if config.UntilDate != 0 {
v.Add("until_date", strconv.FormatInt(config.UntilDate, 10))
}
return v, nil
}
2017-07-01 06:34:09 +02:00
// RestrictChatMemberConfig contains fields to restrict members of chat
type RestrictChatMemberConfig struct {
ChatMemberConfig
UntilDate int64
CanSendMessages *bool
CanSendMediaMessages *bool
CanSendOtherMessages *bool
CanAddWebPagePreviews *bool
}
func (config RestrictChatMemberConfig) method() string {
return "restrictChatMember"
}
func (config RestrictChatMemberConfig) values() (url.Values, error) {
v := url.Values{}
if config.SuperGroupUsername != "" {
v.Add("chat_id", config.SuperGroupUsername)
} else if config.ChannelUsername != "" {
v.Add("chat_id", config.ChannelUsername)
} else {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
}
v.Add("user_id", strconv.Itoa(config.UserID))
if config.CanSendMessages != nil {
v.Add("can_send_messages", strconv.FormatBool(*config.CanSendMessages))
}
if config.CanSendMediaMessages != nil {
v.Add("can_send_media_messages", strconv.FormatBool(*config.CanSendMediaMessages))
}
if config.CanSendOtherMessages != nil {
v.Add("can_send_other_messages", strconv.FormatBool(*config.CanSendOtherMessages))
}
if config.CanAddWebPagePreviews != nil {
v.Add("can_add_web_page_previews", strconv.FormatBool(*config.CanAddWebPagePreviews))
}
if config.UntilDate != 0 {
v.Add("until_date", strconv.FormatInt(config.UntilDate, 10))
}
return v, nil
}
2017-07-01 06:34:09 +02:00
// PromoteChatMemberConfig contains fields to promote members of chat
type PromoteChatMemberConfig struct {
ChatMemberConfig
CanChangeInfo *bool
CanPostMessages *bool
CanEditMessages *bool
CanDeleteMessages *bool
CanInviteUsers *bool
CanRestrictMembers *bool
CanPinMessages *bool
CanPromoteMembers *bool
}
func (config PromoteChatMemberConfig) method() string {
return "promoteChatMember"
}
func (config PromoteChatMemberConfig) values() (url.Values, error) {
v := url.Values{}
if config.SuperGroupUsername != "" {
v.Add("chat_id", config.SuperGroupUsername)
} else if config.ChannelUsername != "" {
v.Add("chat_id", config.ChannelUsername)
} else {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
}
v.Add("user_id", strconv.Itoa(config.UserID))
if config.CanChangeInfo != nil {
v.Add("can_change_info", strconv.FormatBool(*config.CanChangeInfo))
}
if config.CanPostMessages != nil {
v.Add("can_post_messages", strconv.FormatBool(*config.CanPostMessages))
}
if config.CanEditMessages != nil {
v.Add("can_edit_messages", strconv.FormatBool(*config.CanEditMessages))
}
if config.CanDeleteMessages != nil {
v.Add("can_delete_messages", strconv.FormatBool(*config.CanDeleteMessages))
}
if config.CanInviteUsers != nil {
v.Add("can_invite_users", strconv.FormatBool(*config.CanInviteUsers))
}
if config.CanRestrictMembers != nil {
v.Add("can_restrict_members", strconv.FormatBool(*config.CanRestrictMembers))
}
if config.CanPinMessages != nil {
v.Add("can_pin_messages", strconv.FormatBool(*config.CanPinMessages))
}
if config.CanPromoteMembers != nil {
v.Add("can_promote_members", strconv.FormatBool(*config.CanPromoteMembers))
}
return v, nil
}
2016-05-22 17:16:28 +02:00
// ChatConfig contains information about getting information on a chat.
type ChatConfig struct {
ChatID int64
SuperGroupUsername string
}
// LeaveChatConfig allows you to leave a chat.
type LeaveChatConfig struct {
ChatID int64
ChannelUsername string
}
func (config LeaveChatConfig) method() string {
return "leaveChat"
}
func (config LeaveChatConfig) values() (url.Values, error) {
v := url.Values{}
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.ChannelUsername)
}
return v, nil
}
2016-05-22 17:16:28 +02:00
// ChatConfigWithUser contains information about getting information on
// a specific user within a chat.
type ChatConfigWithUser struct {
ChatID int64
SuperGroupUsername string
UserID int
}
2017-06-02 22:18:42 +02:00
2017-06-03 08:59:40 +02:00
// InvoiceConfig contains information for sendInvoice request.
2017-06-02 22:18:42 +02:00
type InvoiceConfig struct {
BaseChat
Title string // required
Description string // required
Payload string // required
ProviderToken string // required
StartParameter string // required
Currency string // required
Prices *[]LabeledPrice // required
2017-06-03 08:59:40 +02:00
PhotoURL string
2017-06-02 22:18:42 +02:00
PhotoSize int
PhotoWidth int
PhotoHeight int
NeedName bool
NeedPhoneNumber bool
NeedEmail bool
NeedShippingAddress bool
IsFlexible bool
}
func (config InvoiceConfig) values() (url.Values, error) {
v, err := config.BaseChat.values()
if err != nil {
return v, err
}
v.Add("title", config.Title)
v.Add("description", config.Description)
v.Add("payload", config.Payload)
v.Add("provider_token", config.ProviderToken)
v.Add("start_parameter", config.StartParameter)
v.Add("currency", config.Currency)
data, err := json.Marshal(config.Prices)
if err != nil {
return v, err
}
v.Add("prices", string(data))
2017-06-03 08:59:40 +02:00
if config.PhotoURL != "" {
v.Add("photo_url", config.PhotoURL)
2017-06-02 22:18:42 +02:00
}
if config.PhotoSize != 0 {
v.Add("photo_size", strconv.Itoa(config.PhotoSize))
}
if config.PhotoWidth != 0 {
v.Add("photo_width", strconv.Itoa(config.PhotoWidth))
}
if config.PhotoHeight != 0 {
v.Add("photo_height", strconv.Itoa(config.PhotoHeight))
}
if config.NeedName != false {
v.Add("need_name", strconv.FormatBool(config.NeedName))
}
if config.NeedPhoneNumber != false {
v.Add("need_phone_number", strconv.FormatBool(config.NeedPhoneNumber))
}
if config.NeedEmail != false {
v.Add("need_email", strconv.FormatBool(config.NeedEmail))
}
if config.NeedShippingAddress != false {
v.Add("need_shipping_address", strconv.FormatBool(config.NeedShippingAddress))
}
if config.IsFlexible != false {
v.Add("is_flexible", strconv.FormatBool(config.IsFlexible))
}
return v, nil
}
func (config InvoiceConfig) method() string {
return "sendInvoice"
}
2017-06-03 08:59:40 +02:00
// ShippingConfig contains information for answerShippingQuery request.
2017-06-02 22:18:42 +02:00
type ShippingConfig struct {
ShippingQueryID string // required
2017-06-03 08:59:40 +02:00
OK bool // required
2017-06-02 22:18:42 +02:00
ShippingOptions *[]ShippingOption
ErrorMessage string
}
2017-06-03 08:59:40 +02:00
// PreCheckoutConfig conatins information for answerPreCheckoutQuery request.
2017-06-02 22:18:42 +02:00
type PreCheckoutConfig struct {
PreCheckoutQueryID string // required
2017-06-03 08:59:40 +02:00
OK bool // required
2017-06-02 22:18:42 +02:00
ErrorMessage string
}
// DeleteMessageConfig contains information of a message in a chat to delete.
type DeleteMessageConfig struct {
ChatID int64
MessageID int
}
func (config DeleteMessageConfig) method() string {
return "deleteMessage"
}
func (config DeleteMessageConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
v.Add("message_id", strconv.Itoa(config.MessageID))
return v, nil
}
// PinChatMessageConfig contains information of a message in a chat to pin.
type PinChatMessageConfig struct {
ChatID int64
MessageID int
DisableNotification bool
}
func (config PinChatMessageConfig) method() string {
return "pinChatMessage"
}
func (config PinChatMessageConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
v.Add("message_id", strconv.Itoa(config.MessageID))
v.Add("disable_notification", strconv.FormatBool(config.DisableNotification))
return v, nil
}
// UnpinChatMessageConfig contains information of chat to unpin.
type UnpinChatMessageConfig struct {
ChatID int64
}
func (config UnpinChatMessageConfig) method() string {
return "unpinChatMessage"
}
func (config UnpinChatMessageConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
return v, nil
}
// SetChatPhotoConfig allows you to set a group, supergroup, or channel's photo.
type SetChatPhotoConfig struct {
ChatID int64
ChannelUsername string
Photo interface{}
}
func (config SetChatPhotoConfig) method() string {
return "setChatPhoto"
}
func (config SetChatPhotoConfig) name() string {
return "photo"
}
func (config SetChatPhotoConfig) values() (url.Values, error) {
v := url.Values{}
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.ChannelUsername)
}
return v, nil
}
func (config SetChatPhotoConfig) params() map[string]string {
params := make(map[string]string)
if config.ChannelUsername == "" {
params["chat_id"] = strconv.FormatInt(config.ChatID, 10)
} else {
params["chat_id"] = config.ChannelUsername
}
return params
}
func (config SetChatPhotoConfig) getFile() interface{} {
return config.Photo
}
func (config SetChatPhotoConfig) useExistingFile() bool {
return false
}
// DeleteChatPhotoConfig allows you to delete a group, supergroup, or channel's photo.
type DeleteChatPhotoConfig struct {
ChatID int64
ChannelUsername string
}
func (config DeleteChatPhotoConfig) method() string {
return "deleteChatPhoto"
}
func (config DeleteChatPhotoConfig) values() (url.Values, error) {
v := url.Values{}
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.ChannelUsername)
}
return v, nil
}
// SetChatTitleConfig allows you to set the title of something other than a private chat.
type SetChatTitleConfig struct {
ChatID int64
ChannelUsername string
Title string
}
func (config SetChatTitleConfig) method() string {
return "setChatTitle"
}
func (config SetChatTitleConfig) values() (url.Values, error) {
v := url.Values{}
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.ChannelUsername)
}
v.Add("title", config.Title)
return v, nil
}
// SetChatDescriptionConfig allows you to set the description of a supergroup or channel.
type SetChatDescriptionConfig struct {
ChatID int64
ChannelUsername string
Description string
}
func (config SetChatDescriptionConfig) method() string {
return "setChatDescription"
}
func (config SetChatDescriptionConfig) values() (url.Values, error) {
v := url.Values{}
if config.ChannelUsername == "" {
v.Add("chat_id", strconv.FormatInt(config.ChatID, 10))
} else {
v.Add("chat_id", config.ChannelUsername)
}
v.Add("description", config.Description)
return v, nil
}
// GetStickerSetConfig allows you to get the stickers in a set.
type GetStickerSetConfig struct {
Name string
}
func (config GetStickerSetConfig) method() string {
return "getStickerSet"
}
func (config GetStickerSetConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("name", config.Name)
return v, nil
}
// UploadStickerConfig allows you to upload a sticker for use in a set later.
type UploadStickerConfig struct {
UserID int64
PNGSticker interface{}
}
func (config UploadStickerConfig) method() string {
return "uploadStickerFile"
}
func (config UploadStickerConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("user_id", strconv.FormatInt(config.UserID, 10))
return v, nil
}
func (config UploadStickerConfig) params() (map[string]string, error) {
params := make(map[string]string)
params["user_id"] = strconv.FormatInt(config.UserID, 10)
return params, nil
}
func (config UploadStickerConfig) name() string {
return "png_sticker"
}
func (config UploadStickerConfig) getFile() interface{} {
return config.PNGSticker
}
func (config UploadStickerConfig) useExistingFile() bool {
return false
}
// NewStickerSetConfig allows creating a new sticker set.
type NewStickerSetConfig struct {
UserID int64
Name string
Title string
PNGSticker interface{}
Emojis string
ContainsMasks bool
MaskPosition *MaskPosition
}
func (config NewStickerSetConfig) method() string {
return "createNewStickerSet"
}
func (config NewStickerSetConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("user_id", strconv.FormatInt(config.UserID, 10))
v.Add("name", config.Name)
v.Add("title", config.Title)
if sticker, ok := config.PNGSticker.(string); ok {
v.Add("png_sticker", sticker)
}
v.Add("emojis", config.Emojis)
if config.ContainsMasks {
v.Add("contains_masks", strconv.FormatBool(config.ContainsMasks))
data, err := json.Marshal(config.MaskPosition)
if err != nil {
return v, err
}
v.Add("mask_position", string(data))
}
return v, nil
}
func (config NewStickerSetConfig) params() (map[string]string, error) {
params := make(map[string]string)
params["user_id"] = strconv.FormatInt(config.UserID, 10)
params["name"] = config.Name
params["title"] = config.Title
params["emojis"] = config.Emojis
if config.ContainsMasks {
params["contains_masks"] = strconv.FormatBool(config.ContainsMasks)
data, err := json.Marshal(config.MaskPosition)
if err != nil {
return params, err
}
params["mask_position"] = string(data)
}
return params, nil
}
func (config NewStickerSetConfig) getFile() interface{} {
return config.PNGSticker
}
func (config NewStickerSetConfig) name() string {
return "png_sticker"
}
func (config NewStickerSetConfig) useExistingFile() bool {
_, ok := config.PNGSticker.(string)
return ok
}
// AddStickerConfig allows you to add a sticker to a set.
type AddStickerConfig struct {
UserID int64
Name string
PNGSticker interface{}
Emojis string
MaskPosition *MaskPosition
}
func (config AddStickerConfig) method() string {
return "addStickerToSet"
}
func (config AddStickerConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("user_id", strconv.FormatInt(config.UserID, 10))
v.Add("name", config.Name)
if sticker, ok := config.PNGSticker.(string); ok {
v.Add("png_sticker", sticker)
}
v.Add("emojis", config.Emojis)
if config.MaskPosition != nil {
data, err := json.Marshal(config.MaskPosition)
if err != nil {
return v, err
}
v.Add("mask_position", string(data))
}
return v, nil
}
func (config AddStickerConfig) params() (map[string]string, error) {
params := make(map[string]string)
params["user_id"] = strconv.FormatInt(config.UserID, 10)
params["name"] = config.Name
params["emojis"] = config.Emojis
if config.MaskPosition != nil {
data, err := json.Marshal(config.MaskPosition)
if err != nil {
return params, err
}
params["mask_position"] = string(data)
}
return params, nil
}
func (config AddStickerConfig) name() string {
return "png_sticker"
}
func (config AddStickerConfig) getFile() interface{} {
return config.PNGSticker
}
func (config AddStickerConfig) useExistingFile() bool {
return false
}
// SetStickerPositionConfig allows you to change the position of a sticker in a set.
type SetStickerPositionConfig struct {
Sticker string
Position int
}
func (config SetStickerPositionConfig) method() string {
return "setStickerPositionInSet"
}
func (config SetStickerPositionConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("sticker", config.Sticker)
v.Add("position", strconv.Itoa(config.Position))
return v, nil
}
// DeleteStickerConfig allows you to delete a sticker from a set.
type DeleteStickerConfig struct {
Sticker string
}
func (config DeleteStickerConfig) method() string {
return "deleteStickerFromSet"
}
func (config DeleteStickerConfig) values() (url.Values, error) {
v := url.Values{}
v.Add("sticker", config.Sticker)
return v, nil
}