new Team(client)
A new team api object.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
object | `this` from index.js |
- Source:
Methods
(async) get(teamId, callback)
Get a team by its ID
Parameters:
| Name | Type | Description |
|---|---|---|
teamId |
string | ID of the team |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getBySlug(slug, callback)
Get a team by its slug
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
string | Slug of the team |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getCampaign(teamSlug, campaignSlug, callback)
Get a team campaign with a team slug and a campaign slug
Parameters:
| Name | Type | Description |
|---|---|---|
teamSlug |
string | Slug of the team |
campaignSlug |
string | Slug of the campaign |
callback |
function | Callback to execute when done (optional) |
- Deprecated:
- Use {@Campaign#getBySlug}
- Source:
(async) getCampaigns(teamId, callback)
Get all campaigns of a team
Parameters:
| Name | Type | Description |
|---|---|---|
teamId |
string | ID of the team |
callback |
function | Callback to execute when done (optional) |
- Deprecated:
- Source:
(async) getMembers(teamId, callback)
Get all members of a team
Parameters:
| Name | Type | Description |
|---|---|---|
teamId |
string | ID of the team |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) getTeamCampaigns(teamId, callback)
Get all campaigns of a team
Parameters:
| Name | Type | Description |
|---|---|---|
teamId |
string | ID of the team |
callback |
function | Callback to execute when done (optional) |
- Source:
(async) list()
- Deprecated:
- Unsupported in Tiltify API v5
- Source: