Class ActivityParams
- java.lang.Object
-
- com.cheetahdigital.corekit.rest.params.BaseParams
-
- com.cheetahdigital.corekit.rest.params.BaseListQueryParams
-
- com.cheetahdigital.activities.core.api.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 AllNullable
parameters means you can remove the parameter by passing anull
value.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActivityParams.Builder
Builder class forActivityParams
-
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>
-
-
Field Summary
Fields Modifier and Type Field Description static android.os.Parcelable.Creator<ActivityParams>
CREATOR
-
Constructor Summary
Constructors Constructor Description ActivityParams()
ActivityParams(android.os.Parcel in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getEarnedMetrics()
Returns the filtered metric name parameterjava.lang.Boolean
getWithDetails()
Returns the with details parameterjava.lang.Boolean
getWithMetricChange()
Returns the with metric change parametervoid
setEarnedMetrics(java.lang.String earnedMetrics)
Set the metric name to filter the Activitiesvoid
setWithDetails(java.lang.Boolean withDetails)
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
-
-
-
-
Field Detail
-
CREATOR
public static final android.os.Parcelable.Creator<ActivityParams> CREATOR
-
-
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)
- 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
-
-