tba

Documentation

Index

• type ErrNotModified
• type Service
  • func (s *Service) GetEvents(ctx context.Context, year int, schemaID *int64) ([]store.Event, error)
  • func (s *Service) GetMatches(ctx context.Context, eventKey string) ([]store.Match, error)
  • func (s *Service) GetTeamKeys(ctx context.Context, eventKey string) ([]string, error)
  • func (s *Service) GetTeamRankings(ctx context.Context, eventKey string) ([]store.Team, error)
  • func (s *Service) Ping(ctx context.Context) error

Types

type ErrNotModified

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

ErrNotModified is returned when a resource has not been modified since it was last retrieved from TBA.

type Service

type Service struct {
	URL    string
	APIKey string
	// contains filtered or unexported fields
}

Service provides methods for retrieving data from The Blue Alliance API

func (*Service) GetEvents

func (s *Service) GetEvents(ctx context.Context, year int, schemaID *int64) ([]store.Event, error)

GetEvents retrieves all events from the given year (e.g. 2018).

func (*Service) GetMatches

func (s *Service) GetMatches(ctx context.Context, eventKey string) ([]store.Match, error)

GetMatches retrieves all matches from a specific event.

func (*Service) GetTeamKeys

func (s *Service) GetTeamKeys(ctx context.Context, eventKey string) ([]string, error)

GetTeamKeys retrieves all team keys from a specific event

func (*Service) GetTeamRankings

func (s *Service) GetTeamRankings(ctx context.Context, eventKey string) ([]store.Team, error)

GetTeamRankings retrieves all team rankings from a specific event.

func (*Service) Ping

func (s *Service) Ping(ctx context.Context) error

Ping pings the TBA /status endpoint