Class: BlizzardApi::OverwatchLeague::Segments

Inherits:
Request show all
Defined in:
lib/blizzard_api/overwatch_league/community/segments.rb

Overview

This class allows access to OWL2 segment data

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

api_instance = BlizzardApi::OverwatchLeague.segments

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::OverwatchLeague::Request

Instance Method Details

#get(segment_id, **options) ⇒ Object

Returns segment information

Parameters:

  • options (Hash) —

    a customizable set of options

Options Hash (**options):

  • :completed (Boolean) —

    Should return completed quests



17
18
19
 
# File 'lib/blizzard_api/overwatch_league/community/segments.rb', line 17

def get(segment_id, **options)
  api_request "#{base_url(:community)}/v1/segments/#{segment_id}", **{ ttl: CACHE_DAY }.merge(options)
end