Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1650 lines (40 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 26 classes
Google_Service_CivicInfo:: (1 method):
__construct()
Google_Service_CivicInfo_Divisions_Resource:: (1 method):
search()
Google_Service_CivicInfo_Elections_Resource:: (2 methods):
electionQuery()
voterInfoQuery()
Google_Service_CivicInfo_Representatives_Resource:: (2 methods):
representativeInfoByAddress()
representativeInfoByDivision()
Google_Service_CivicInfo_AdministrationRegion:: (10 methods):
setElectionAdministrationBody()
getElectionAdministrationBody()
setId()
getId()
setLocalJurisdiction()
getLocalJurisdiction()
setName()
getName()
setSources()
getSources()
Google_Service_CivicInfo_AdministrativeBody:: (26 methods):
setAbsenteeVotingInfoUrl()
getAbsenteeVotingInfoUrl()
setBallotInfoUrl()
getBallotInfoUrl()
setCorrespondenceAddress()
getCorrespondenceAddress()
setElectionInfoUrl()
getElectionInfoUrl()
setElectionOfficials()
getElectionOfficials()
setElectionRegistrationConfirmationUrl()
getElectionRegistrationConfirmationUrl()
setElectionRegistrationUrl()
getElectionRegistrationUrl()
setElectionRulesUrl()
getElectionRulesUrl()
setHoursOfOperation()
getHoursOfOperation()
setName()
getName()
setPhysicalAddress()
getPhysicalAddress()
setVoterServices()
getVoterServices()
setVotingLocationFinderUrl()
getVotingLocationFinderUrl()
Google_Service_CivicInfo_Candidate:: (16 methods):
setCandidateUrl()
getCandidateUrl()
setChannels()
getChannels()
setEmail()
getEmail()
setName()
getName()
setOrderOnBallot()
getOrderOnBallot()
setParty()
getParty()
setPhone()
getPhone()
setPhotoUrl()
getPhotoUrl()
Google_Service_CivicInfo_Channel:: (4 methods):
setId()
getId()
setType()
getType()
Google_Service_CivicInfo_Contest:: (48 methods):
setBallotPlacement()
getBallotPlacement()
setCandidates()
getCandidates()
setDistrict()
getDistrict()
setElectorateSpecifications()
getElectorateSpecifications()
setId()
getId()
setLevel()
getLevel()
setNumberElected()
getNumberElected()
setNumberVotingFor()
getNumberVotingFor()
setOffice()
getOffice()
setPrimaryParty()
getPrimaryParty()
setReferendumBallotResponses()
getReferendumBallotResponses()
setReferendumBrief()
getReferendumBrief()
setReferendumConStatement()
getReferendumConStatement()
setReferendumEffectOfAbstain()
getReferendumEffectOfAbstain()
setReferendumPassageThreshold()
getReferendumPassageThreshold()
setReferendumProStatement()
getReferendumProStatement()
setReferendumSubtitle()
getReferendumSubtitle()
setReferendumText()
getReferendumText()
setReferendumTitle()
getReferendumTitle()
setReferendumUrl()
getReferendumUrl()
setRoles()
getRoles()
setSources()
getSources()
setSpecial()
getSpecial()
setType()
getType()
Google_Service_CivicInfo_DivisionSearchResponse:: (4 methods):
setKind()
getKind()
setResults()
getResults()
Google_Service_CivicInfo_DivisionSearchResult:: (6 methods):
setAliases()
getAliases()
setName()
getName()
setOcdId()
getOcdId()
Google_Service_CivicInfo_Election:: (8 methods):
setElectionDay()
getElectionDay()
setId()
getId()
setName()
getName()
setOcdDivisionId()
getOcdDivisionId()
Google_Service_CivicInfo_ElectionOfficial:: (10 methods):
setEmailAddress()
getEmailAddress()
setFaxNumber()
getFaxNumber()
setName()
getName()
setOfficePhoneNumber()
getOfficePhoneNumber()
setTitle()
getTitle()
Google_Service_CivicInfo_ElectionsQueryResponse:: (4 methods):
setElections()
getElections()
setKind()
getKind()
Google_Service_CivicInfo_ElectoralDistrict:: (6 methods):
setId()
getId()
setName()
getName()
setScope()
getScope()
Google_Service_CivicInfo_GeographicDivision:: (6 methods):
setAlsoKnownAs()
getAlsoKnownAs()
setName()
getName()
setOfficeIndices()
getOfficeIndices()
Google_Service_CivicInfo_Office:: (12 methods):
setDivisionId()
getDivisionId()
setLevels()
getLevels()
setName()
getName()
setOfficialIndices()
getOfficialIndices()
setRoles()
getRoles()
setSources()
getSources()
Google_Service_CivicInfo_Official:: (16 methods):
setAddress()
getAddress()
setChannels()
getChannels()
setEmails()
getEmails()
setName()
getName()
setParty()
getParty()
setPhones()
getPhones()
setPhotoUrl()
getPhotoUrl()
setUrls()
getUrls()
Google_Service_CivicInfo_PollingLocation:: (18 methods):
setAddress()
getAddress()
setEndDate()
getEndDate()
setId()
getId()
setName()
getName()
setNotes()
getNotes()
setPollingHours()
getPollingHours()
setSources()
getSources()
setStartDate()
getStartDate()
setVoterServices()
getVoterServices()
Google_Service_CivicInfo_RepresentativeInfoData:: (6 methods):
setDivisions()
getDivisions()
setOffices()
getOffices()
setOfficials()
getOfficials()
Google_Service_CivicInfo_RepresentativeInfoDataDivisions:: (0 methods):
Google_Service_CivicInfo_RepresentativeInfoResponse:: (10 methods):
setDivisions()
getDivisions()
setKind()
getKind()
setNormalizedInput()
getNormalizedInput()
setOffices()
getOffices()
setOfficials()
getOfficials()
Google_Service_CivicInfo_RepresentativeInfoResponseDivisions:: (0 methods):
Google_Service_CivicInfo_SimpleAddressType:: (14 methods):
setCity()
getCity()
setLine1()
getLine1()
setLine2()
getLine2()
setLine3()
getLine3()
setLocationName()
getLocationName()
setState()
getState()
setZip()
getZip()
Google_Service_CivicInfo_Source:: (4 methods):
setName()
getName()
setOfficial()
getOfficial()
Google_Service_CivicInfo_VoterInfoResponse:: (22 methods):
setContests()
getContests()
setDropOffLocations()
getDropOffLocations()
setEarlyVoteSites()
getEarlyVoteSites()
setElection()
getElection()
setKind()
getKind()
setMailOnly()
getMailOnly()
setNormalizedInput()
getNormalizedInput()
setOtherElections()
getOtherElections()
setPollingLocations()
getPollingLocations()
setPrecinctId()
getPrecinctId()
setState()
getState()
Class: Google_Service_CivicInfo - X-Ref
Service definition for CivicInfo (v2).<p>
An API for accessing civic information.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/civic-information" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the CivicInfo service. param: Google_Client $client |
Class: Google_Service_CivicInfo_Divisions_Resource - X-Ref
The "divisions" collection of methods.Typical usage is:
<code>
$civicinfoService = new Google_Service_CivicInfo(...);
$divisions = $civicinfoService->divisions;
</code>
| search($optParams = array() X-Ref |
| Searches for political divisions by their natural name or OCD ID. (divisions.search) param: array $optParams Optional parameters. return: Google_Service_CivicInfo_DivisionSearchResponse |
Class: Google_Service_CivicInfo_Elections_Resource - X-Ref
The "elections" collection of methods.Typical usage is:
<code>
$civicinfoService = new Google_Service_CivicInfo(...);
$elections = $civicinfoService->elections;
</code>
| electionQuery($optParams = array() X-Ref |
| List of available elections to query. (elections.electionQuery) param: array $optParams Optional parameters. return: Google_Service_CivicInfo_ElectionsQueryResponse |
| voterInfoQuery($address, $optParams = array() X-Ref |
| Looks up information relevant to a voter based on the voter's registered address. (elections.voterInfoQuery) param: string $address The registered address of the voter to look up. param: array $optParams Optional parameters. return: Google_Service_CivicInfo_VoterInfoResponse |
Class: Google_Service_CivicInfo_Representatives_Resource - X-Ref
The "representatives" collection of methods.Typical usage is:
<code>
$civicinfoService = new Google_Service_CivicInfo(...);
$representatives = $civicinfoService->representatives;
</code>
| representativeInfoByAddress($optParams = array() X-Ref |
| Looks up political geography and representative information for a single address. (representatives.representativeInfoByAddress) param: array $optParams Optional parameters. return: Google_Service_CivicInfo_RepresentativeInfoResponse |
| representativeInfoByDivision($ocdId, $optParams = array() X-Ref |
| Looks up representative information for a single geographic division. (representatives.representativeInfoByDivision) param: string $ocdId The Open Civic Data division identifier of the division param: array $optParams Optional parameters. return: Google_Service_CivicInfo_RepresentativeInfoData |
Class: Google_Service_CivicInfo_AdministrationRegion - X-Ref
| setElectionAdministrationBody(Google_Service_CivicInfo_AdministrativeBody $electionAdministrationBody) X-Ref |
| No description |
| getElectionAdministrationBody() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setLocalJurisdiction(Google_Service_CivicInfo_AdministrationRegion $localJurisdiction) X-Ref |
| No description |
| getLocalJurisdiction() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setSources($sources) X-Ref |
| No description |
| getSources() X-Ref |
| No description |
Class: Google_Service_CivicInfo_AdministrativeBody - X-Ref
| setAbsenteeVotingInfoUrl($absenteeVotingInfoUrl) X-Ref |
| No description |
| getAbsenteeVotingInfoUrl() X-Ref |
| No description |
| setBallotInfoUrl($ballotInfoUrl) X-Ref |
| No description |
| getBallotInfoUrl() X-Ref |
| No description |
| setCorrespondenceAddress(Google_Service_CivicInfo_SimpleAddressType $correspondenceAddress) X-Ref |
| No description |
| getCorrespondenceAddress() X-Ref |
| No description |
| setElectionInfoUrl($electionInfoUrl) X-Ref |
| No description |
| getElectionInfoUrl() X-Ref |
| No description |
| setElectionOfficials($electionOfficials) X-Ref |
| No description |
| getElectionOfficials() X-Ref |
| No description |
| setElectionRegistrationConfirmationUrl($electionRegistrationConfirmationUrl) X-Ref |
| No description |
| getElectionRegistrationConfirmationUrl() X-Ref |
| No description |
| setElectionRegistrationUrl($electionRegistrationUrl) X-Ref |
| No description |
| getElectionRegistrationUrl() X-Ref |
| No description |
| setElectionRulesUrl($electionRulesUrl) X-Ref |
| No description |
| getElectionRulesUrl() X-Ref |
| No description |
| setHoursOfOperation($hoursOfOperation) X-Ref |
| No description |
| getHoursOfOperation() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setPhysicalAddress(Google_Service_CivicInfo_SimpleAddressType $physicalAddress) X-Ref |
| No description |
| getPhysicalAddress() X-Ref |
| No description |
| setVoterServices($voterServices) X-Ref |
| No description |
| getVoterServices() X-Ref |
| No description |
| setVotingLocationFinderUrl($votingLocationFinderUrl) X-Ref |
| No description |
| getVotingLocationFinderUrl() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Candidate - X-Ref
| setCandidateUrl($candidateUrl) X-Ref |
| No description |
| getCandidateUrl() X-Ref |
| No description |
| setChannels($channels) X-Ref |
| No description |
| getChannels() X-Ref |
| No description |
| setEmail($email) X-Ref |
| No description |
| getEmail() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOrderOnBallot($orderOnBallot) X-Ref |
| No description |
| getOrderOnBallot() X-Ref |
| No description |
| setParty($party) X-Ref |
| No description |
| getParty() X-Ref |
| No description |
| setPhone($phone) X-Ref |
| No description |
| getPhone() X-Ref |
| No description |
| setPhotoUrl($photoUrl) X-Ref |
| No description |
| getPhotoUrl() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Channel - X-Ref
Class: Google_Service_CivicInfo_Contest - X-Ref
| setBallotPlacement($ballotPlacement) X-Ref |
| No description |
| getBallotPlacement() X-Ref |
| No description |
| setCandidates($candidates) X-Ref |
| No description |
| getCandidates() X-Ref |
| No description |
| setDistrict(Google_Service_CivicInfo_ElectoralDistrict $district) X-Ref |
| No description |
| getDistrict() X-Ref |
| No description |
| setElectorateSpecifications($electorateSpecifications) X-Ref |
| No description |
| getElectorateSpecifications() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setLevel($level) X-Ref |
| No description |
| getLevel() X-Ref |
| No description |
| setNumberElected($numberElected) X-Ref |
| No description |
| getNumberElected() X-Ref |
| No description |
| setNumberVotingFor($numberVotingFor) X-Ref |
| No description |
| getNumberVotingFor() X-Ref |
| No description |
| setOffice($office) X-Ref |
| No description |
| getOffice() X-Ref |
| No description |
| setPrimaryParty($primaryParty) X-Ref |
| No description |
| getPrimaryParty() X-Ref |
| No description |
| setReferendumBallotResponses($referendumBallotResponses) X-Ref |
| No description |
| getReferendumBallotResponses() X-Ref |
| No description |
| setReferendumBrief($referendumBrief) X-Ref |
| No description |
| getReferendumBrief() X-Ref |
| No description |
| setReferendumConStatement($referendumConStatement) X-Ref |
| No description |
| getReferendumConStatement() X-Ref |
| No description |
| setReferendumEffectOfAbstain($referendumEffectOfAbstain) X-Ref |
| No description |
| getReferendumEffectOfAbstain() X-Ref |
| No description |
| setReferendumPassageThreshold($referendumPassageThreshold) X-Ref |
| No description |
| getReferendumPassageThreshold() X-Ref |
| No description |
| setReferendumProStatement($referendumProStatement) X-Ref |
| No description |
| getReferendumProStatement() X-Ref |
| No description |
| setReferendumSubtitle($referendumSubtitle) X-Ref |
| No description |
| getReferendumSubtitle() X-Ref |
| No description |
| setReferendumText($referendumText) X-Ref |
| No description |
| getReferendumText() X-Ref |
| No description |
| setReferendumTitle($referendumTitle) X-Ref |
| No description |
| getReferendumTitle() X-Ref |
| No description |
| setReferendumUrl($referendumUrl) X-Ref |
| No description |
| getReferendumUrl() X-Ref |
| No description |
| setRoles($roles) X-Ref |
| No description |
| getRoles() X-Ref |
| No description |
| setSources($sources) X-Ref |
| No description |
| getSources() X-Ref |
| No description |
| setSpecial($special) X-Ref |
| No description |
| getSpecial() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_CivicInfo_DivisionSearchResponse - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setResults($results) X-Ref |
| No description |
| getResults() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Election - X-Ref
| setElectionDay($electionDay) X-Ref |
| No description |
| getElectionDay() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOcdDivisionId($ocdDivisionId) X-Ref |
| No description |
| getOcdDivisionId() X-Ref |
| No description |
Class: Google_Service_CivicInfo_ElectionOfficial - X-Ref
| setEmailAddress($emailAddress) X-Ref |
| No description |
| getEmailAddress() X-Ref |
| No description |
| setFaxNumber($faxNumber) X-Ref |
| No description |
| getFaxNumber() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOfficePhoneNumber($officePhoneNumber) X-Ref |
| No description |
| getOfficePhoneNumber() X-Ref |
| No description |
| setTitle($title) X-Ref |
| No description |
| getTitle() X-Ref |
| No description |
Class: Google_Service_CivicInfo_ElectionsQueryResponse - X-Ref
| setElections($elections) X-Ref |
| No description |
| getElections() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
Class: Google_Service_CivicInfo_GeographicDivision - X-Ref
| setAlsoKnownAs($alsoKnownAs) X-Ref |
| No description |
| getAlsoKnownAs() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOfficeIndices($officeIndices) X-Ref |
| No description |
| getOfficeIndices() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Office - X-Ref
| setDivisionId($divisionId) X-Ref |
| No description |
| getDivisionId() X-Ref |
| No description |
| setLevels($levels) X-Ref |
| No description |
| getLevels() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOfficialIndices($officialIndices) X-Ref |
| No description |
| getOfficialIndices() X-Ref |
| No description |
| setRoles($roles) X-Ref |
| No description |
| getRoles() X-Ref |
| No description |
| setSources($sources) X-Ref |
| No description |
| getSources() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Official - X-Ref
| setAddress($address) X-Ref |
| No description |
| getAddress() X-Ref |
| No description |
| setChannels($channels) X-Ref |
| No description |
| getChannels() X-Ref |
| No description |
| setEmails($emails) X-Ref |
| No description |
| getEmails() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setParty($party) X-Ref |
| No description |
| getParty() X-Ref |
| No description |
| setPhones($phones) X-Ref |
| No description |
| getPhones() X-Ref |
| No description |
| setPhotoUrl($photoUrl) X-Ref |
| No description |
| getPhotoUrl() X-Ref |
| No description |
| setUrls($urls) X-Ref |
| No description |
| getUrls() X-Ref |
| No description |
Class: Google_Service_CivicInfo_PollingLocation - X-Ref
| setAddress(Google_Service_CivicInfo_SimpleAddressType $address) X-Ref |
| No description |
| getAddress() X-Ref |
| No description |
| setEndDate($endDate) X-Ref |
| No description |
| getEndDate() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setNotes($notes) X-Ref |
| No description |
| getNotes() X-Ref |
| No description |
| setPollingHours($pollingHours) X-Ref |
| No description |
| getPollingHours() X-Ref |
| No description |
| setSources($sources) X-Ref |
| No description |
| getSources() X-Ref |
| No description |
| setStartDate($startDate) X-Ref |
| No description |
| getStartDate() X-Ref |
| No description |
| setVoterServices($voterServices) X-Ref |
| No description |
| getVoterServices() X-Ref |
| No description |
Class: Google_Service_CivicInfo_RepresentativeInfoData - X-Ref
| setDivisions($divisions) X-Ref |
| No description |
| getDivisions() X-Ref |
| No description |
| setOffices($offices) X-Ref |
| No description |
| getOffices() X-Ref |
| No description |
| setOfficials($officials) X-Ref |
| No description |
| getOfficials() X-Ref |
| No description |
Class: Google_Service_CivicInfo_RepresentativeInfoResponse - X-Ref
| setDivisions($divisions) X-Ref |
| No description |
| getDivisions() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setNormalizedInput(Google_Service_CivicInfo_SimpleAddressType $normalizedInput) X-Ref |
| No description |
| getNormalizedInput() X-Ref |
| No description |
| setOffices($offices) X-Ref |
| No description |
| getOffices() X-Ref |
| No description |
| setOfficials($officials) X-Ref |
| No description |
| getOfficials() X-Ref |
| No description |
Class: Google_Service_CivicInfo_SimpleAddressType - X-Ref
| setCity($city) X-Ref |
| No description |
| getCity() X-Ref |
| No description |
| setLine1($line1) X-Ref |
| No description |
| getLine1() X-Ref |
| No description |
| setLine2($line2) X-Ref |
| No description |
| getLine2() X-Ref |
| No description |
| setLine3($line3) X-Ref |
| No description |
| getLine3() X-Ref |
| No description |
| setLocationName($locationName) X-Ref |
| No description |
| getLocationName() X-Ref |
| No description |
| setState($state) X-Ref |
| No description |
| getState() X-Ref |
| No description |
| setZip($zip) X-Ref |
| No description |
| getZip() X-Ref |
| No description |
Class: Google_Service_CivicInfo_Source - X-Ref
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOfficial($official) X-Ref |
| No description |
| getOfficial() X-Ref |
| No description |
Class: Google_Service_CivicInfo_VoterInfoResponse - X-Ref
| setContests($contests) X-Ref |
| No description |
| getContests() X-Ref |
| No description |
| setDropOffLocations($dropOffLocations) X-Ref |
| No description |
| getDropOffLocations() X-Ref |
| No description |
| setEarlyVoteSites($earlyVoteSites) X-Ref |
| No description |
| getEarlyVoteSites() X-Ref |
| No description |
| setElection(Google_Service_CivicInfo_Election $election) X-Ref |
| No description |
| getElection() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setMailOnly($mailOnly) X-Ref |
| No description |
| getMailOnly() X-Ref |
| No description |
| setNormalizedInput(Google_Service_CivicInfo_SimpleAddressType $normalizedInput) X-Ref |
| No description |
| getNormalizedInput() X-Ref |
| No description |
| setOtherElections($otherElections) X-Ref |
| No description |
| getOtherElections() X-Ref |
| No description |
| setPollingLocations($pollingLocations) X-Ref |
| No description |
| getPollingLocations() X-Ref |
| No description |
| setPrecinctId($precinctId) X-Ref |
| No description |
| getPrecinctId() X-Ref |
| No description |
| setState($state) X-Ref |
| No description |
| getState() X-Ref |
| No description |
