Class Product

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class Product : public axr::sdk::EntityBase

Describes a single product that can be purchased by a customer.

Public Functions

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

Sets the object’s underlying map of stored values.

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

Sets the underlying map of stored values for the object.

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

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

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

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

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

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

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

Sets the value of the Uid property.

Parameters

value – The value to set.

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

Sets the value of the DateCreated property.

Parameters

value – The value to set.

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

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual Product &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 product.

utility::string_t GetTitle() const

The name to display to the user.

utility::string_t GetBackground() const

The URL to the background media or CSS style to display on the product page.

std::vector<utility::string_t> GetCategories() const

The list of product category identifiers that this product belongs to.

std::shared_ptr<Object> GetCover() const

The set of cover images to use when showing the product.

The returned object will have the following properties:

  • hero - The cover image of the format. 10:3 3000x900px

  • landscape - The cover image of the format landscape. 16:9 2560x1440px

  • square - The cover image of the format square. 1:1 1440x1440px

  • portrait - The cover image of the format portrait. 7:10 1008x1440px

  • mini - The cover image of the format mini landscape. 3:1 1080x360px

const Currency *GetCurrency() const

The form of currency pertaining to the price.

utility::string_t GetDescription() const

A textual description of the product.

std::shared_ptr<Object> GetFeatures() const

The map of feature uid’s to a quantity value that the product offers.

utility::string_t GetIcon() const

The icon to display when showing the product description.

utility::string_t GetLogo() const

The URL of the image to display when viewing the product in a table or grid.

const License *GetLicense() const

The length of time that the product license is good for.

float GetMSRP() const

The manufacturer suggested retail price of the product.

float GetPrice() const

The amount of money that the product costs to purchase.

std::vector<utility::string_t> GetRequires() const

The list of other product or category identifiers that must be purchased before this product can be acquired.

uint64_t GetReserved() const

The number of units that have been reserved for purchasing through pending orders.

std::vector<utility::string_t> GetRoles() const

A list of roles that users must have in order to view/buy this product.

std::vector<utility::string_t> GetSlideshow() const

A list of media URLs to display at the top of the product information page.

uint64_t GetSold() const

The number of units of this product that have been sold.

utility::string_t GetSummary() const

A brief textual overview of the product.

std::vector<utility::string_t> GetTags() const

The list of tags associated with the product.

int64_t GetUnits() const

The maximum number of units of this product that are for sale. A negative value indicates an unlimited quantity.

std::shared_ptr<Object> GetData() const

An arbitrary map of metadata associated with this product.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.

class License : public axr::sdk::StringEnum<License>

The form of currency pertaining to the price of a product or service.

Public Static Attributes

static const License *ANNUAL
static const License *MONTH
static const License *PERPETUAL