Package com.apple.itunes.storekit.model

Class JWSTransactionDecodedPayload

java.lang.Object
com.apple.itunes.storekit.model.JWSTransactionDecodedPayload
All Implemented Interfaces:
DecodedSignedData
public class JWSTransactionDecodedPayload extends Object implements DecodedSignedData
A decoded payload containing transaction information.
See Also:

  • Constructor Details

    • JWSTransactionDecodedPayload

      public JWSTransactionDecodedPayload()

  • Method Details

    • originalTransactionId

      public JWSTransactionDecodedPayload originalTransactionId(String originalTransactionId)

    • getOriginalTransactionId

      public String getOriginalTransactionId()
      The original transaction identifier of a purchase.
      Returns:
      originalTransactionId
      See Also:

    • setOriginalTransactionId

      public void setOriginalTransactionId(String originalTransactionId)

    • transactionId

      public JWSTransactionDecodedPayload transactionId(String transactionId)

    • getTransactionId

      public String getTransactionId()
      The unique identifier for a transaction such as an in-app purchase, restored in-app purchase, or subscription renewal.
      Returns:
      transactionId
      See Also:

    • setTransactionId

      public void setTransactionId(String transactionId)

    • webOrderLineItemId

      public JWSTransactionDecodedPayload webOrderLineItemId(String webOrderLineItemId)

    • getWebOrderLineItemId

      public String getWebOrderLineItemId()
      The unique identifier of subscription-purchase events across devices, including renewals.
      Returns:
      webOrderLineItemId
      See Also:

    • setWebOrderLineItemId

      public void setWebOrderLineItemId(String webOrderLineItemId)

    • bundleId

      public JWSTransactionDecodedPayload bundleId(String bundleId)

    • getBundleId

      public String getBundleId()
      The bundle identifier of an app.
      Returns:
      bundleId
      See Also:

    • setBundleId

      public void setBundleId(String bundleId)

    • productId

      public JWSTransactionDecodedPayload productId(String productId)

    • getProductId

      public String getProductId()
      The unique identifier for the product, that you create in App Store Connect.
      Returns:
      productId
      See Also:

    • setProductId

      public void setProductId(String productId)

    • subscriptionGroupIdentifier

      public JWSTransactionDecodedPayload subscriptionGroupIdentifier(String subscriptionGroupIdentifier)

    • getSubscriptionGroupIdentifier

      public String getSubscriptionGroupIdentifier()
      The identifier of the subscription group that the subscription belongs to.
      Returns:
      subscriptionGroupIdentifier
      See Also:

    • setSubscriptionGroupIdentifier

      public void setSubscriptionGroupIdentifier(String subscriptionGroupIdentifier)

    • purchaseDate

      public JWSTransactionDecodedPayload purchaseDate(Long purchaseDate)

    • getPurchaseDate

      public Long getPurchaseDate()
      The time that the App Store charged the user’s account for an in-app purchase, a restored in-app purchase, a subscription, or a subscription renewal after a lapse.
      Returns:
      purchaseDate
      See Also:

    • setPurchaseDate

      public void setPurchaseDate(Long purchaseDate)

    • originalPurchaseDate

      public JWSTransactionDecodedPayload originalPurchaseDate(Long originalPurchaseDate)

    • getOriginalPurchaseDate

      public Long getOriginalPurchaseDate()
      The purchase date of the transaction associated with the original transaction identifier.
      Returns:
      originalPurchaseDate
      See Also:

    • setOriginalPurchaseDate

      public void setOriginalPurchaseDate(Long originalPurchaseDate)

    • expiresDate

      public JWSTransactionDecodedPayload expiresDate(Long expiresDate)

    • getExpiresDate

      public Long getExpiresDate()
      The UNIX time, in milliseconds, an auto-renewable subscription expires or renews.
      Returns:
      expiresDate
      See Also:

    • setExpiresDate

      public void setExpiresDate(Long expiresDate)

    • quantity

      public JWSTransactionDecodedPayload quantity(Integer quantity)

    • getQuantity

      public Integer getQuantity()
      The number of consumable products purchased.
      Returns:
      quantity
      See Also:

    • setQuantity

      public void setQuantity(Integer quantity)

    • type

      public JWSTransactionDecodedPayload type(Type type)

    • getType

      public Type getType()
      The type of the in-app purchase.
      Returns:
      type
      See Also:

    • getRawType

      public String getRawType()
      See Also:

    • setType

      public void setType(Type type)

    • setRawType

      public void setRawType(String rawType)

    • appAccountToken

      public JWSTransactionDecodedPayload 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)

    • inAppOwnershipType

      public JWSTransactionDecodedPayload inAppOwnershipType(InAppOwnershipType inAppOwnershipType)

    • getInAppOwnershipType

      public InAppOwnershipType getInAppOwnershipType()
      A string that describes whether the transaction was purchased by the user, or is available to them through Family Sharing.
      Returns:
      inAppOwnershipType
      See Also:

    • getRawInAppOwnershipType

      public String getRawInAppOwnershipType()
      See Also:

    • setInAppOwnershipType

      public void setInAppOwnershipType(InAppOwnershipType inAppOwnershipType)

    • setRawInAppOwnershipType

      public void setRawInAppOwnershipType(String rawInAppOwnershipType)

    • signedDate

      public JWSTransactionDecodedPayload signedDate(Long signedDate)

    • getSignedDate

      public Long getSignedDate()
      The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
      Specified by:
      getSignedDate in interface DecodedSignedData
      Returns:
      signedDate
      See Also:

    • setSignedDate

      public void setSignedDate(Long signedDate)

    • revocationReason

      public JWSTransactionDecodedPayload revocationReason(RevocationReason revocationReason)

    • getRevocationReason

      public RevocationReason getRevocationReason()
      The reason that the App Store refunded the transaction or revoked it from family sharing.
      Returns:
      revocationReason
      See Also:

    • getRawRevocationReason

      public Integer getRawRevocationReason()
      See Also:

    • setRevocationReason

      public void setRevocationReason(RevocationReason revocationReason)

    • setRawRevocationReason

      public void setRawRevocationReason(Integer rawRevocationReason)

    • revocationDate

      public JWSTransactionDecodedPayload revocationDate(Long revocationDate)

    • getRevocationDate

      public Long getRevocationDate()
      The UNIX time, in milliseconds, that Apple Support refunded a transaction.
      Returns:
      revocationDate
      See Also:

    • setRevocationDate

      public void setRevocationDate(Long revocationDate)

    • isUpgraded

      public JWSTransactionDecodedPayload isUpgraded(Boolean isUpgraded)

    • getIsUpgraded

      public Boolean getIsUpgraded()
      The Boolean value that indicates whether the user upgraded to another subscription.
      Returns:
      isUpgraded
      See Also:

    • setIsUpgraded

      public void setIsUpgraded(Boolean isUpgraded)

    • offerType

      public JWSTransactionDecodedPayload offerType(OfferType offerType)

    • getOfferType

      public OfferType getOfferType()
      A value that represents the promotional offer type.
      Returns:
      offerType
      See Also:

    • getRawOfferType

      public Integer getRawOfferType()
      See Also:

    • setOfferType

      public void setOfferType(OfferType offerType)

    • setRawOfferType

      public void setRawOfferType(Integer rawOfferType)

    • offerIdentifier

      public JWSTransactionDecodedPayload offerIdentifier(String offerIdentifier)

    • getOfferIdentifier

      public String getOfferIdentifier()
      The identifier that contains the promo code or the promotional offer identifier.
      Returns:
      offerIdentifier
      See Also:

    • setOfferIdentifier

      public void setOfferIdentifier(String offerIdentifier)

    • environment

      public JWSTransactionDecodedPayload environment(Environment environment)

    • getEnvironment

      public Environment getEnvironment()
      The server environment, either sandbox or production.
      Returns:
      environment
      See Also:

    • getRawEnvironment

      public String getRawEnvironment()
      See Also:

    • setEnvironment

      public void setEnvironment(Environment environment)

    • setRawEnvironment

      public void setRawEnvironment(String rawEnvironment)

    • storefront

      public JWSTransactionDecodedPayload storefront(String storefront)

    • getStorefront

      public String getStorefront()
      The three-letter code that represents the country or region associated with the App Store storefront of the purchase.
      Returns:
      storefront
      See Also:

    • setStorefront

      public void setStorefront(String storefront)

    • storefrontId

      public JWSTransactionDecodedPayload storefrontId(String storefrontId)

    • getStorefrontId

      public String getStorefrontId()
      An Apple-defined value that uniquely identifies an App Store storefront.
      Returns:
      storefrontId
      See Also:

    • setStorefrontId

      public void setStorefrontId(String storefrontId)

    • transactionReason

      public JWSTransactionDecodedPayload transactionReason(TransactionReason transactionReason)

    • getTransactionReason

      public TransactionReason getTransactionReason()
      The cause of a purchase transaction, which indicates whether it’s a customer’s purchase or a renewal for an auto-renewable subscription that the system initiates.
      Returns:
      transactionReason
      See Also:

    • getRawTransactionReason

      public String getRawTransactionReason()
      See Also:

    • setTransactionReason

      public void setTransactionReason(TransactionReason transactionReason)

    • setRawTransactionReason

      public void setRawTransactionReason(String rawTransactionReason)

    • price

      public JWSTransactionDecodedPayload price(Long price)

    • getPrice

      public Long getPrice()
      The price, in milliunits, of the in-app purchase or subscription offer that you configured in App Store Connect.
      Returns:
      price
      See Also:

    • setPrice

      public void setPrice(Long price)

    • currency

      public JWSTransactionDecodedPayload currency(String currency)

    • getCurrency

      public String getCurrency()
      The three-letter ISO 4217 currency code for the price of the product.
      Returns:
      currency
      See Also:

    • setCurrency

      public void setCurrency(String currency)

    • offerDiscountType

      public JWSTransactionDecodedPayload offerDiscountType(OfferDiscountType offerDiscountType)

    • getOfferDiscountType

      public OfferDiscountType getOfferDiscountType()
      The payment mode you configure for an introductory offer, promotional offer, or offer code on an auto-renewable subscription.
      Returns:
      offerDiscountType
      See Also:

    • getRawOfferDiscountType

      public String getRawOfferDiscountType()
      See Also:

    • setOfferDiscountType

      public void setOfferDiscountType(OfferDiscountType offerDiscountType)

    • setRawOfferDiscountType

      public void setRawOfferDiscountType(String rawOfferDiscountType)

    • unknownFields

      public JWSTransactionDecodedPayload unknownFields(Map<String,Object> unknownFields)

    • getUnknownFields

      public Map<String,Object> getUnknownFields()
      Fields that are not recognized for this object
      Returns:
      A map of JSON keys to objects

    • setUnknownFields

      public void setUnknownFields(Map<String,Object> unknownFields)

    • 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