goth: Index | Files

package discord

import ""

Package discord implements the OAuth2 protocol for authenticating users through Discord. This package can be used as a reference implementation of an OAuth2 provider for Discord.


Package Files

discord.go session.go


const (
    // allows /users/@me without email
    ScopeIdentify string = "identify"
    // enables /users/@me to return an email
    ScopeEmail string = "email"
    // allows /users/@me/connections to return linked Twitch and YouTube accounts
    ScopeConnections string = "connections"
    // allows /users/@me/guilds to return basic information about all of a user's guilds
    ScopeGuilds string = "guilds"
    // allows /invites/{} to be used for joining a user's guild
    ScopeJoinGuild string = "guilds.join"
    // allows your app to join users to a group dm
    ScopeGroupDMjoin string = "gdm.join"
    // for oauth2 bots, this puts the bot in the user's selected guild by default
    ScopeBot string = "bot"
    // 	this generates a webhook that is returned in the oauth token response for authorization code grants
    ScopeWebhook string = "webhook.incoming"

type Provider Uses

type Provider struct {
    ClientKey   string
    Secret      string
    CallbackURL string
    HTTPClient  *http.Client
    // contains filtered or unexported fields

Provider is the implementation of `goth.Provider` for accessing Discord

func New Uses

func New(clientKey string, secret string, callbackURL string, scopes ...string) *Provider

New creates a new Discord provider, and sets up important connection details. You should always call `discord.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth Uses

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks Discord for an authentication end-point.

func (*Provider) Client Uses

func (p *Provider) Client() *http.Client

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is no-op for the Discord package.

func (*Provider) FetchUser Uses

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will go to Discord and access basic info about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name gets the name used to retrieve this provider.

func (*Provider) RefreshToken Uses

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession Uses

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL      string
    AccessToken  string
    RefreshToken string
    ExpiresAt    time.Time

Session stores data during the auth process with Discord

func (*Session) Authorize Uses

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize completes the authorization with Discord and returns the access token to be stored for future use.

func (Session) GetAuthURL Uses

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Discord provider.

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal marshals a session into a JSON string.

func (Session) String Uses

func (s Session) String() string

String is equivalent to Marshal. It returns a JSON representation of the of the session.

Package discord imports 11 packages (graph) and is imported by 26 packages. Updated 2018-07-29. Refresh now. Tools for package owners.