esports

Documentation

Overview

Package esports implements an API for interacting with lolesports.

Use the NewClient() constructor to construct a client, and call the client methods to interact with lolesports. Rate limiting is not implemented.

Index

• type Client
  • func NewClient(doer external.Doer) *Client
  • func (c *Client) DisableLogs()
  • func (c *Client) EnableLogs()
  • func (c Client) GetGameStats(ctx context.Context, region region.Region, gameID int64, gameHash string) (*apiclient.Match, error)
  • func (c Client) GetGameTimeline(ctx context.Context, region region.Region, gameID int64, gameHash string) (*apiclient.MatchTimeline, error)
  • func (c Client) GetHighlanderMatchDetails(ctx context.Context, tournamentID string, matchID string) (*HighlanderMatchDetails, error)
  • func (c Client) GetLeagues(ctx context.Context, id league.League) (*Leagues, error)
  • func (c Client) GetLeaguesBySlug(ctx context.Context, slug string) (*Leagues, error)
• type HighlanderMatchDetails
• type HighlanderMatchDetails_GameIDMapping
• type Leagues
• type Leagues_HighlanderRecord
• type Leagues_HighlanderTournament
• type Leagues_HighlanderTournament_Bracket
• type Leagues_HighlanderTournament_Bracket_Match
• type Leagues_HighlanderTournament_Bracket_Match_Game
• type Leagues_League
• type Leagues_Team

Types

type Client

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

func NewClient

func NewClient(doer external.Doer) *Client

func (*Client) DisableLogs

func (c *Client) DisableLogs()

func (*Client) EnableLogs

func (c *Client) EnableLogs()

func (Client) GetGameStats

func (c Client) GetGameStats(ctx context.Context, region region.Region, gameID int64, gameHash string) (*apiclient.Match, error)

func (Client) GetGameTimeline

func (c Client) GetGameTimeline(ctx context.Context, region region.Region, gameID int64, gameHash string) (*apiclient.MatchTimeline, error)

func (Client) GetHighlanderMatchDetails

func (c Client) GetHighlanderMatchDetails(ctx context.Context, tournamentID string, matchID string) (*HighlanderMatchDetails, error)

func (Client) GetLeagues

func (c Client) GetLeagues(ctx context.Context, id league.League) (*Leagues, error)

func (Client) GetLeaguesBySlug

func (c Client) GetLeaguesBySlug(ctx context.Context, slug string) (*Leagues, error)

type HighlanderMatchDetails

type HighlanderMatchDetails struct {
	GameIDMappings []HighlanderMatchDetails_GameIDMapping
}

type HighlanderMatchDetails_GameIDMapping

type HighlanderMatchDetails_GameIDMapping struct {
	ID       string
	GameHash string
}

type Leagues

type Leagues struct {
	Leagues               []Leagues_League
	HighlanderTournaments []Leagues_HighlanderTournament
	HighlanderRecords     []Leagues_HighlanderRecord
	Teams                 []Leagues_Team
}

type Leagues_HighlanderRecord

type Leagues_HighlanderRecord struct {
	Wins       int
	Losses     int
	Ties       int
	Score      int
	Roster     string
	Tournament string
	Bracket    string
	ID         string
}

type Leagues_HighlanderTournament

type Leagues_HighlanderTournament struct {
	ID              string
	Title           string
	Description     string
	LeagueReference string
	// RosteringStrategy
	// Queues
	// Rosters
	Published bool
	// Breakpoints
	Brackets map[string]Leagues_HighlanderTournament_Bracket
	// LiveMatches
	StartDate   string // YYYY-MM-DD
	EndDate     string // YYYY-MM-DD
	LeagueID    string
	PlatformIDs []string
	GameIDs     []string
	League      string
}

type Leagues_HighlanderTournament_Bracket

type Leagues_HighlanderTournament_Bracket struct {
	ID             string
	Name           string
	Position       int
	GroupPosition  int
	GroupName      string
	CanManufacture bool
	State          string
	// BracketType
	// MatchType
	// GameMode
	// Input
	Matches map[string]Leagues_HighlanderTournament_Bracket_Match
}

type Leagues_HighlanderTournament_Bracket_Match

type Leagues_HighlanderTournament_Bracket_Match struct {
	ID            string
	Name          string
	Position      int
	State         string
	GroupPosition int
	Games         map[string]Leagues_HighlanderTournament_Bracket_Match_Game
}

type Leagues_HighlanderTournament_Bracket_Match_Game

type Leagues_HighlanderTournament_Bracket_Match_Game struct {
	ID            string
	Name          string
	GeneratedName string
	// GameMode
	// Input
	// Standings
	// Scores
	GameID     types.StringInt64
	GameRealm  region.Region
	PlatformID string
	Revision   int
}

type Leagues_League

type Leagues_League struct {
	ID          int64
	Slug        string
	Name        string
	GUID        string
	Region      string
	DrupalID    int64
	LogoURL     string
	CreatedAt   string // 2015-04-28T21:08:42.000Z
	UpdatedAt   string
	Abouts      map[language.Language]string
	Names       map[language.Language]string
	Tournaments []string
}

type Leagues_Team

type Leagues_Team struct {
	ID           int64
	Slug         string
	Name         string
	GUID         string
	TeamPhotoURL string
	LogoURL      string
	Acroynm      string
	HomeLeague   string
	AltLogoURL   string
	CreatedAt    string // YYYY-MM-DDT18:34:47.000Z
	UpdatedAt    string
	Bios         map[language.Language]string
	// ForeignIDs
	Players  []int64
	Starters []int64
	Subs     []int64
}