Class: BlizzardApi::Wow::MythicKeystoneLeaderboard

Inherits:
Request show all
Defined in:
lib/blizzard_api_rb/wow/game_data/mythic_keystone_leaderboard.rb

Overview

This class allows access to World of Warcraft mythic raid leaderboard

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

api_instance = BlizzardApi::Wow.mythic_keystone_leaderboard

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 Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

#get(connected_realm_id, dungeon_id, period, **options) ⇒ Hash

Fetch mythic keystone leaderboard for the specified realm, dungeon and period

in the configuration module

Parameters:

  • connected_realm_id (Integer) —

    One of the IDs returned by the GenericDataEndpoint#index

  • options (Hash) —

    a customizable set of options

Options Hash (**options):

  • :completed (Boolean) —

    Should return completed quests

Returns:

  • (Hash) —

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



33
34
35
 
# File 'lib/blizzard_api_rb/wow/game_data/mythic_keystone_leaderboard.rb', line 33

def get(connected_realm_id, dungeon_id, period, **options)
  api_request "#{endpoint_uri(connected_realm_id)}/#{dungeon_id}/period/#{period}", **default_options(options)
end

#index(connected_realm_id, **options) ⇒ Hash

Fetch mythic keystone leaderboards for the specified realm

in the configuration module

Parameters:

  • connected_realm_id (Integer) —

    One of the IDs returned by the GenericDataEndpoint#index

  • options (Hash) —

    a customizable set of options

Options Hash (**options):

  • :completed (Boolean) —

    Should return completed quests

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/mythic_keystone_leaderboard.rb', line 21

def index(connected_realm_id, **options)
  api_request "#{endpoint_uri(connected_realm_id)}/index", **default_options(options)
end