bufu

v0.2.0

bufu v0.2.0 Bufu.Location

Resource representing a location in a game.

See the official documentation.

Summary

Functions

get(id, query \\ [], bufu \\ Bufu.new())

Retrieves the resource by id

get!(id, query \\ [], bufu \\ Bufu.new())

Retrieves the resource by id. Throws an exception upon error

list(query \\ [], bufu \\ Bufu.new())

Lists the resource

list!(query \\ [], bufu \\ Bufu.new())

Lists the resource. Throws an exception upon error

load(location, bufu \\ Bufu.new())

Retrieve a resource by passing in a previously-loaded resource of the same type

load!(location, bufu \\ Bufu.new())

Retrieve a resource by passing in a previously-loaded resource of the same type. Raises an exception upon error

Functions

get(id, query \\ [], bufu \\ Bufu.new())

Retrieves the resource by id.

All options passed to query are appended to the query string. See the Giant Bomb API documentation for available options.

get!(id, query \\ [], bufu \\ Bufu.new())

Retrieves the resource by id. Throws an exception upon error.

See get/3.

list(query \\ [], bufu \\ Bufu.new())

Lists the resource.

All options passed to query are appended to the query string. See the Giant Bomb API documentation for available options.

list!(query \\ [], bufu \\ Bufu.new())

Lists the resource. Throws an exception upon error.

See list/2.

load(location, bufu \\ Bufu.new())

Retrieve a resource by passing in a previously-loaded resource of the same type.

This is most useful when retrieving details of a partially-loaded resource returned by the API.

The resource must have a valid id key for details to be loaded. Some resource types (specifically, Bufu.Resource.Chat, Bufu.Resource.Review and Bufu.Resource.UserReview) do not pass back their id attributes from the API, and therefore can’t be retrieved or refreshed by this method.

Examples

Bufu.Game.get(1) |> Map.get(:similar_games) |> hd |> Bufu.Game.load
{:ok, %{Bufu.Game ...}
load!(location, bufu \\ Bufu.new())

Retrieve a resource by passing in a previously-loaded resource of the same type. Raises an exception upon error.

See load/2.