Package com.cheetahdigital.activities.core.api

Class ActivityParams

  • All Implemented Interfaces:
    android.os.Parcelable
    public class ActivityParams
extends com.cheetahdigital.corekit.rest.params.BaseListQueryParams
    Class for setting the query parameters of Activities 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  ActivityParams.Builder
      Builder class for ActivityParams

      • 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 
      Modifier and Type Field Description
      static android.os.Parcelable.Creator<ActivityParams> 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getEarnedMetrics()
      Returns the filtered metric name parameter
      java.lang.Boolean getWithDetails()
      Returns the with details parameter
      java.lang.Boolean getWithMetricChange()
      Returns the with metric change parameter
      void setEarnedMetrics​(java.lang.String earnedMetrics)
      Set the metric name to filter the Activities
      void setWithDetails​(java.lang.Boolean withDetails)
      Set visibility of details field in Activity Default value is true in server
      void setWithMetricChange​(java.lang.Boolean withMetricChange)
      Set visibility of Activities with non-zero metric amount

      • 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

    • Field Detail

      • CREATOR

        public static final android.os.Parcelable.Creator<ActivityParams> CREATOR

    • Constructor Detail

      • ActivityParams

        public ActivityParams()

      • ActivityParams

        public ActivityParams​(android.os.Parcel in)

    • Method Detail

      • setWithMetricChange

        public void setWithMetricChange​(@Nullable
                                java.lang.Boolean withMetricChange)
        Set visibility of Activities with non-zero metric amount
        Parameters:
        withMetricChange - true to show Activities with non-zero metric amount; otherwise, false

      • setWithDetails

        public void setWithDetails​(@Nullable
                           java.lang.Boolean withDetails)
        Set visibility of details field in Activity Default value is true in server
        Parameters:
        withDetails - true to include details in Activities list

      • setEarnedMetrics

        public void setEarnedMetrics​(@Nullable
                             java.lang.String earnedMetrics)
        Set the metric name to filter the Activities
        Parameters:
        earnedMetrics - the metric name to filter

      • getWithMetricChange

        public java.lang.Boolean getWithMetricChange()
        Returns the with metric change parameter
        Returns:
        with metric change flag

      • getWithDetails

        public java.lang.Boolean getWithDetails()
        Returns the with details parameter
        Returns:
        with details flag

      • getEarnedMetrics

        public java.lang.String getEarnedMetrics()
        Returns the filtered metric name parameter
        Returns:
        filtered metric name