Package com.bitheads.braincloud.services

Class GamificationService

java.lang.Object
com.bitheads.braincloud.services.GamificationService
public class GamificationService
extends Object

  • Field Details

  • Constructor Details

  • Method Details

    • setAchievementAwardedDelegate

      public void setAchievementAwardedDelegate​(IAchievementsDelegate delegate)
      Sets the achievement awarded delegate which is called anytime an achievement is awarded
      Parameters:
      delegate - Achievement awarded delegate

    • readAllGamification

      public void readAllGamification​(boolean includeMetaData, IServerCallback callback)
      Method retrieves all gamification data for the player. Service Name - Gamification Service Operation - Read
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - The callback handler

    • readMilestones

      public void readMilestones​(boolean includeMetaData, IServerCallback callback)
      Method retrieves all milestones defined for the game. Service Name - Gamification Service Operation - ReadMilestones
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - The callback handler

    • readAchievements

      public void readAchievements​(boolean includeMetaData, IServerCallback callback)
      Read all of the achievements defined for the game. Service Name - Gamification Service Operation - ReadAchievements
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - The callback handler

    • readXpLevels

      public void readXpLevels​(IServerCallback callback)
      Method returns all defined xp levels and any rewards associated with those xp levels. Service Name - Gamification Service Operation - ReadXpLevels
      Parameters:
      callback - Callback.

    • readAchievedAchievements

      public void readAchievedAchievements​(boolean includeMetaData, IServerCallback callback)
      Method retrives the list of achieved achievements. Service Name - Gamification Service Operation - ReadAchievedAchievements
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readCompletedMilestones

      public void readCompletedMilestones​(boolean includeMetaData, IServerCallback callback)
      Method retrieves the list of completed milestones. Service Name - Gamification Service Operation - ReadCompleteMilestones
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readInProgressMilestones

      public void readInProgressMilestones​(boolean includeMetaData, IServerCallback callback)
      Method retrieves the list of in progress milestones Service Name - Gamification Service Operation - ReadInProgressMilestones
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readMilestonesByCategory

      public void readMilestonesByCategory​(String category, boolean includeMetaData, IServerCallback callback)
      Method retrieves milestones of the given category. Service Name - Gamification Service Operation - ReadMilestonesByCategory
      Parameters:
      category - The milestone category
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • awardAchievements

      public void awardAchievements​(String[] achievementIds, IServerCallback callback)
      Method will award the achievements specified. On success, this will call AwardThirdPartyAchievement to hook into the client-side Achievement service (ie GameCentre, Facebook etc). Service Name - Gamification Service Operation - AwardAchievements
      Parameters:
      achievementIds - Array of achievement ids to award
      callback - Callback.

    • checkForAchievementsToAward

      public void checkForAchievementsToAward​(ServiceName serviceName, ServiceOperation serviceOperation, String data)

    • readQuests

      public void readQuests​(boolean includeMetaData, IServerCallback callback)
      Method retrieves all of the quests defined for the game. Service Name - Gamification Service Operation - ReadQuests
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback. { "status": 200, "data": { "quests": [] } }

    • readQuestsCompleted

      public void readQuestsCompleted​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadCompletedQuests
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readQuestsInProgress

      public void readQuestsInProgress​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadInProgressQuests
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readQuestsNotStarted

      public void readQuestsNotStarted​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadNotStartedQuests
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readQuestsWithStatus

      public void readQuestsWithStatus​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadQuestsWithStatus
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readQuestsWithBasicPercentage

      public void readQuestsWithBasicPercentage​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadQuestsWithBasicPercentage
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback.

    • readQuestsWithComplexPercentage

      public void readQuestsWithComplexPercentage​(boolean includeMetaData, IServerCallback callback)
      Service Name - Gamification Service Operation - ReadQuestsWithComplexPercentage
      Parameters:
      includeMetaData - Whether to return meta data as well
      callback - Callback

    • readQuestsByCategory

      public void readQuestsByCategory​(String category, boolean includeMetaData, IServerCallback callback)
      Method Service Name - Gamification Service Operation - ReadQuestsByCategory
      Parameters:
      category - The quest category
      includeMetaData - Whether to return meta data as well
      callback - Callback.