package qrlogin

Import Path
	github.com/gotd/td/telegram/auth/qrlogin (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	    accept.go
	    errors.go
	    options.go
	  d qrlogin.go
		Package qrlogin provides QR login flow implementation.
		
		See https://core.telegram.org/api/qr-login.

	    token.go
Package-Level Type Names (total 5, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type LoggedIn (chan)
		LoggedIn is signal channel to notify about tg.UpdateLoginToken.

		As Outputs Of (at least one exported)
			func OnLoginToken(d interface{OnLoginToken(tg.LoginTokenHandler)}) LoggedIn
		As Inputs Of (at least one exported)
			func QR.Auth(ctx context.Context, loggedIn LoggedIn, show func(ctx context.Context, token Token) error, exceptIDs ...int64) (*tg.AuthAuthorization, error)

	 type MigrationNeededError (struct)
		MigrationNeededError reports that Telegram requested DC migration to continue login.

		Fields (total 2, both are exported)
			MigrateTo *tg.AuthLoginTokenMigrateTo
			Tried bool
				Tried indicates that the migration was attempted.
				
				Deprecated: do not use. QR login uses migrate function passed via
				options.

		Methods (only one, which is exported)
			(*MigrationNeededError) Error() string
				Error implements error.

		Implements (at least one exported)
			*MigrationNeededError : error

	 type Options (struct)
		Options of QR.

		Fields (total 2, both are exported)
			Clock clock.Clock
			Migrate func(ctx context.Context, dcID int) error
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*Options) setDefaults()
		As Inputs Of (at least one exported)
			func NewQR(api *tg.Client, appID int, appHash string, opts Options) QR

	 type QR (struct)
		QR implements Telegram QR login flow.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			api *tg.Client
			appHash string
			appID int
			clock clock.Clock
			migrate func(ctx context.Context, dcID int) error
		Methods (total 4, all are exported)
			( QR) Accept(ctx context.Context, t Token) (*tg.Authorization, error)
				Accept accepts given token.
				
				See https://core.telegram.org/api/qr-login#accepting-a-login-token.

			( QR) Auth(ctx context.Context, loggedIn LoggedIn, show func(ctx context.Context, token Token) error, exceptIDs ...int64) (*tg.AuthAuthorization, error)
				Auth generates new QR login token, shows it and awaits acceptation.
				
				NB: Show callback may be called more than once if QR expires.

			( QR) Export(ctx context.Context, exceptIDs ...int64) (Token, error)
				Export exports new login token.
				
				See https://core.telegram.org/api/qr-login#exporting-a-login-token.

			( QR) Import(ctx context.Context) (*tg.AuthAuthorization, error)
				Import imports accepted token.
				
				See https://core.telegram.org/api/qr-login#confirming-importing-the-login-token.

		As Outputs Of (at least 2, both are exported)
			func NewQR(api *tg.Client, appID int, appHash string, opts Options) QR
			func github.com/gotd/td/telegram.(*Client).QR() QR

	 type Token (struct)
		Token represents Telegram QR Login token.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			expires time.Time
			token []byte
		Methods (total 4, all are exported)
			( Token) Expires() time.Time
				Expires returns token expiration time.

			( Token) Image(level qr.Level) (image.Image, error)
				Image returns QR image.

			( Token) String() string
				String implements fmt.Stringer.

			( Token) URL() string
				URL returns login URL.
				
				See https://core.telegram.org/api/qr-login#exporting-a-login-token.

		Implements (at least 3, in which 1 is exported)
			 Token : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Token : context.stringer
			 Token : runtime.stringer
		As Outputs Of (at least 3, all are exported)
			func NewToken(token []byte, expires int) Token
			func ParseTokenURL(u string) (Token, error)
			func QR.Export(ctx context.Context, exceptIDs ...int64) (Token, error)
		As Inputs Of (at least 2, both are exported)
			func AcceptQR(ctx context.Context, raw *tg.Client, t Token) (*tg.Authorization, error)
			func QR.Accept(ctx context.Context, t Token) (*tg.Authorization, error)


Package-Level Functions (total 5, all are exported)

	 func AcceptQR(ctx context.Context, raw *tg.Client, t Token) (*tg.Authorization, error)
		AcceptQR accepts given token.
		
		See https://core.telegram.org/api/qr-login#accepting-a-login-token.

	 func NewQR(api *tg.Client, appID int, appHash string, opts Options) QR
		NewQR creates new QR

	 func NewToken(token []byte, expires int) Token
		NewToken creates new Token.

	 func OnLoginToken(d interface{OnLoginToken(tg.LoginTokenHandler)}) LoggedIn
		OnLoginToken sets handler for given dispatcher and returns signal channel.

	 func ParseTokenURL(u string) (Token, error)
		ParseTokenURL creates Token from given URL.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.