class ZombieBattleground::Api::Requests::GetMatchesRequest

Request validator for GetMatches

Attributes

id[RW]

@!attribute [r] id Optionally set the Match's id for filtered querying

@return [Integer]

@example

request.id #=> 1

@api public

limit[RW]

@!attribute [r] limit Optionally set the limit for max Matches returned

@return [Integer]

@example

request.limit #=> 100

@api public

page[RW]

@!attribute [r] page Optionally set the page number for filtered querying

@return [Integer]

@example

request.page #=> 1

@api public

player1_id[RW]

@!attribute [r] player1_id Optionally set the Match's player1_id for filtered querying

@return [String]

@example

request.player1_id #=> "ZombieSlayer_16601021609396167139295300949176"

@api public

player2_id[RW]

@!attribute [r] player2_id Optionally set the Match's player2_id for filtered querying

@return [String]

@example

request.player2_id #=> "ZombieSlayer_16601021609396167139295300949176"

@api public

status[RW]

@!attribute [r] status Optionally set the Match's status for filtered querying

@return [String]

@example

request.status #=> "Ended"

@api public

version[RW]

@!attribute [r] version Optionally set the Match's version for filtered querying

@return [String]

@example

request.version #=> "v3"

@api public

winner_id[RW]

@!attribute [r] winner_id Optionally set the Match's winner_id for filtered querying

@return [String]

@example

request.winner_id #=> "ZombieSlayer_16601021609396167139295300949176"

@api public

Public Instance Methods

uri() click to toggle source

The URI for the endpoint

@return [String]

@example

request.uri # => "matches"

@api public

# File lib/zombie_battleground/api/requests/get_matches_request.rb, line 132
def uri
  'matches'
end