Package com.cheetahdigital.challenges.core.api

Class ChallengeParams

  • All Implemented Interfaces:
    android.os.Parcelable
    public class ChallengeParams
extends com.cheetahdigital.corekit.rest.params.BaseListQueryParams
    Class for setting the query parameters of Challenges API All Nullable parameters means you can remove the parameter by passing a null value.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ChallengeParams.Builder
      Builder class for ChallengeParams

      • Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

        com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder<P extends com.cheetahdigital.corekit.rest.params.BaseListQueryParams,​B extends com.cheetahdigital.corekit.rest.params.BaseListQueryParams.BaseListQueryBuilder>

      • Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseParams

        com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder<T extends com.cheetahdigital.corekit.rest.params.BaseParams,​B extends com.cheetahdigital.corekit.rest.params.BaseParams.BaseBuilder>

      • Nested classes/interfaces inherited from interface android.os.Parcelable

        android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

    • Field Summary

      • Fields inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

        CREATOR

      • Fields inherited from class com.cheetahdigital.corekit.rest.params.BaseParams

        mId, mQueryMap

      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

    • Constructor Summary

      Constructors 
      Constructor Description
      ChallengeParams()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCategory()
      Returns the category
      java.lang.Boolean getRespondable()
      Returns the respondable flag
      java.lang.String getResponseId()
      Get the challenge response id
      java.lang.Boolean isShowAsAlert()
      Returns the show alert flag
      java.lang.Boolean isShowPollResult()
      Returns the show poll result flag
      void setCategory​(java.lang.String category)
      Set the challenge category
      void setRespondable​(java.lang.Boolean respondable)
      Set to show respondable challenges
      void setResponseId​(java.lang.String responseId)
      Set the challenge response id
      void setShowAsAlert​(java.lang.Boolean showAsAlert)
      Set to show as alert
      void setShowPollResult​(java.lang.Boolean showPollResult)
      Set to show poll results

      • Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

        addCategories, addCategory, clearCategories, describeContents, getCategories, getItemsPerPage, getLayout, getPage, getSortBy, getSortOrder, removeCategory, setItemsPerPage, setLayout, setPage, setSortBy, setSortOrder, writeToParcel

      • Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseParams

        addParam, getAccessToken, getId, getParam, getQueryMap, setAccessToken, setId

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ChallengeParams

        public ChallengeParams()

    • Method Detail

      • getResponseId

        public java.lang.String getResponseId()
        Get the challenge response id
        Returns:
        challenge response id

      • setResponseId

        public void setResponseId​(java.lang.String responseId)
        Set the challenge response id
        Parameters:
        responseId - challenge response id

      • setShowAsAlert

        public void setShowAsAlert​(java.lang.Boolean showAsAlert)
        Set to show as alert
        Parameters:
        showAsAlert - true to show as alert

      • setShowPollResult

        public void setShowPollResult​(java.lang.Boolean showPollResult)
        Set to show poll results
        Parameters:
        showPollResult - true to show poll results

      • setRespondable

        public void setRespondable​(java.lang.Boolean respondable)
        Set to show respondable challenges
        Parameters:
        respondable - true to show respondable challenges

      • setCategory

        public void setCategory​(java.lang.String category)
        Set the challenge category
        Parameters:
        category - challenge category

      • isShowAsAlert

        public java.lang.Boolean isShowAsAlert()
        Returns the show alert flag
        Returns:
        show alert flag

      • isShowPollResult

        public java.lang.Boolean isShowPollResult()
        Returns the show poll result flag
        Returns:
        show poll result flag

      • getRespondable

        public java.lang.Boolean getRespondable()
        Returns the respondable flag
        Returns:
        respondable flag

      • getCategory

        public java.lang.String getCategory()
        Returns the category
        Returns:
        category