Class: ModifierGroup

inventory.ModifierGroup()

new ModifierGroup()

Source:

Methods

(static) ModifierGroup#getAlternateName() → {String}

Get the field value
Source:
Returns:
Type
String

(static) ModifierGroup#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) ModifierGroup#getItems() → {Array.<base.Reference>}

Get the field value
Source:
Returns:
An array of
Type
Array.<base.Reference>

(static) ModifierGroup#getMaxAllowed() → {Number}

Get the field value The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register
Source:
Returns:
must be an integer
Type
Number

(static) ModifierGroup#getMinRequired() → {Number}

Get the field value The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register
Source:
Returns:
must be an integer
Type
Number

(static) ModifierGroup#getModifierIds() → {String}

Get the field value An ordered, comma-separated list of modifier ids in this group. (READ ONLY)
Source:
Returns:
Type
String

(static) ModifierGroup#getModifiers() → {Array.<inventory.Modifier>}

Get the field value
Source:
Returns:
An array of
Type
Array.<inventory.Modifier>

(static) ModifierGroup#getName() → {String}

Get the field value Name of the modifier group
Source:
Returns:
Type
String

(static) ModifierGroup#getShowByDefault() → {Boolean}

Get the field value Whether employees will be automatically prompted to add modifiers from this category when using Register
Source:
Returns:
Type
Boolean

(static) ModifierGroup#getSortOrder() → {Number}

Get the field value The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.
Source:
Returns:
must be an integer
Type
Number

(static) ModifierGroup#setAlternateName(alternateName)

Set the field value
Parameters:
Name Type Description
alternateName String
Source:

(static) ModifierGroup#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) ModifierGroup#setItems(items)

Set the field value
Parameters:
Name Type Description
items Array.<base.Reference> An array of
Source:

(static) ModifierGroup#setMaxAllowed(maxAllowed)

Set the field value The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register
Parameters:
Name Type Description
maxAllowed Number must be an integer
Source:

(static) ModifierGroup#setMinRequired(minRequired)

Set the field value The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register
Parameters:
Name Type Description
minRequired Number must be an integer
Source:

(static) ModifierGroup#setModifierIds(modifierIds)

Set the field value An ordered, comma-separated list of modifier ids in this group. (READ ONLY)
Parameters:
Name Type Description
modifierIds String
Source:

(static) ModifierGroup#setModifiers(modifiers)

Set the field value
Parameters:
Name Type Description
modifiers Array.<inventory.Modifier> An array of
Source:

(static) ModifierGroup#setName(name)

Set the field value Name of the modifier group
Parameters:
Name Type Description
name String
Source:

(static) ModifierGroup#setShowByDefault(showByDefault)

Set the field value Whether employees will be automatically prompted to add modifiers from this category when using Register
Parameters:
Name Type Description
showByDefault Boolean
Source:

(static) ModifierGroup#setSortOrder(sortOrder)

Set the field value The ordinal value used to determine where in an ordered list this modifier group should appear relative to others.
Parameters:
Name Type Description
sortOrder Number must be an integer
Source: