new FundraisingEvents(client)
A new fundraising events api object.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
object | `this` from index.js |
- Source:
Methods
(async) get(fundraisingEventId, callback)
Get a fundraising event by its ID
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getCampaigns(id, callback)
Get all supporting campaigns of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Deprecated:
- Source:
(async) getDonations()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getDonorLeaderboards(fundraisingEventId, callback)
Get the top donors of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getIncentives()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getLeaderboards(fundraisingEventId, callback)
Get the leaderboards of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Deprecated:
- Source:
(async) getRegistrationFields()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getRegistrations()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getSchedule()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getSupportingEvents(fundraisingEventId, callback)
Get all supporting campaigns of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getTeamFitnessTimeLeaderboard(fundraisingEventId, callback)
Get the top teams' fitness times of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getTeamLeaderboards(fundraisingEventId, callback)
Get the top team fundraisers of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getUserFitnessTimeLeaderboard(fundraisingEventId, callback)
Get the top users' fitness times of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getUserLeaderboards(fundraisingEventId, callback)
Get the top user fundraisers of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getVisibilityOptions()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) list()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) teamFitnessDistanceLeaderboard(fundraisingEventId, callback)
Get the top teams' fitness distances of a fundraising event
Parameters:
| Name | Type | Description |
|---|---|---|
fundraisingEventId |
string | ID of the fundraising event |
callback |
function | Callback to execute when done (optional) |
- Source: