Package com.cheetahdigital.badges.core.api

Class BadgesAPI

  • All Implemented Interfaces:
    com.cheetahdigital.corekit.rest.RestController
    public class BadgesAPI
extends com.cheetahdigital.corekit.models.module.Controller
    Class for setting the query parameters of Badges API All Nullable parameters mean you can remove the parameter by passing null value.

    • Field Summary

      • Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

        STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

    • Constructor Summary

      Constructors 
      Constructor Description
      BadgesAPI()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void getBadge​(BadgeParams badgeParams, boolean clearCache, com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Badge>,​Badge> listener)
      Get the Badge details using the id from the BadgeParams
      void getBadges​(BadgeParams badgeParams, boolean clearCache, com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Metadata>,​Metadata> listener)
      Get all available/published badges
      void getMemberBadges​(BadgeParams badgeParams, boolean clearCache, com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Badges>,​Badges> listener)
      Get all the badges awarded to a member

      • Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

        createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BadgesAPI

        public BadgesAPI()

    • Method Detail

      • getBadge

        public void getBadge​(BadgeParams badgeParams,
                     boolean clearCache,
                     com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Badge>,​Badge> listener)
        Get the Badge details using the id from the BadgeParams
        Parameters:
        badgeParams - BadgeParams query parameters
        clearCache - true to clear cache, otherwise false
        listener - callback for the API

      • getBadges

        public void getBadges​(BadgeParams badgeParams,
                      boolean clearCache,
                      com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Metadata>,​Metadata> listener)
        Get all available/published badges
        Parameters:
        badgeParams - BadgeParams query parameters
        clearCache - boolean true to clear cache, otherwise false
        listener - callback for the API

      • getMemberBadges

        public void getMemberBadges​(BadgeParams badgeParams,
                            boolean clearCache,
                            com.cheetahdigital.corekit.models.module.ListenerModel<com.cheetahdigital.corekit.models.BaseModel<Badges>,​Badges> listener)
        Get all the badges awarded to a member
        Parameters:
        badgeParams - BadgeParams query parameters
        clearCache - boolean true to clear cache, otherwise false
        listener - callback for the API