Package com.cheetahdigital.event.core.api

Class EventsParams

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

      • 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<EventsParams> 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
      void addSubCategories​(java.lang.String... subCategories)
      Add sub categories to filter the list
      void addSubCategory​(java.lang.String category)
      Add a sub category to filter the list.
      void clearSubCategories()
      Clear all the categories
      int describeContents()  
      java.util.List<java.lang.String> getSubCategories()
      Get the current list of sub categories
      java.lang.String getTimeZone()  
      java.lang.Boolean isResultWithCategories()
      Returns the result with categories flag
      void removeSubCategory​(java.lang.String category)
      Remove a sub category to the existing list of categories
      void setResultWithCategories​(java.lang.Boolean resultWithCategories)
      Set to show the categories associated by the events
      void setTimezone​(java.lang.String timezone)
      Set the timezone used for the current call
      void writeToParcel​(android.os.Parcel dest, int flags)  

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

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

      • 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<EventsParams> CREATOR

    • Constructor Detail

      • EventsParams

        public EventsParams()

      • EventsParams

        public EventsParams​(android.os.Parcel in)

    • Method Detail

      • describeContents

        public int describeContents()
        Specified by:
        describeContents in interface android.os.Parcelable
        Overrides:
        describeContents in class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

      • writeToParcel

        public void writeToParcel​(android.os.Parcel dest,
                          int flags)
        Specified by:
        writeToParcel in interface android.os.Parcelable
        Overrides:
        writeToParcel in class com.cheetahdigital.corekit.rest.params.BaseListQueryParams

      • addSubCategories

        public void addSubCategories​(@NonNull
                             java.lang.String... subCategories)
        Add sub categories to filter the list
        Parameters:
        subCategories - sub categories to filter

      • addSubCategory

        public void addSubCategory​(@NonNull
                           java.lang.String category)
        Add a sub category to filter the list.
        Parameters:
        category - category to filter.

      • getSubCategories

        @Nullable
public java.util.List<java.lang.String> getSubCategories()
        Get the current list of sub categories
        Returns:
        list of sub categories

      • removeSubCategory

        public void removeSubCategory​(@NonNull
                              java.lang.String category)
        Remove a sub category to the existing list of categories
        Parameters:
        category - category to be removed

      • clearSubCategories

        public void clearSubCategories()
        Clear all the categories

      • setResultWithCategories

        public void setResultWithCategories​(@Nullable
                                    java.lang.Boolean resultWithCategories)
        Set to show the categories associated by the events
        Parameters:
        resultWithCategories - true to show the categories associated by the offer

      • isResultWithCategories

        @Nullable
public java.lang.Boolean isResultWithCategories()
        Returns the result with categories flag
        Returns:
        result with categories flag

      • setTimezone

        public void setTimezone​(@Nullable
                        java.lang.String timezone)
        Set the timezone used for the current call
        Parameters:
        timezone - timezone of the current request

      • getTimeZone

        public java.lang.String getTimeZone()
        Returns:
        current timezone set for the current call