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.



1890
1891
1892
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1890

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:



1817
1818
1819
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1817

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:



1825
1826
1827
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1825

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:



1830
1831
1832
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1830

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:



1835
1836
1837
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1835

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) 


1841
1842
1843
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1841

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) 


1847
1848
1849
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1847

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:



1853
1854
1855
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1853

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:



1867
1868
1869
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1867

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:



1872
1873
1874
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1872

def polling_locations
  @polling_locations
end

#precinct_id ⇒ String

Corresponds to the JSON property precinctId

Returns:

  • (String) 


1877
1878
1879
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1877

def precinct_id
  @precinct_id
end

#segments ⇒ Array<Google::Apis::CivicinfoV2::StreetSegment>

Corresponds to the JSON property segments

Returns:



1882
1883
1884
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1882

def segments
  @segments
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:



1888
1889
1890
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1888

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'generated/google/apis/civicinfo_v2/classes.rb', line 1895

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)
  @segments = args[:segments] if args.key?(:segments)
  @state = args[:state] if args.key?(:state)
end