Namespace Supporter
A supporter object representing the recipient of the current email blast.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Supporter.get(fieldName)
Getter method that returns supporter information.
|
| <static> |
Supporter.getDistrict(districtType, effortLevel)
Get the district of specified type linked to the supporters record.
|
| <static> |
Supporter.getKnownLegislators(districtType, supporter_districts)
|
| <static> |
Supporter.getLegislators(districtType)
|
| <static> |
Supporter.getScore(keyOrTag)
|
| <static> |
Supporter.hasAuthenticated()
|
Method Detail
<static>
{String}
Supporter.get(fieldName)
Getter method that returns supporter information.
- Parameters:
- {String} fieldName
- The name of any supporter field or supporter custom field. If the "hasAuthenticated" flag is not set it will not return Street, Latitude, Longitude and Phone number inforamtion.
- Returns:
- The value for the requested field name.
<static>
{String}
Supporter.getDistrict(districtType, effortLevel)
Get the district of specified type linked to the supporters record. This method returns information
on the supporter currently logged in.
<?
print(supporter.getDistrict('FH'));
// DC01
?>
- Parameters:
- {String} districtType
- The type of district information to query. This may be one of the following values:
- 'FE' (Federal Executive)
- 'FS' (Federal Senate)
- 'FH' (Federal House)
- 'SE' (State Executive)
- 'SS' (State Senate)
- 'SH' (State House)
- effortLevel
- Returns:
- The supporter's district code, if available.
<static>
Supporter.getKnownLegislators(districtType, supporter_districts)
- Parameters:
- districtType
- supporter_districts
<static>
Supporter.getLegislators(districtType)
- Parameters:
- districtType
<static>
Supporter.getScore(keyOrTag)
- Parameters:
- keyOrTag
<static>
{Boolean}
Supporter.hasAuthenticated()
- Returns:
trueif the supporter is logged in;falseotherwise