base

Documentation

Index

• Constants
• Variables
• type Base
  • func NewBase(token string) *Base
  • func (b *Base) Query(api, version, mode, query string, v *url.Values, inst interface{}) error
  • func (b *Base) QueryBase(query string, v *url.Values, inst interface{}) error
  • func (b *Base) QueryRequest(query string, v *url.Values) (*http.Response, error)
  • func (b *Base) SetDebug(debug bool)
• type BoundingBox
• type Context
• type Feature
• type FeatureCollection
• type Geometry
• type Location
• type MapboxApiMessage
• type Point
• type Properties

Constants

const (
	// BaseURL Mapbox API base URL
	BaseURL = "https://api.mapbox.com"
)

Variables

var ErrorAPILimitExceeded = errors.New("Mapbox API error api rate limit exceeded")

ErrorAPILimitExceeded indicates the API limit has been exceeded

var ErrorAPIUnauthorized = errors.New("Mapbox API error unauthorized")

ErrorAPIUnauthorized indicates authorization failed

Types

type Base

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

Base Mapbox API base

func NewBase

func NewBase(token string) *Base

NewBase Create a new API base instance

func (*Base) Query

func (b *Base) Query(api, version, mode, query string, v *url.Values, inst interface{}) error

Query the mapbox API TODO: Depreciate this

func (*Base) QueryBase

func (b *Base) QueryBase(query string, v *url.Values, inst interface{}) error

QueryBase Query the mapbox API and fill the provided instance with the returned JSON TODO: Rename this

func (*Base) QueryRequest

func (b *Base) QueryRequest(query string, v *url.Values) (*http.Response, error)

QueryRequest make a get with the provided query string and return the response if successful

func (*Base) SetDebug

func (b *Base) SetDebug(debug bool)

SetDebug enables debug output for API calls

type BoundingBox

type BoundingBox []float64

type Context

type Context struct {
	ID        string `json:"id"`
	Text      string `json:"text"`
	ShortCode string `json:"short_code"`
	WikiData  string `json:"wikidata"`
}

type Feature

type Feature struct {
	ID         string      `json:"id"`
	Type       string      `json:"type"`
	Text       string      `json:"text"`
	PlaceName  string      `json:"place_name"`
	PlaceType  []string    `json:"place_type"`
	Relevance  float64     `json:"relevance"`
	Properties Properties  `json:"properties"`
	BBox       BoundingBox `json:"bbox"`
	Center     Point       `json:"center"`
	Geometry   Geometry    `json:"geometry"`
	Context    []Context   `json:"context"`
}

type FeatureCollection

type FeatureCollection struct {
	Type        string    `json:"type"`
	Features    []Feature `json:"features"`
	Attribution string    `json:"attribution"`
}

type Geometry

type Geometry struct {
	Type        string `json:"type"`
	Coordinates Point  `json:"coordinates"`
}

type Location

type Location struct {
	Latitude  float64 `json:"lat"`
	Longitude float64 `json:"lng"`
}

type MapboxApiMessage

type MapboxApiMessage struct {
	Message string
}

type Point

type Point []float64

type Properties

type Properties struct {
	Category string `json:"category"`
	Tel      string `json:"tel"`
	Wikidata string `json:"wikidata"`
	Landmark bool   `json:"landmark"`
	Maki     string `json:"short_code"`
}