quest | @livelike/engagementsdk

Index

Namespaces

<internal>

Functions

Const claimUserQuestRewards

claimUserQuestRewards(args: IClaimUserQuestArgs): Promise<IUserQuest>

Claim a User quest rewards using userQuestId.

async

since

2.30.0

example

claimUserQuestRewards({ userQuestId: "3936bf69-caea-481e-a376-46929d32da4f" })
 .then(userQuestTask => console.log(userQuestTask))

Parameters

args: IClaimUserQuestArgs

Returns Promise<IUserQuest>

Const getQuestRewards

getQuestRewards(args: IQuestRewardArgs): Promise<IPaginatedResponse<IQuestReward>>

Get Quest rewards for a given quest using questId.
async
since
2.30.0

example
```
getQuestRewards({ questId: "1936bf69-caea-481e-a376-46929d32da4f" })
 .then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: IQuestRewardArgs
Returns Promise<IPaginatedResponse<IQuestReward>>

Const getQuests

getQuests(args: IQuestArgs): Promise<IPaginatedResponse<IQuest>>

Gets Quests available in an application.
async
since
2.27.0

example
```
getQuests({ questIds }).then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: IQuestArgs
Returns Promise<IPaginatedResponse<IQuest>>

Const getUserQuestRewards

getUserQuestRewards(args: IUserQuestRewardArgs): Promise<IPaginatedResponse<IUserQuestReward>>

Get User quest rewards for a given user quest using userQuestId.
async
since
2.30.0

example
```
getUserQuestRewards({ userQuestId: "3936bf69-caea-481e-a376-46929d32da4f" })
 .then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: IUserQuestRewardArgs
Returns Promise<IPaginatedResponse<IUserQuestReward>>

Const getUserQuests

getUserQuests(args: IUserQuestArgs): Promise<IPaginatedResponse<IUserQuest>>

Gets Quests of a user(complete/incomplete).
async
since
2.27.0

example
```
getUserQuests({ profileId }).then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: IUserQuestArgs
Returns Promise<IPaginatedResponse<IUserQuest>>

Const incrementUserQuestTaskProgress

incrementUserQuestTaskProgress(args: IIncrementUserQuestTaskProgressArgs): Promise<IUserQuest>

Increment user quest quest progress for current user.
async
since
2.28.0

example
```
incrementUserQuestTaskProgress({ userQuestTaskId, customIncrement }).then(userQuestTask => console.log(userQuestTask))
```
Parameters
- args: IIncrementUserQuestTaskProgressArgs
Returns Promise<IUserQuest>

Const setUserQuestTaskProgress

setUserQuestTaskProgress(args: IUpdateUserQuestTaskProgressArgs): Promise<IUserQuest>

Update user quest quest progress (to an absolute value) for current user.
async
since
2.28.0

example
```
setUserQuestTaskProgress({ userQuestTaskId, customProgress }).then(userQuestTask => console.log(userQuestTask))
```
Parameters
- args: IUpdateUserQuestTaskProgressArgs
Returns Promise<IUserQuest>

Const startUserQuest

startUserQuest(args: IStartQuestArgs): Promise<IUserQuest>

Start a quest for current user.
async
since
2.27.0

example
```
startUserQuest({ questId }).then(userQuest => console.log(userQuest))
```
Parameters
- args: IStartQuestArgs
Returns Promise<IUserQuest>

Const updateUserQuestTasks

updateUserQuestTasks(args: IUpdateUserQuestTaskArgs): Promise<IUserQuest>

Complete a quest task for current user.

async

since

2.27.0

example

updateUserQuestTasks({ userQuestId, userQuestTaskIds, status: "completed" }).then(userQuest => console.log(userQuest))

Parameters

args: IUpdateUserQuestTaskArgs

Returns Promise<IUserQuest>

Generated using TypeDoc

Index

Namespaces

Functions

Functions

Const claimUserQuestRewards

Parameters

args: IClaimUserQuestArgs

Returns Promise<IUserQuest>

Const getQuestRewards

Parameters

args: IQuestRewardArgs

Returns Promise<IPaginatedResponse<IQuestReward>>

Const getQuests

Parameters

args: IQuestArgs

Returns Promise<IPaginatedResponse<IQuest>>

Const getUserQuestRewards

Parameters

args: IUserQuestRewardArgs

Returns Promise<IPaginatedResponse<IUserQuestReward>>

Const getUserQuests

Parameters

args: IUserQuestArgs

Returns Promise<IPaginatedResponse<IUserQuest>>

Const incrementUserQuestTaskProgress

Parameters

args: IIncrementUserQuestTaskProgressArgs

Returns Promise<IUserQuest>

Const setUserQuestTaskProgress

Parameters

args: IUpdateUserQuestTaskProgressArgs

Returns Promise<IUserQuest>

Const startUserQuest

Parameters

args: IStartQuestArgs

Returns Promise<IUserQuest>

Const updateUserQuestTasks

Parameters

args: IUpdateUserQuestTaskArgs

Returns Promise<IUserQuest>