Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Const claimUserQuestRewards

  • 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

    Returns Promise<IUserQuest>

Const getQuestRewards

  • 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

    Returns Promise<IPaginatedResponse<IQuestReward>>

Const getQuests

  • Gets Quests available in an application.

    async
    since

    2.27.0

    example
    getQuests({ questIds }).then(padinatedResponse => console.log(padinatedResponse))
    

    Parameters

    Returns Promise<IPaginatedResponse<IQuest>>

Const getUserQuestRewards

  • 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

    Returns Promise<IPaginatedResponse<IUserQuestReward>>

Const getUserQuests

  • Gets Quests of a user(complete/incomplete).

    async
    since

    2.27.0

    example
    getUserQuests({ profileId }).then(padinatedResponse => console.log(padinatedResponse))
    

    Parameters

    Returns Promise<IPaginatedResponse<IUserQuest>>

Const incrementUserQuestTaskProgress

  • Increment user quest quest progress for current user.

    async
    since

    2.28.0

    example
    incrementUserQuestTaskProgress({ userQuestTaskId, customIncrement }).then(userQuestTask => console.log(userQuestTask))
    

    Parameters

    Returns Promise<IUserQuest>

Const setUserQuestTaskProgress

  • 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

    Returns Promise<IUserQuest>

Const startUserQuest

  • Start a quest for current user.

    async
    since

    2.27.0

    example
    startUserQuest({ questId }).then(userQuest => console.log(userQuest))
    

    Parameters

    Returns Promise<IUserQuest>

Const updateUserQuestTasks

  • Complete a quest task for current user.

    async
    since

    2.27.0

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

    Parameters

    Returns Promise<IUserQuest>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc