Package com.cheetahdigital.offers.core.api

Class OfferParams

  • All Implemented Interfaces:
    android.os.Parcelable
    public class OfferParams
extends BaseListQueryParams
    Class for setting the query parameters of Offers API. All Nullable parameters means you can remove the parameter by passing a null value.

    • Field Detail

      • CREATOR

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

    • Constructor Detail

      • OfferParams

        public OfferParams​(android.os.Parcel in)

      • OfferParams

        public OfferParams()

    • Method Detail

      • setIncludeClipped

        public void setIncludeClipped​(@Nullable
                              java.lang.Boolean includeClipped)
        Set the visibility of is_clipped tag
        Parameters:
        includeClipped - true to show is_clipped tag

      • setIncludeResponses

        public void setIncludeResponses​(@Nullable
                                java.lang.Boolean includeResponses)
        Set to include offer responses
        Parameters:
        includeResponses - true to include offer responses

      • setResultWithCategories

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

      • setSet

        public void setSet​(@Nullable
                   java.lang.String set)
        Set the internal name of Offer set
        Parameters:
        set - internal name of Offer set

      • setStartIndex

        public void setStartIndex​(@Nullable
                          java.lang.Integer startIndex)
        Set the start index of the available Offers subset. Used in conjunction with set.
        Parameters:
        startIndex - start index

      • setEndIndex

        public void setEndIndex​(@Nullable
                        java.lang.Integer endIndex)
        Set the end index of the available Offers subset. Used in conjunction with set.
        Parameters:
        endIndex - end index

      • setPlacement

        public void setPlacement​(@Nullable
                         java.lang.String placement)
        Set the offer set name
        Parameters:
        placement - offer set name

      • setRespondable

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

      • setShowClipped

        public void setShowClipped​(@Nullable
                           java.lang.Boolean showClipped)
        Set to show is_clipped attribute
        Parameters:
        showClipped - true to show is_clipped attributes.

      • setShowTarget

        public void setShowTarget​(@Nullable
                          java.lang.Boolean showTarget)
        Set the visibility of offer target
        Parameters:
        showTarget - true to show offer target

      • addProcessingStatus

        public void addProcessingStatus​(@NonNull
                                java.lang.String... processingStatus)
        Set the status if clipped or unclipped
        Parameters:
        processingStatus - status if clipped or unclipped

      • addProcessingStatus

        public void addProcessingStatus​(@NonNull
                                java.lang.String processingStatus)
        Add a processing status to the list
        Parameters:
        processingStatus - status if clipped or unclipped

      • removeProcessingStatus

        public void removeProcessingStatus​(@NonNull
                                   java.lang.String processingStatus)
        Remove a processing status to the list
        Parameters:
        processingStatus - status if clipped or unclipped

      • clearProcessingStatus

        public void clearProcessingStatus()
        Clear the processing status list

      • setUsable

        public void setUsable​(@Nullable
                      java.lang.Boolean usable)
        Set the visibility of usable offer responses
        Parameters:
        usable - true to show usable offer response

      • setOfferWithResponses

        public void setOfferWithResponses​(@Nullable
                                  java.lang.Boolean offerWithResponses)
        Set the visibility of offer responses
        Parameters:
        offerWithResponses - true to show offer responses

      • setDisplayableProcessingStatuses

        public void setDisplayableProcessingStatuses​(@Nullable
                                             java.lang.String displayableProcessingStatuses)
        Set visibility of embedded responses with processing status matching its value. Default is clipped and pending if not provided
        Parameters:
        displayableProcessingStatuses - processing status

      • setApplyToCategories

        public void setApplyToCategories​(@Nullable
                                 java.lang.String applyToCategories)
        Set the category to apply has_usable and has_processing_status response filters only to Offers with categories matching with the provided value
        Parameters:
        applyToCategories - category

      • setHasProcessingStatus

        public void setHasProcessingStatus​(@Nullable
                                   java.lang.String hasProcessingStatus)
        Set the processing status to only show offers with responses having processing_status = to submitted values.
        Parameters:
        hasProcessingStatus - processing status

      • setHasUsable

        public void setHasUsable​(@Nullable
                         java.lang.Boolean hasUsable)
        Set to only show offers with responses that are still usable. Defaults to false (ignore response usage periods) if not provided.
        Parameters:
        hasUsable - has usable flag

      • setPrioritizedCategory

        public void setPrioritizedCategory​(@Nullable
                                   java.lang.String prioritizedCategory)
        Set the prioritized category to sort the Offers by the given value
        Parameters:
        prioritizedCategory - category

      • setClipStatus

        public void setClipStatus​(@Nullable
                          java.lang.String clipStatus)
        Set the clip status
        Parameters:
        clipStatus - clip status

      • setOfferType

        public void setOfferType​(@Nullable
                         java.lang.String offerType)
        Set the offer type that will be used to filter the type of offers that will be included in the response
        Parameters:
        offerType - Can be any of ‘barcode’, ‘certificate’, ‘coupon’, ‘url’ or ‘stellar’. Can also be multiple by passing a comma-separated string. (e.g. "url,coupon")

      • isIncludeClipped

        @Nullable
public java.lang.Boolean isIncludeClipped()
        Returns the include clipped flag
        Returns:
        include clipped flag

      • isIncludeResponses

        @Nullable
public java.lang.Boolean isIncludeResponses()
        Returns the include responses flag
        Returns:
        include responses flag

      • isResultWithCategories

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

      • getSet

        @Nullable
public java.lang.String getSet()
        Returns the internal of the offer set
        Returns:
        internal name of offer set

      • getStartIndex

        @Nullable
public java.lang.Integer getStartIndex()
        Returns the start index of the available Offers subset.
        Returns:
        start index of the Offers subset

      • getEndIndex

        @Nullable
public java.lang.Integer getEndIndex()
        Returns the end index of the available Offers subset.
        Returns:
        end index of the Offers subset

      • getPlacement

        @Nullable
public java.lang.String getPlacement()
        Returns the offer set name
        Returns:
        offer set name

      • getRespondable

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

      • isShowClipped

        @Nullable
public java.lang.Boolean isShowClipped()
        Returns the show clipped flag
        Returns:
        show clipped flag

      • isShowTarget

        @Nullable
public java.lang.Boolean isShowTarget()
        Returns the show target flag
        Returns:
        show target flag

      • getProcessingStatus

        @Nullable
public java.util.List<java.lang.String> getProcessingStatus()
        Returns the processing status
        Returns:
        processing status, either clipped or unclipped

      • isUsable

        @Nullable
public java.lang.Boolean isUsable()
        Returns the usable flag for offer responses
        Returns:
        usable flag

      • isOfferWithResponses

        @Nullable
public java.lang.Boolean isOfferWithResponses()
        Returns the offer with responses flag
        Returns:
        offer with responses flag

      • getDisplayableProcessingStatus

        @Nullable
public java.lang.String getDisplayableProcessingStatus()
        Returns the processing status that was set to show the embedded responses
        Returns:
        processing status

      • getApplyToCategories

        @Nullable
public java.lang.String getApplyToCategories()
        Returns the category to apply has_usable and has_processing_status response filters only to Offers with categories matching with the provided value
        Returns:
        category

      • hasProcessingStatus

        @Nullable
public java.lang.String hasProcessingStatus()
        Returns the processing status that was set to show offers with responses matching the provided value
        Returns:
        processing status

      • hasUsable

        @Nullable
public java.lang.Boolean hasUsable()
        Returns the flag that was set to show offers with responses that are stil usable
        Returns:
        has usable flag

      • getPrioritizedCategory

        @Nullable
public java.lang.String getPrioritizedCategory()
        Returns the prioritized category that was used to sort the Offers
        Returns:
        prioritized category

      • getClipStatus

        @Nullable
public java.lang.String getClipStatus()
        Returns the clip status
        Returns:
        clip status

      • getOfferType

        @Nullable
public java.lang.String getOfferType()
        Type of offer
        Returns:
        Can be any of ‘barcode’, ‘certificate’, ‘coupon’, ‘url’ or ‘stellar’. Can also be multiple (e.g. "url,coupon").