new User(client)
A new user api object.
Parameters:
| Name |
Type |
Description |
client |
object
|
`this` from index.js |
- Source:
Methods
(async) get(userId, callback)
Get a user by their ID
Parameters:
| Name |
Type |
Description |
userId |
string
|
ID of the user |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) getBySlug(slug, callback)
Get a user by their slug
Parameters:
| Name |
Type |
Description |
slug |
string
|
Slug of the user |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) getCampaign(userSlug, campaignSlug, callback)
Get a user campaign with a user slug and a campaign slug
Parameters:
| Name |
Type |
Description |
userSlug |
string
|
Slug of the user |
campaignSlug |
string
|
Slug of the campaign |
callback |
function
|
Callback to execute when done (optional) |
- Deprecated:
- Use {@Campaign#getBySlug}
- Source:
(async) getCampaigns(userId, callback)
Get all user campaigns of a user
Parameters:
| Name |
Type |
Description |
userId |
string
|
ID of the user |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) getCurrentUser(callback)
Get the user that owns the application running this client
Parameters:
| Name |
Type |
Description |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) getIntegrationEvents(userId, callback)
Get all campaigns, including team campaigns, of a user
Parameters:
| Name |
Type |
Description |
userId |
string
|
ID of the user |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) getOwnedTeams()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) getTeams(userId, callback)
Get all teams of a user
Parameters:
| Name |
Type |
Description |
userId |
string
|
ID of the user |
callback |
function
|
Callback to execute when done (optional) |
- Source:
(async) list()
- Deprecated:
- Unsupported in Tiltify API v5
- Source:
(async) self(callback)
Parameters:
| Name |
Type |
Description |
callback |
function
|
Callback to execute when done (optional) |
- Deprecated:
- Source: