Class: BlizzardApi::Wow::PlayableClass

Inherits:
GenericDataEndpoint show all
Defined in:
lib/blizzard_api/wow/game_data/playable_class.rb

Overview

This class allows access to World of Warcraft playable classes

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

api_instance = BlizzardApi::Wow.playable_class

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

#media(id, **options) ⇒ Hash

Fetch media for one of the playable classes listed by the GenericDataEndpoint#index using its id

in the configuration module

Parameters:

  • id (Integer)

    Playable class id

  • 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



34
35
36
# File 'lib/blizzard_api/wow/game_data/playable_class.rb', line 34

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

#talent_slots(id, **options) ⇒ Hash

Returns the PvP talent slots data of a specific class

in the configuration module

Parameters:

  • id (Integer)

    Class id to fetch talent data. One of the IDs returned by the GenericDataEndpoint#index method

  • 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



22
23
24
# File 'lib/blizzard_api/wow/game_data/playable_class.rb', line 22

def talent_slots(id, **options)
  api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", **default_options.merge(options)
end