Class: BlizzardApi::Starcraft::League

Inherits:
Request show all
Defined in:
lib/blizzard_api_rb/starcraft/game_data/league.rb

Overview

This class allows access to Starcraft II league data

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

api_instance = BlizzardApi::Starcraft.league

See Also:

Constant Summary

Constants inherited from Request

Request::SC_REGION

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 Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

#get(season_id, queue_id, team_type, league_id, **options) ⇒ Object

Return information about league

Parameters:

  • season_id (Integer) —

    Season id

  • queue_id (Integer) —

    Queue id

  • team_type (Integer) —

    Team type

  • league_id (Integer) —

    League 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.



21
22
23
24
 
# File 'lib/blizzard_api_rb/starcraft/game_data/league.rb', line 21

def get(season_id, queue_id, team_type, league_id, **options)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:game_data)}/league/#{season_id}/#{queue_id}/#{team_type}/#{league_id}", **opts
end