Class Product

• Defined in File Product.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.Product : xbe.sdk.EntityBase

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

REQUIRES: Purchasing Services

Public Functions

Product ()

Product (Object obj)

Properties

string Name { get; set; }

The unique name of the product.

string Title { get; set; }

The name to display to the user.

string Background { get; set; }

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

string > Categories { get; set; }

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

Object Cover { get; set; }

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

Currency Currency { get; set; }

The form of currency pertaining to the price.

string Description { get; set; }

A textual description of the product.

Object Features { get; set; }

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

string Icon { get; set; }

The icon to display when showing the product description.

string Logo { get; set; }

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

ProductLicense License { get; set; }

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

double Msrp { get; set; }

The manufacturer suggested retail price of the product.

double Price { get; set; }

The amount of money that the product costs to purchase.

string > Requires { get; set; }

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

int Reserved { get; set; }

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

string > Roles { get; set; }

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

string > Slideshow { get; set; }

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

int Sold { get; set; }

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

string Summary { get; set; }

A brief textual overview of the product.

string > Tags { get; set; }

The list of tags associated with the product.

int Units { get; set; }

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

Object Data { get; set; }

An arbitrary map of metadata associated with this product.

int Featured { get; set; }

The featured display index of the product, if any. If product is not featured, index is set to -1.

string DefaultLaunchProfile { get; set; }

The default LaunchProfile uid to launch the product with.

string > LaunchProfiles { get; set; }

The list of LaunchProfiles available to the product.

Public Static Functions

new Product Parse (string json)

Parses the given JSON encoded string into a new Product instance.

Param json:

Return: