google_api_civic_info v0.6.0 GoogleApi.CivicInfo.V2.Model.Candidate View Source

Information about a candidate running for elected office.

Attributes

  • candidateUrl (type: String.t, default: nil) - The URL for the candidate's campaign web site.
  • channels (type: list(GoogleApi.CivicInfo.V2.Model.Channel.t), default: nil) - A list of known (social) media channels for this candidate.
  • email (type: String.t, default: nil) - The email address for the candidate's campaign.
  • name (type: String.t, default: nil) - The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
  • orderOnBallot (type: String.t, default: nil) - The order the candidate appears on the ballot for this contest.
  • party (type: String.t, default: nil) - The full name of the party the candidate is a member of.
  • phone (type: String.t, default: nil) - The voice phone number for the candidate's campaign office.
  • photoUrl (type: String.t, default: nil) - A URL for a photo of the candidate.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.CivicInfo.V2.Model.Candidate{
  candidateUrl: String.t(),
  channels: [GoogleApi.CivicInfo.V2.Model.Channel.t()],
  email: String.t(),
  name: String.t(),
  orderOnBallot: String.t(),
  party: String.t(),
  phone: String.t(),
  photoUrl: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.