telegram-bot-api/helpers.go

225 lines
7.5 KiB
Go
Raw Normal View History

package tgbotapi
import (
"net/url"
)
// NewMessage creates a new Message.
// Perhaps set a ChatAction of ChatTyping while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, text is the message text.
func NewMessage(chatID int, text string) MessageConfig {
return MessageConfig{
2015-11-20 16:30:50 +01:00
BaseChat: BaseChat{ChatID: chatID, ReplyToMessageID: 0},
2015-11-20 15:31:01 +01:00
Text: text,
DisableWebPagePreview: false,
}
}
// NewForward creates a new forward.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, fromChatID is the source chat,
// and messageID is the ID of the original message.
func NewForward(chatID int, fromChatID int, messageID int) ForwardConfig {
return ForwardConfig{
2015-11-20 15:31:01 +01:00
BaseChat: BaseChat{ChatID: chatID},
FromChatID: fromChatID,
MessageID: messageID,
}
}
// NewPhotoUpload creates a new photo uploader.
2015-06-26 08:10:53 +02:00
// This requires a file on the local filesystem to upload to Telegram.
// Perhaps set a ChatAction of ChatUploadPhoto while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewPhotoUpload(chatID int, file interface{}) PhotoConfig {
return PhotoConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
}
}
// NewPhotoShare shares an existing photo.
2015-06-26 08:10:53 +02:00
// You may use this to reshare an existing photo without reuploading it.
//
// chatID is where to send it, fileID is the ID of the file already uploaded.
func NewPhotoShare(chatID int, fileID string) PhotoConfig {
return PhotoConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
}
}
// NewAudioUpload creates a new audio uploader.
2015-06-26 08:10:53 +02:00
// This requires a file on the local filesystem to upload to Telegram.
// Perhaps set a ChatAction of ChatRecordAudio or ChatUploadAudio while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewAudioUpload(chatID int, file interface{}) AudioConfig {
return AudioConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
}
}
// NewAudioShare shares an existing audio file.
2015-06-26 08:10:53 +02:00
// You may use this to reshare an existing audio file without reuploading it.
//
// chatID is where to send it, fileID is the ID of the audio already uploaded.
func NewAudioShare(chatID int, fileID string) AudioConfig {
return AudioConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
}
}
// NewDocumentUpload creates a new document uploader.
2015-06-26 08:10:53 +02:00
// This requires a file on the local filesystem to upload to Telegram.
// Perhaps set a ChatAction of ChatUploadDocument while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewDocumentUpload(chatID int, file interface{}) DocumentConfig {
return DocumentConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
}
}
// NewDocumentShare shares an existing document.
2015-06-26 08:10:53 +02:00
// You may use this to reshare an existing document without reuploading it.
//
// chatID is where to send it, fileID is the ID of the document already uploaded.
func NewDocumentShare(chatID int, fileID string) DocumentConfig {
return DocumentConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
}
}
// NewStickerUpload creates a new sticker uploader.
2015-06-26 08:10:53 +02:00
// This requires a file on the local filesystem to upload to Telegram.
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewStickerUpload(chatID int, file interface{}) StickerConfig {
return StickerConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
}
}
// NewStickerShare shares an existing sticker.
2015-06-26 08:10:53 +02:00
// You may use this to reshare an existing sticker without reuploading it.
//
// chatID is where to send it, fileID is the ID of the sticker already uploaded.
func NewStickerShare(chatID int, fileID string) StickerConfig {
return StickerConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
}
}
// NewVideoUpload creates a new video uploader.
2015-06-26 08:10:53 +02:00
// This requires a file on the local filesystem to upload to Telegram.
// Perhaps set a ChatAction of ChatRecordVideo or ChatUploadVideo while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewVideoUpload(chatID int, file interface{}) VideoConfig {
return VideoConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
}
}
// NewVideoShare shares an existing video.
2015-06-26 08:10:53 +02:00
// You may use this to reshare an existing video without reuploading it.
//
// chatID is where to send it, fileID is the ID of the video already uploaded.
func NewVideoShare(chatID int, fileID string) VideoConfig {
return VideoConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
}
}
2015-08-18 03:40:42 +02:00
// NewVoiceUpload creates a new voice uploader.
// This requires a file on the local filesystem to upload to Telegram.
// Perhaps set a ChatAction of ChatRecordVideo or ChatUploadVideo while processing.
//
// chatID is where to send it, file is a string path to the file, or FileReader or FileBytes.
func NewVoiceUpload(chatID int, file interface{}) VoiceConfig {
2015-08-18 03:40:42 +02:00
return VoiceConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, File: file, UseExisting: false},
2015-08-18 03:40:42 +02:00
}
}
// NewVoiceShare shares an existing voice.
// You may use this to reshare an existing voice without reuploading it.
//
// chatID is where to send it, fileID is the ID of the video already uploaded.
func NewVoiceShare(chatID int, fileID string) VoiceConfig {
return VoiceConfig{
2015-11-20 15:08:53 +01:00
BaseFile: BaseFile{BaseChat: BaseChat{ChatID: chatID}, FileID: fileID, UseExisting: true},
2015-08-18 03:40:42 +02:00
}
}
// NewLocation shares your location.
// Perhaps set a ChatAction of ChatFindLocation while processing.
2015-06-26 08:10:53 +02:00
//
// chatID is where to send it, latitude and longitude are coordinates.
func NewLocation(chatID int, latitude float64, longitude float64) LocationConfig {
return LocationConfig{
2015-11-20 16:30:50 +01:00
BaseChat: BaseChat{ChatID: chatID, ReplyToMessageID: 0, ReplyMarkup: nil},
Latitude: latitude,
Longitude: longitude,
}
}
// NewChatAction sets a chat action.
2015-06-26 08:10:53 +02:00
// Actions last for 5 seconds, or until your next action.
//
// chatID is where to send it, action should be set via CHAT constants.
func NewChatAction(chatID int, action string) ChatActionConfig {
return ChatActionConfig{
2015-11-20 15:08:53 +01:00
BaseChat: BaseChat{ChatID: chatID},
2015-11-20 15:31:01 +01:00
Action: action,
}
}
// NewUserProfilePhotos gets user profile photos.
2015-06-26 08:10:53 +02:00
//
// userID is the ID of the user you wish to get profile photos from.
func NewUserProfilePhotos(userID int) UserProfilePhotosConfig {
return UserProfilePhotosConfig{
UserID: userID,
Offset: 0,
Limit: 0,
}
}
// NewUpdate gets updates since the last Offset.
2015-06-26 08:10:53 +02:00
//
// offset is the last Update ID to include.
// You likely want to set this to the last Update ID plus 1.
func NewUpdate(offset int) UpdateConfig {
return UpdateConfig{
Offset: offset,
Limit: 0,
Timeout: 0,
}
}
// NewWebhook creates a new webhook.
2015-06-26 08:10:53 +02:00
//
// link is the url parsable link you wish to get the updates.
func NewWebhook(link string) WebhookConfig {
u, _ := url.Parse(link)
return WebhookConfig{
2015-11-21 12:26:39 +01:00
URL: u,
}
}
// NewWebhookWithCert creates a new webhook with a certificate.
//
// link is the url you wish to get webhooks,
// file contains a string to a file, or a FileReader or FileBytes.
func NewWebhookWithCert(link string, file interface{}) WebhookConfig {
u, _ := url.Parse(link)
return WebhookConfig{
URL: u,
Certificate: file,
}
}