api

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 2, 2022 License: MIT Imports: 2 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	// Base API URL format
	BaseURLFormat = "https://%s.api.riotgames.com"
)

Variables

View Source 
var (
	NotFoundError = ErrorResponse{
		Status: Status{
			Message:    "Not Found",
			StatusCode: http.StatusNotFound,
		},
	}

	UnauthorizedError = ErrorResponse{
		Status: Status{
			Message:    "Unauthorized",
			StatusCode: http.StatusUnauthorized,
		},
	}

	ForbiddenError = ErrorResponse{
		Status: Status{
			Message:    "Forbidden",
			StatusCode: http.StatusForbidden,
		},
	}
)

Functions

This section is empty.

Types

type Division added in v0.6.0 

type Division string
const (
	I   Division = "I"
	II  Division = "II"
	III Division = "III"
	IV  Division = "IV"
)

type EquinoxConfig added in v0.3.0 

type EquinoxConfig struct {
	// Riot API Key.
	Key string
	// Debug mode. Default: false
	Debug bool
	// Timeout for http.Request in seconds, 0 disables it. Default: 10
	Timeout time.Duration
	// Retry request if it returns a 429 status code. Default: true
	Retry bool
}

An config object for the EquinoxClient.

type ErrorResponse added in v0.3.0 

type ErrorResponse struct {
	Status Status `json:"status"`
}

func (ErrorResponse) Error added in v0.3.0 

func (e ErrorResponse) Error() string

type RiotRoute added in v0.6.0 

type RiotRoute string
const (
	RouteAmericas RiotRoute = "americas"
	RouteEurope   RiotRoute = "europe"
	RouteAsia     RiotRoute = "asia"
)

Riot API routes

type Status added in v0.3.0 

type Status struct {
	Message    string `json:"message"`
	StatusCode int    `json:"status_code"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.