Class PromoCode
Defined in File PromoCode.h
Page Contents
Nested Relationships
Nested Types
Inheritance Relationships
Base Type
public axr::sdk::EntityBase
(Class EntityBase)
Class Documentation
-
class PromoCode : public axr::sdk::EntityBase
Describes a single product that can be purchased by a customer.
Public Functions
-
inline PromoCode()
-
inline virtual ~PromoCode()
-
inline virtual PromoCode &SetProperties(const std::map<utility::string_t, Variant> &value) override
Sets the object’s underlying map of stored values.
-
inline virtual PromoCode &SetProperties(std::map<utility::string_t, Variant> &&value) override
Sets the underlying map of stored values for the object.
-
inline virtual PromoCode &SetProperty(const utility::char_t *name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual PromoCode &SetProperty(const utility::string_t &name, const Variant &value) override
Sets the property of the given name to the provided value.
-
inline virtual PromoCode &SetRemoteUrl(const utility::string_t &url) override
Returns the URL of the remote server endpoint where the object is managed.
-
inline virtual PromoCode &SetUid(const utility::string_t &value) override
Sets the value of the Uid property.
- Parameters
value – The value to set.
-
inline virtual PromoCode &SetDateCreated(const datetime &value) override
Sets the value of the DateCreated property.
- Parameters
value – The value to set.
-
inline virtual PromoCode &SetDateModified(const datetime &value) override
Sets the value of the DateModified property.
- Parameters
value – The value to set.
-
inline virtual PromoCode &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 GetName() const
The unique name of the promotional code.
-
utility::string_t GetDescription() const
The textual description of the promotion.
-
uint64_t GetMaxUses() const
The asset to display for the feature’s icon
-
datetime GetExpires() const
The date and time that the promotion expires and can no longer be redeemed. A
null
value indicates no expiration date.
-
uint64_t GetRedeemed() const
The number of times that this promotion has been redeemed.
-
std::vector<utility::string_t> GetProducts() const
The list of product uid’s that this promotion can be applied to. If
null
then applies to all products.
-
std::vector<utility::string_t> GetCustomers() const
The list of wallet uid’s that can redeem this promotion. If
null
then anyone can redeem.
Public Static Functions
-
static inline const utility::char_t *ClassName()
Returns the fully qualified name of the class.
-
class Type : public axr::sdk::StringEnum<Type>
-
inline PromoCode()