Class Purchase

• Defined in File Purchase.h

Inheritance Relationships

Base Type

• public xbe::sdk::EntityBase (Class EntityBase)

Class Documentation

class Purchase : public xbe::sdk::EntityBase

Describes a single product that has been purchased by a user.

Public Functions

inline Purchase()

inline Purchase(const Purchase &value)

inline Purchase(Purchase &&value)

inline virtual ~Purchase()

inline virtual Purchase &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual Purchase &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual Purchase &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Purchase &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Purchase &SetRemoteUrl(const utility::string_t &url) override

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Purchase &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters:

value – The value to set.

inline virtual Purchase &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters:

value – The value to set.

inline virtual Purchase &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters:

value – The value to set.

inline virtual Purchase &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters:

value – The value to set.

virtual void Validate() override

utility::string_t GetProductUid() const

The unique order number.

datetime GetExpirationDate() const

The date and time that this purchase will expire. A undefined value indicates no expiration.

utility::string_t GetReferral() const

The unique identifier of the third party that referred this purchase sale.

datetime GetRenewalDate() const

The date and time that the purchase will be automatically renewed. A undefined value indicates that either the purchase does not require renewal (perpetual license) or will not be automatically renewed at the end of the licensing term.

datetime GetStartDate() const

The date and time that the license to the purchase began.

std::shared_ptr<Object> GetData() const

An arbitrary map of metadata associated with this purchase.

utility::string_t GetWalletUid() const

The unique identifier of the wallet that wants to purchase the order.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.