Documentation
¶
Index ¶
- func NewTelegramApi(token string, config ...*Config)
- func SetLogger(l Logger)
- type Config
- type Logger
- type MessageDeleteOptions
- type Telegram
- func (t *Telegram) AnswerCallbackQuery(params *requests.AnswerCallbackQuery) (*models.ApiResponse, error)
- func (t *Telegram) ApproveChatJoinRequest(params *requests.Member) (*models.ApiResponse, error)
- func (t *Telegram) BanChatMember(params *requests.Ban) (*models.ApiResponse, error)
- func (t *Telegram) CreateChatInviteLink(params *requests.CreateChatInviteLink) (*models.ChatInviteLinkResponse, error)
- func (t *Telegram) DeclineChatJoinRequest(params *requests.Member) (*models.ApiResponse, error)
- func (t *Telegram) DeleteChatPhoto(params *requests.Chat) (*models.ApiResponse, error)
- func (t *Telegram) DeleteMessage(params *requests.Message) (*models.ApiResponse, error)
- func (t *Telegram) Download(params *requests.FilePath) ([]byte, error)
- func (t *Telegram) EditMessageText(params *requests.EditMessage) (*models.MessageResponse, error)
- func (t *Telegram) GetBotId() int64
- func (t *Telegram) GetChat(params *requests.Chat) (*models.ChatResponse, error)
- func (t *Telegram) GetChatAdministrators(params *requests.Chat) (*models.ChatMembersResponse, error)
- func (t *Telegram) GetChatMember(params *requests.Member) (*models.ChatMemberResponse, error)
- func (t *Telegram) GetChatMemberCount(params *requests.Chat) (*models.ChatMemberCountResponse, error)
- func (t *Telegram) GetFile(params *requests.File) (*models.FileResponse, error)
- func (t *Telegram) GetToken() string
- func (t *Telegram) LeaveChat(params *requests.Chat) (*models.ApiResponse, error)
- func (t *Telegram) PinChatMessage(params *requests.Message) (*models.ApiResponse, error)
- func (t *Telegram) PromoteChatMember(params *requests.Promote) (*models.ApiResponse, error)
- func (t *Telegram) RestrictChatMember(params *requests.Restrict) (*models.ApiResponse, error)
- func (t *Telegram) SendDice(params *requests.SendDice) (*models.MessageResponse, error)
- func (t *Telegram) SendMessage(params *requests.SendMessage, deleteOptions ...*MessageDeleteOptions) (*models.MessageResponse, error)
- func (t *Telegram) SendPoll(params *requests.SendPoll) (*models.MessageResponse, error)
- func (t *Telegram) SetChatAdministratorCustomTitle(params *requests.CustomTitle) (*models.ApiResponse, error)
- func (t *Telegram) SetChatDescription(params *requests.ChatDescription) (*models.ApiResponse, error)
- func (t *Telegram) SetChatMemberTag(params *requests.Tag) (*models.ApiResponse, error)
- func (t *Telegram) SetChatPermissions(params *requests.SetChatPermissions) (*models.ApiResponse, error)
- func (t *Telegram) SetChatPhoto(params *requests.ChatPhoto) (*models.ApiResponse, error)
- func (t *Telegram) SetChatTitle(params *requests.ChatTitle) (*models.ApiResponse, error)
- func (t *Telegram) UnBanChatMember(params *requests.UnBan) (*models.ApiResponse, error)
- func (t *Telegram) UnPinAllChatMessage(params *requests.Chat) (*models.ApiResponse, error)
- func (t *Telegram) UnPinChatMessage(params *requests.Message) (*models.ApiResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶ added in v1.1.0
type Config struct {
BaseApi string `json:"base_api"` // API基础地址
Timeout time.Duration `json:"timeout"` // 超时时间
UserAgent string `json:"user_agent"` // User-Agent
Debug bool `json:"debug"` // 是否开启调试模式
}
Config Telegram API 配置
func (*Config) GetBaseApi ¶ added in v1.1.0
GetBaseApi 获取API基础地址
func (*Config) GetTimeout ¶ added in v1.1.0
GetTimeout 获取超时时间
func (*Config) GetUserAgent ¶ added in v1.1.0
GetUserAgent 获取User-Agent
type Logger ¶ added in v1.1.0
type Logger interface {
Debug(args ...any)
Debugf(format string, args ...any)
Info(args ...any)
Infof(format string, args ...any)
Warn(args ...any)
Warnf(format string, args ...any)
Error(args ...any)
Errorf(format string, args ...any)
}
Logger 日志接口
type MessageDeleteOptions ¶
type MessageDeleteOptions struct {
Delay time.Duration // 延迟删除时间
DeleteReply bool // 是否删除回复消息
MessageIds []int64 // 要删除的消息ID列表
}
MessageDeleteOptions 消息删除选项
type Telegram ¶
type Telegram struct {
// contains filtered or unexported fields
}
Telegram Telegram API 客户端
func GetTelegram ¶ added in v1.1.0
GetTelegram 从实例池中获取指定机器人实例
func NewTelegram ¶ added in v1.1.0
NewTelegram 多机器人实例模式创建
func (*Telegram) AnswerCallbackQuery ¶
func (t *Telegram) AnswerCallbackQuery(params *requests.AnswerCallbackQuery) (*models.ApiResponse, error)
AnswerCallbackQuery 回答回调查询
func (*Telegram) ApproveChatJoinRequest ¶
ApproveChatJoinRequest 批准入群请求
func (*Telegram) BanChatMember ¶ added in v1.0.9
BanChatMember 封禁群组成员
func (*Telegram) CreateChatInviteLink ¶
func (t *Telegram) CreateChatInviteLink(params *requests.CreateChatInviteLink) (*models.ChatInviteLinkResponse, error)
CreateChatInviteLink 创建群组邀请链接
func (*Telegram) DeclineChatJoinRequest ¶
DeclineChatJoinRequest 拒绝入群请求
func (*Telegram) DeleteChatPhoto ¶ added in v1.0.10
DeleteChatPhoto 删除群组头像
func (*Telegram) DeleteMessage ¶
DeleteMessage 删除消息
func (*Telegram) EditMessageText ¶ added in v1.0.3
func (t *Telegram) EditMessageText(params *requests.EditMessage) (*models.MessageResponse, error)
EditMessageText 编辑消息文本
func (*Telegram) GetChatAdministrators ¶
func (t *Telegram) GetChatAdministrators(params *requests.Chat) (*models.ChatMembersResponse, error)
GetChatAdministrators 获取群组管理员列表
func (*Telegram) GetChatMember ¶
GetChatMember 获取群组成员信息
func (*Telegram) GetChatMemberCount ¶ added in v1.0.9
func (t *Telegram) GetChatMemberCount(params *requests.Chat) (*models.ChatMemberCountResponse, error)
GetChatMemberCount 获取群组成员数量
func (*Telegram) PinChatMessage ¶ added in v1.0.9
PinChatMessage 置顶消息
func (*Telegram) PromoteChatMember ¶
PromoteChatMember 提升群组成员权限
func (*Telegram) RestrictChatMember ¶
RestrictChatMember 限制群组成员
func (*Telegram) SendMessage ¶
func (t *Telegram) SendMessage(params *requests.SendMessage, deleteOptions ...*MessageDeleteOptions) (*models.MessageResponse, error)
SendMessage 发送消息
func (*Telegram) SetChatAdministratorCustomTitle ¶ added in v1.0.10
func (t *Telegram) SetChatAdministratorCustomTitle(params *requests.CustomTitle) (*models.ApiResponse, error)
SetChatAdministratorCustomTitle 设置管理员自定义头衔
func (*Telegram) SetChatDescription ¶ added in v1.0.10
func (t *Telegram) SetChatDescription(params *requests.ChatDescription) (*models.ApiResponse, error)
SetChatDescription 设置群组描述
func (*Telegram) SetChatMemberTag ¶ added in v1.0.9
SetChatMemberTag 设置群组成员标签
func (*Telegram) SetChatPermissions ¶ added in v1.0.10
func (t *Telegram) SetChatPermissions(params *requests.SetChatPermissions) (*models.ApiResponse, error)
SetChatPermissions 设置群组权限
func (*Telegram) SetChatPhoto ¶ added in v1.0.10
SetChatPhoto 设置群组头像
func (*Telegram) SetChatTitle ¶ added in v1.0.9
SetChatTitle 设置群组标题
func (*Telegram) UnBanChatMember ¶ added in v1.0.9
UnBanChatMember 解封群组成员
func (*Telegram) UnPinAllChatMessage ¶ added in v1.0.9
UnPinAllChatMessage 取消所有置顶消息
func (*Telegram) UnPinChatMessage ¶ added in v1.0.9
UnPinChatMessage 取消置顶消息