goth: Index | Files

package twitch

import ""

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


Package Files

session.go twitch.go


const (
    // ScopeUserRead provides read access to non-public user information, such
    // as their email address.
    ScopeUserRead string = "user_read"
    // ScopeUserBlocksEdit provides the ability to ignore or unignore on
    // behalf of a user.
    ScopeUserBlocksEdit string = "user_blocks_edit"
    // ScopeUserBlocksRead provides read access to a user's list of ignored
    // users.
    ScopeUserBlocksRead string = "user_blocks_read"
    // ScopeUserFollowsEdit provides access to manage a user's followed
    // channels.
    ScopeUserFollowsEdit string = "user_follows_edit"
    // ScopeChannelRead provides read access to non-public channel information,
    // including email address and stream key.
    ScopeChannelRead string = "channel_read"
    // ScopeChannelEditor provides write access to channel metadata (game,
    // status, etc).
    ScopeChannelEditor string = "channel_editor"
    // ScopeChannelCommercial provides access to trigger commercials on
    // channel.
    ScopeChannelCommercial string = "channel_commercial"
    // ScopeChannelStream provides the ability to reset a channel's stream key.
    ScopeChannelStream string = "channel_stream"
    // ScopeChannelSubscriptions provides read access to all subscribers to
    // your channel.
    ScopeChannelSubscriptions string = "channel_subscriptions"
    // ScopeUserSubscriptions provides read access to subscriptions of a user.
    ScopeUserSubscriptions string = "user_subscriptions"
    // ScopeChannelCheckSubscription provides read access to check if a user is
    // subscribed to your channel.
    ScopeChannelCheckSubscription string = "channel_check_subscription"
    // ScopeChatLogin provides the ability to log into chat and send messages.
    ScopeChatLogin string = "chat_login"

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 Twitch

func New Uses

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

New creates a new Twitch provider, and sets up important connection details. You should always call `twitch.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 Twitch 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 Twitch package.

func (*Provider) FetchUser Uses

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

FetchUser will go to Twitch 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 Twitch

func (*Session) Authorize Uses

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

Authorize completes the authorization with Twitch 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 Twitch 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 twitch imports 10 packages (graph) and is imported by 24 packages. Updated 2018-01-26. Refresh now. Tools for package owners.