bgg

Documentation

Index

• Constants
• func Hello() string
• type HTMLMeta
• type Items
  • func SearchItems(query string, gametype string, exact bool) (games Items, search string)

Constants

const (
	// BASEURL of boardgamegeek XMLAPIv2 https://boardgamegeek.com/wiki/page/BGG_XML_API2
	BASEURL = "https://boardgamegeek.com/xmlapi2/"
)

Functions

func Hello

func Hello() string

Hello is first package function.

Types

type HTMLMeta

type HTMLMeta struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Image       string `json:"image"`
	SiteName    string `json:"site_name"`
	URL         string `json:"url"`
}

HTMLMeta is the meta info of the BGG Item webpage. <meta property="og:title" content="Brass: Birmingham" /> <meta property="og:image" content="https://cf.geekdo-images.com/x3zxjr-Vw5iU4yDPg70Jgw__opengraph_left/img/lYAj3vj2GtibZtG_62bVHD5Xy8c=/fit-in/445x445/filters:strip_icc()/pic3490053.jpg" /> <meta property="og:url" content="https://boardgamegeek.com/boardgame/224517/brass-birmingham" /> <meta property="og:site_name" content="BoardGameGeek" /> <meta property="og:description" content="Build networks, grow industries, and navigate the world of the Industrial Revolution." />

type Items

type Items struct {
	XMLName    xml.Name `xml:"items"`
	Text       string   `xml:",chardata"`
	Total      string   `xml:"total,attr"`
	Termsofuse string   `xml:"termsofuse,attr"`
	Items      []item   `xml:"item"`
}

Items struct https://boardgamegeek.com/xmlapi2/search?query=settlers <items total="190" termsofuse="https://boardgamegeek.com/xmlapi/termsofuse">

<item type="boardgame" id="17419">
	<name type="alternate" value="10th Anniversary Treasure Chest Set: Settlers of Catan"/>
	<yearpublished value="2005"/>
</item>
<item type="boardgame" id="12004">
	<name type="primary" value="Candamir: The First Settlers"/>
	<yearpublished value="2004"/>
</item>

</items>

func SearchItems

func SearchItems(query string, gametype string, exact bool) (games Items, search string)

SearchItems Used to search for items of given type. For strict searches exact should be true. Query: Returns all types of Items that match SEARCH_QUERY Item Types: rpgitem, videogame, boardgame, boardgameaccessory or boardgameexpansion Exact: Limit results to items that match the query exactly