new Cause(self)
A new cause api object.
Parameters:
| Name | Type | Description |
|---|---|---|
self |
object | is `this` from index.js |
- Source:
Methods
get(id, callback)
returns info about a cause
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | cause id to look up |
callback |
requestCallback | a function to call when we're done getting data |
- Source:
getFundraisingEvents(id, callback)
returns fundraising events for a cause
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | cause id to look up |
callback |
requestCallback | a function to call when we're done getting data |
- Source:
getLeaderboards(id, timeType, callback)
returns leaderboards for a cause
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | cause id to look up |
timeType |
string | Time range for leaderboard (daily, weekly, monthly, yearly, ytd, all) |
callback |
requestCallback | a function to call when we're done getting data |
- Source:
getTopDonors(id, timeType, callback)
returns top donors for a cause
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | cause id to look up |
timeType |
string | Time range for leaderboard (daily, weekly, monthly, yearly, ytd, all) |
callback |
requestCallback | a function to call when we're done getting data |
- Source:
getTopTeams(id, timeType, callback)
returns top donors for a cause
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | cause id to look up |
timeType |
string | Time range for leaderboard (daily, weekly, monthly, yearly, ytd, all) |
callback |
requestCallback | a function to call when we're done getting data |
- Source: