class BlizzardApi::Wow::Journal

This class allows access to World of Warcraft journal data

@see develop.battle.net/documentation/world-of-warcraft/game-data-apis

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

api_instance = BlizzardApi::Wow.journal

Public Instance Methods

complete() click to toggle source

This method overrides the inherited default behavior to prevent high server load and fetch time

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 25
def complete
  raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
end
encounter(id, **options) click to toggle source

Return data about an encounter journal entry

@param id [Integer] Journal entry id @!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 96
def encounter(id, **options)
  api_request "#{endpoint_uri('encounter')}/#{id}", **default_options.merge(options)
end
encounters(**options) click to toggle source

Return a list of encounter journal entries

@!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 85
def encounters(**options)
  api_request "#{endpoint_uri('encounter')}/index", **default_options.merge(options)
end
expansion(id, **options) click to toggle source

Return data about an expansion journal entry

@param id [Integer] Journal entry id @!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 54
def expansion(id, **options)
  api_request "#{endpoint_uri('expansion')}/#{id}", **default_options.merge(options)
end
expansions(**options) click to toggle source

Return a list of expansion journal entries

@!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 43
def expansions(**options)
  api_request "#{endpoint_uri('expansion')}/index", **default_options.merge(options)
end
get(_id) click to toggle source

This method overrides the inherited default behavior to prevent high server load and fetch time

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 33
def get(_id)
  raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
end
index() click to toggle source

This method overrides the inherited default behavior to prevent high server load and fetch time

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 17
def index
  raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
end
instance(id, **options) click to toggle source

Return data about an instance journal entry

@param id [Integer] Journal entry id @!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 75
def instance(id, **options)
  api_request "#{endpoint_uri('instance')}/#{id}", **default_options.merge(options)
end
instances(**options) click to toggle source

Return a list of instance journal entries

@!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/journal.rb, line 64
def instances(**options)
  api_request "#{endpoint_uri('instance')}/index", **default_options.merge(options)
end

Protected Instance Methods

endpoint_setup() click to toggle source
# File lib/blizzard_api/wow/game_data/journal.rb, line 117
def endpoint_setup
  @endpoint = 'journal'
  @namespace = :static
  @collection = 'journals'
  @ttl = CACHE_TRIMESTER
end