Class: BlizzardApi::Hearthstone::Back

Inherits:
GenericDataEndpoint show all
Defined in:
lib/blizzard_api_rb/hearthstone/game_data/back.rb

Overview

This class allows access to Hearthstone card data

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

api_instance = BlizzardApi::Hearthstone.card

See Also:

Constant Summary collapse

VALID_SEARCH_OPTIONS =

Valid options for card search

i[
  cardBackCategory
  textFilter
  sort
  order
].freeze

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, #initialize

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

This class inherits a constructor from BlizzardApi::Hearthstone::GenericDataEndpoint

Instance Method Details

#search(search_options = {}, **options) ⇒ Hash

Returns an up-to-date list of all card backs matching the search criteria. For more information about the

search parameters, see the Card Backs Guide.

in the configuration module

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.

  • :validate_fields (Boolean) —

    If set to true, this method will throw an exception if nay search option is invalid



39
40
41
42
43
 
# File 'lib/blizzard_api_rb/hearthstone/game_data/back.rb', line 39

def search(search_options = {}, **options)
  validate_search_options search_options if options.include? :validate_fields

  api_request "#{base_url(:community)}/cardbacks", **default_options.merge(options).merge(search_options)
end