new Cause(client)
A new cause api object.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
object | `this` from index.js |
- Source:
Methods
(async) get(causeId, callback)
Get a cause by its ID
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getCampaigns(causeId, callback)
Get all campaigns of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getDonations()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getDonorLeaderboards(causeId, callback)
Get the top donors of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getFundraisingEvents(causeId, callback)
Get all fundraising events of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getLeaderboards(causeId, callback)
Get the leaderboards of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Deprecated:
- Source:
(async) getPermissions()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getTeamLeaderboards(causeId, callback)
Get the top teams of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getUserLeaderboards(causeId, callback)
Get the top fundraisers of a cause
Parameters:
| Name | Type | Description |
|---|---|---|
causeId |
string | ID of the cause |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getVisibilityOptions()
- Deprecated:
- Unsupported in Tiltify API v5
- Source: