Package com.apple.itunes.storekit.model

Class ConsumptionRequest

java.lang.Object
com.apple.itunes.storekit.model.ConsumptionRequest
public class ConsumptionRequest extends Object
The request body containing consumption information.
See Also:

  • Constructor Details

    • ConsumptionRequest

      public ConsumptionRequest()

  • Method Details

    • customerConsented

      public ConsumptionRequest customerConsented(Boolean customerConsented)

    • getCustomerConsented

      public Boolean getCustomerConsented()
      A Boolean value that indicates whether the customer consented to provide consumption data to the App Store.
      Returns:
      customerConsented
      See Also:

    • setCustomerConsented

      public void setCustomerConsented(Boolean customerConsented)

    • consumptionStatus

      public ConsumptionRequest consumptionStatus(ConsumptionStatus consumptionStatus)

    • getConsumptionStatus

      public ConsumptionStatus getConsumptionStatus()
      A value that indicates the extent to which the customer consumed the in-app purchase.
      Returns:
      consumptionStatus
      See Also:

    • getRawConsumptionStatus

      public Integer getRawConsumptionStatus()
      See Also:

    • setConsumptionStatus

      public void setConsumptionStatus(ConsumptionStatus consumptionStatus)

    • setRawConsumptionStatus

      public void setRawConsumptionStatus(Integer rawConsumptionStatus)

    • platform

      public ConsumptionRequest platform(Platform platform)

    • getPlatform

      public Platform getPlatform()
      A value that indicates the platform on which the customer consumed the in-app purchase.
      Returns:
      platform
      See Also:

    • getRawPlatform

      public Integer getRawPlatform()
      See Also:

    • setPlatform

      public void setPlatform(Platform platform)

    • setRawPlatform

      public void setRawPlatform(Integer rawPlatform)

    • sampleContentProvided

      public ConsumptionRequest sampleContentProvided(Boolean sampleContentProvided)

    • getSampleContentProvided

      public Boolean getSampleContentProvided()
      A Boolean value that indicates whether you provided, prior to its purchase, a free sample or trial of the content, or information about its functionality.
      Returns:
      sampleContentProvided
      See Also:

    • setSampleContentProvided

      public void setSampleContentProvided(Boolean sampleContentProvided)

    • deliveryStatus

      public ConsumptionRequest deliveryStatus(DeliveryStatus deliveryStatus)

    • getDeliveryStatus

      public DeliveryStatus getDeliveryStatus()
      A value that indicates whether the app successfully delivered an in-app purchase that works properly.
      Returns:
      deliveryStatus
      See Also:

    • getRawDeliveryStatus

      public Integer getRawDeliveryStatus()
      See Also:

    • setDeliveryStatus

      public void setDeliveryStatus(DeliveryStatus deliveryStatus)

    • setRawDeliveryStatus

      public void setRawDeliveryStatus(Integer rawDeliveryStatus)

    • appAccountToken

      public ConsumptionRequest appAccountToken(UUID appAccountToken)

    • getAppAccountToken

      public UUID getAppAccountToken()
      The UUID that an app optionally generates to map a customer’s in-app purchase with its resulting App Store transaction.
      Returns:
      appAccountToken
      See Also:

    • setAppAccountToken

      public void setAppAccountToken(UUID appAccountToken)

    • accountTenure

      public ConsumptionRequest accountTenure(AccountTenure accountTenure)

    • getAccountTenure

      public AccountTenure getAccountTenure()
      The age of the customer’s account.
      Returns:
      accountTenure
      See Also:

    • getRawAccountTenure

      public Integer getRawAccountTenure()
      See Also:

    • setAccountTenure

      public void setAccountTenure(AccountTenure accountTenure)

    • setRawAccountTenure

      public void setRawAccountTenure(Integer rawAccountTenure)

    • playTime

      public ConsumptionRequest playTime(PlayTime playTime)

    • getPlayTime

      public PlayTime getPlayTime()
      A value that indicates the amount of time that the customer used the app.
      Returns:
      playTime
      See Also:

    • getRawPlayTime

      public Integer getRawPlayTime()
      See Also:

    • setPlayTime

      public void setPlayTime(PlayTime playTime)

    • setRawPlayTime

      public void setRawPlayTime(Integer rawPlayTime)

    • lifetimeDollarsRefunded

      public ConsumptionRequest lifetimeDollarsRefunded(LifetimeDollarsRefunded lifetimeDollarsRefunded)

    • getLifetimeDollarsRefunded

      public LifetimeDollarsRefunded getLifetimeDollarsRefunded()
      A value that indicates the total amount, in USD, of refunds the customer has received, in your app, across all platforms.
      Returns:
      lifetimeDollarsRefunded
      See Also:

    • getRawLifetimeDollarsRefunded

      public Integer getRawLifetimeDollarsRefunded()
      See Also:

    • setLifetimeDollarsRefunded

      public void setLifetimeDollarsRefunded(LifetimeDollarsRefunded lifetimeDollarsRefunded)

    • setRawLifetimeDollarsRefunded

      public void setRawLifetimeDollarsRefunded(Integer rawLifetimeDollarsRefunded)

    • lifetimeDollarsPurchased

      public ConsumptionRequest lifetimeDollarsPurchased(LifetimeDollarsPurchased lifetimeDollarsPurchased)

    • getLifetimeDollarsPurchased

      public LifetimeDollarsPurchased getLifetimeDollarsPurchased()
      A value that indicates the total amount, in USD, of in-app purchases the customer has made in your app, across all platforms.
      Returns:
      lifetimeDollarsPurchased
      See Also:

    • getRawLifetimeDollarsPurchased

      public Integer getRawLifetimeDollarsPurchased()
      See Also:

    • setLifetimeDollarsPurchased

      public void setLifetimeDollarsPurchased(LifetimeDollarsPurchased lifetimeDollarsPurchased)

    • setRawLifetimeDollarsPurchased

      public void setRawLifetimeDollarsPurchased(Integer rawLifetimeDollarsPurchased)

    • userStatus

      public ConsumptionRequest userStatus(UserStatus userStatus)

    • getUserStatus

      public UserStatus getUserStatus()
      The status of the customer’s account.
      Returns:
      userStatus
      See Also:

    • getRawUserStatus

      public Integer getRawUserStatus()
      See Also:

    • setUserStatus

      public void setUserStatus(UserStatus userStatus)

    • setRawUserStatus

      public void setRawUserStatus(Integer rawUserStatus)

    • refundPreference

      public ConsumptionRequest refundPreference(RefundPreference refundPreference)

    • getRefundPreference

      public RefundPreference getRefundPreference()
      A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund.
      Returns:
      refundPreference
      See Also:

    • getRawRefundPreference

      public Integer getRawRefundPreference()
      See Also:

    • setRefundPreference

      public void setRefundPreference(RefundPreference refundPreference)

    • setRawRefundPreference

      public void setRawRefundPreference(Integer rawRefundPreference)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object