Class: Google::Apis::CivicinfoV2::VoterInfoResponse

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/civicinfo_v2/classes.rb,
generated/google/apis/civicinfo_v2/representations.rb,
generated/google/apis/civicinfo_v2/representations.rb

Overview

The result of a voter info lookup query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VoterInfoResponse

Returns a new instance of VoterInfoResponse



1388
1389
1390
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1388

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contests ⇒ Array<Google::Apis::CivicinfoV2::Contest>

Contests that will appear on the voter's ballot. Corresponds to the JSON property contests

Returns:



1320
1321
1322
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1320

def contests
  @contests
end

#drop_off_locations ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field. Corresponds to the JSON property dropOffLocations

Returns:



1328
1329
1330
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1328

def drop_off_locations
  @drop_off_locations
end

#early_vote_sites ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where the voter is eligible to vote early, prior to election day. Corresponds to the JSON property earlyVoteSites

Returns:



1333
1334
1335
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1333

def early_vote_sites
  @early_vote_sites
end

#election ⇒ Google::Apis::CivicinfoV2::Election

Information about the election that was queried. Corresponds to the JSON property election

Returns:



1338
1339
1340
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1338

def election
  @election
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "civicinfo# voterInfoResponse". Corresponds to the JSON property kind

Returns:

  • (String) 


1344
1345
1346
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1344

def kind
  @kind
end

#mail_only ⇒ Boolean Also known as: mail_only?

Specifies whether voters in the precinct vote only by mailing their ballots ( with the possible option of dropping off their ballots as well). Corresponds to the JSON property mailOnly

Returns:

  • (Boolean) 


1350
1351
1352
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1350

def mail_only
  @mail_only
end

#normalized_input ⇒ Google::Apis::CivicinfoV2::SimpleAddressType

A simple representation of an address. Corresponds to the JSON property normalizedInput

Returns:



1356
1357
1358
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1356

def normalized_input
  @normalized_input
end

#other_elections ⇒ Array<Google::Apis::CivicinfoV2::Election>

When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user. Corresponds to the JSON property otherElections

Returns:



1370
1371
1372
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1370

def other_elections
  @other_elections
end

#polling_locations ⇒ Array<Google::Apis::CivicinfoV2::PollingLocation>

Locations where the voter is eligible to vote on election day. Corresponds to the JSON property pollingLocations

Returns:



1375
1376
1377
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1375

def polling_locations
  @polling_locations
end

#precinct_id ⇒ String

Corresponds to the JSON property precinctId

Returns:

  • (String) 


1380
1381
1382
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1380

def precinct_id
  @precinct_id
end

#state ⇒ Array<Google::Apis::CivicinfoV2::AdministrationRegion>

Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array. Corresponds to the JSON property state

Returns:



1386
1387
1388
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1386

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1393

def update!(**args)
  @contests = args[:contests] if args.key?(:contests)
  @drop_off_locations = args[:drop_off_locations] if args.key?(:drop_off_locations)
  @early_vote_sites = args[:early_vote_sites] if args.key?(:early_vote_sites)
  @election = args[:election] if args.key?(:election)
  @kind = args[:kind] if args.key?(:kind)
  @mail_only = args[:mail_only] if args.key?(:mail_only)
  @normalized_input = args[:normalized_input] if args.key?(:normalized_input)
  @other_elections = args[:other_elections] if args.key?(:other_elections)
  @polling_locations = args[:polling_locations] if args.key?(:polling_locations)
  @precinct_id = args[:precinct_id] if args.key?(:precinct_id)
  @state = args[:state] if args.key?(:state)
end