Class: module:models/ProductListLink

module:models/ProductListLink()

Constructs a new ProductListLink. Document representing a link to a product list.

Source:

Members

(readonly) TypeEnum :String

Allowed values for the type property.

Type:
  • String
Source:

(inner, constant) custom_1

value: "custom_1"

Source:

(inner, constant) custom_2

value: "custom_2"

Source:

(inner, constant) custom_3

value: "custom_3"

Source:

(inner) description :String

The description of this product list.

Type:
  • String
Source:

(inner, constant) gift_registry

value: "gift_registry"

Source:

The target of the link.

Type:
  • String
Source:

(inner) name :String

The name of this product list.

Type:
  • String
Source:

(inner) public :Boolean

A flag indicating whether the owner made this product list available for access by other customers.

Type:
  • Boolean
Source:

(inner, constant) shopping_list

value: "shopping_list"

Source:

(inner) title :String

The link title.

Type:
  • String
Source:

(inner) type :module:models/ProductListLink.TypeEnum

The type of the product list.

Type:
  • module:models/ProductListLink.TypeEnum
Source:

(inner, constant) wish_list

value: "wish_list"

Source:

Methods

(static) constructFromObject(data, obj) → {module:models/ProductListLink}

Constructs a ProductListLink from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/ProductListLink

Optional instance to populate.

Source:
Returns:

The populated ProductListLink instance.

Type
module:models/ProductListLink