Class: BlizzardApi::Starcraft::Account

Inherits:

Request

• Object
• Request
• Request
• BlizzardApi::Starcraft::Account

Defined in:

lib/blizzard_api_rb/starcraft/community/account.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.account

See Also:

• https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api

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

• #player(account_id, **options) ⇒ Object

  Returns information about a player account.

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

#player(account_id, **options) ⇒ Object

Returns information about a player account

Parameters:

• account_id (Integer) —

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

# File 'lib/blizzard_api_rb/starcraft/community/account.rb', line 18

def player(account_id, **options)
  api_request "#{base_url(:community)}/player/#{account_id}", **{ ttl: CACHE_DAY }.merge(options)
end