Class: BlizzardApi::Wow::Achievement

Inherits:
GenericDataEndpoint show all
Defined in:
lib/blizzard_api_rb/wow/game_data/achievement.rb

Overview

This class allows access to World of Warcraft achievements

You can get an instance of this class using the default region as follows:

api_instance = BlizzardApi::Wow.achievement

See Also:

Constant Summary

Constants inherited from Request

Request::CACHE_DAY, Request::CACHE_HOUR, Request::CACHE_TRIMESTER

Constants included from ApiStandards

ApiStandards::BASE_URLS

Instance Attribute Summary

Attributes inherited from Request

#mode, #region

Instance Method Summary collapse

Methods inherited from GenericDataEndpoint

#get, #index, setup

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

This class inherits a constructor from BlizzardApi::Wow::Request

Instance Method Details

#categories(**options) ⇒ Hash

Return a list of possible achievement categories.

in the configuration module

Parameters:

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



21
22
23
 
# File 'lib/blizzard_api_rb/wow/game_data/achievement.rb', line 21

def categories(**options)
  api_request "#{endpoint_uri('category')}/index", **default_options.merge(options)
end

#category(id, **options) ⇒ Hash

Return a achievement category.

in the configuration module

Parameters:

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



31
32
33
 
# File 'lib/blizzard_api_rb/wow/game_data/achievement.rb', line 31

def category(id, **options)
  api_request "#{endpoint_uri('category')}/#{id}", **default_options.merge(options)
end

#media(id, **options) ⇒ Hash

Fetch media assets for the specified achievement

in the configuration module

Parameters:

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



41
42
43
 
# File 'lib/blizzard_api_rb/wow/game_data/achievement.rb', line 41

def media(id, **options)
  api_request "#{base_url(:media)}/achievement/#{id}", **default_options.merge(options)
end