ptc

Documentation

Index

• type LoginError
  • func (e *LoginError) Error() string
• type Provider
  • func NewProvider(username, password string) *Provider
  • func (p *Provider) GetAccessToken() string
  • func (p *Provider) GetProviderString() string
  • func (p *Provider) Login(ctx context.Context) (string, error)

Types

type LoginError

type LoginError struct {
	// contains filtered or unexported fields
}

LoginError is thrown when something went wrong with the login request

func (*LoginError) Error

func (e *LoginError) Error() string

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider contains data about and manages the session with the Pokémon Trainer's Club

func NewProvider

func NewProvider(username, password string) *Provider

NewProvider constructs a Pokémon Trainer's Club auth provider instance

func (*Provider) GetAccessToken

func (p *Provider) GetAccessToken() string

GetAccessToken will return an access token if it has been retrieved

func (*Provider) GetProviderString

func (p *Provider) GetProviderString() string

GetProviderString will return a string identifying the provider

func (*Provider) Login

func (p *Provider) Login(ctx context.Context) (string, error)

Login retrieves an access token from the Pokémon Trainer's Club