README
¶
GoTGProto
GoTGProto is a helper package for gotd library, It aims to make td's raw functions easy-to-use with the help of features like using session strings, custom helper functions, storing peers and extracting chat or user ids through it etc.
We have an outstanding userbot project going on with GoTGProto, you can check it out by clicking here.
You can use this package to create bots and userbots with Telegram MTProto easily in golang, for any futher help you can check out the documentations or reach us through the following:
- Updates Channel:
- Support Chat:
Note: This library is in the beta stage yet and may not be stable for every case.
Installation
You can download the library with the help of standard go get command.
go get github.com/KoNekoD/gotgproto
Usage
You can find various examples in the examples' directory, one of them i.e. authorizing as a user is as follows:
package main
import (
"log"
"github.com/KoNekoD/gotgproto"
"github.com/KoNekoD/gotgproto/sessionMaker"
)
func main() {
clientType := gotgproto.ClientType{
Phone: "PHONE_NUMBER_HERE",
}
client, err := gotgproto.NewClient(
// Get AppID from https://my.telegram.org/apps
123456,
// Get ApiHash from https://my.telegram.org/apps
"API_HASH_HERE",
// ClientType, as we defined above
clientType,
// Optional parameters of client
&gotgproto.ClientOpts{
Session: sessionMaker.SqliteSession("echobot"),
},
)
if err != nil {
log.Fatalln("failed to start client:", err)
}
client.Idle()
}
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update the examples as appropriate.
License
Licensed Under GNU General Public License v3
Documentation
¶
Index ¶
Constants ¶
const VERSION = "v1.0.0-beta14"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// Dispatcher handlers the incoming updates and execute mapped handlers. It is recommended to use dispatcher.MakeDispatcher function for this field.
Dispatcher dispatcher.Dispatcher
// PublicKeys of telegram.
//
// If not provided, embedded public keys will be used.
PublicKeys []telegram.PublicKey
// DC ID to connect.
//
// If not provided, 2 will be used by default.
DC int
// DCList is initial list of addresses to connect.
DCList dcs.List
// Resolver to use.
Resolver dcs.Resolver
// Whether to show the copyright line in console or no.
DisableCopyright bool
// Logger is instance of zap.Logger. No logs by default.
Logger *zap.Logger
// Self contains details of logged in user in the form of *tg.User.
Self *tg.User
// Code for the language used on the device's OS, ISO 639-1 standard.
SystemLangCode string
// Code for the language used on the client, ISO 639-1 standard.
ClientLangCode string
PeerStorage *storage.PeerStorage
*telegram.Client
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(appId int, apiHash string, cType ClientType, opts *ClientOpts) (*Client, error)
NewClient creates a new gotgproto client and logs in to telegram.
func (*Client) CreateContext ¶
CreateContext creates a new pseudo updates context. A context retrieved from this method should be reused.
func (*Client) ExportStringSession ¶
ExportStringSession EncodeSessionToString encodes the client session to a string in base64.
Note: You must not share this string with anyone, it contains auth details for your logged in account.
func (*Client) RefreshContext ¶
RefreshContext casts the new context.Context and telegram session to ext.Context (It may be used after doing Stop and Start calls respectively.)
func (*Client) Start ¶
func (c *Client) Start(opts *ClientOpts) error
Start connects the client to telegram servers and logins. It will return error if the client is already running.
type ClientOpts ¶
type ClientOpts struct {
// Logger is instance of zap.Logger. No logs by default.
Logger *zap.Logger
// Whether to store session and peer storage in memory or not
//
// Note: Sessions and Peers won't be persistent if this field is set to true.
InMemory bool
// PublicKeys of telegram.
//
// If not provided, embedded public keys will be used.
PublicKeys []telegram.PublicKey
// DC ID to connect.
//
// If not provided, 2 will be used by default.
DC int
// DCList is initial list of addresses to connect.
DCList dcs.List
// Resolver to use.
Resolver dcs.Resolver
// Whether to show the copyright line in console or no.
DisableCopyright bool
// Session info of the authenticated user, use sessionMaker.NewSession function to fill this field.
Session sessionMaker.SessionConstructor
// Setting this field to true will lead to automatically fetch the reply_to_message for a new message update.
//
// Set to `false` by default.
AutoFetchReply bool
// Setting this field to true will lead to automatically fetch the entire reply_to_message chain for a new message update.
//
// Set to `false` by default.
FetchEntireReplyChain bool
// Code for the language used on the device's OS, ISO 639-1 standard.
SystemLangCode string
// Code for the language used on the client, ISO 639-1 standard.
ClientLangCode string
// Custom client device
Device *telegram.DeviceConfig
// Panic handles all the panics that occur during handler execution.
PanicHandler dispatcher.PanicHandler
// Error handles all the unknown errors which are returned by the handler callback functions.
ErrorHandler dispatcher.ErrorHandler
// Custom middlewares
Middlewares []telegram.Middleware
// Custom Run() Middleware
RunMiddleware func(
origRun func(
ctx context.Context,
f func(ctx context.Context) error,
) (err error),
ctx context.Context,
f func(ctx context.Context) (err error),
) (err error)
// Custom context
Context context.Context
}
type ClientType ¶
type ClientType struct {
// BotToken is the unique API Token for the bot you're trying to authorize, get it from @BotFather.
BotToken string
// Mobile number of the authenticating user.
Phone string
}
Type of client to login to, can be of 2 types: 1.) Bot (Fill BotToken in this case) 2.) User (Fill Phone in this case)
Source Files
Directories