Class: Category

inventory.Category()

new Category()

Source:

Methods

(static) Category#getCanonical() → {Null|base.Reference}

Get the field value Reference to canonical category
Source:
Returns:
Type
Null | base.Reference

(static) Category#getDeleted() → {Null|Boolean}

Get the field value Whether the category has been deleted.
Source:
Returns:
Type
Null | Boolean

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

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

(static) Category#getItems() → {Null|Array.<base.Reference>}

Get the field value Ordered list of items associated with this category.
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Category#getMenuSection() → {Null|inventory.MenuSection}

Get the field value Menu Section attribute that can be expanded to menu section specific attributes
Source:
Returns:
Type
Null | inventory.MenuSection

(static) Category#getModifiedTime() → {Null|Number}

Get the field value The time this category was last modified
Source:
Returns:
must be a long integer
Type
Null | Number

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

Get the field value The name of the category which will appear in Clover Register App.
Source:
Returns:
Type
String

(static) Category#getSortOrder() → {Null|Number}

Get the field value Integer used to determine how this category is sorted against other categories.
Source:
Returns:
must be an integer
Type
Null | Number

(static) Category#setCanonical(canonical)

Set the field value Reference to canonical category
Parameters:
Name Type Description
canonical Null | base.Reference
Source:

(static) Category#setDeleted(deleted)

Set the field value Whether the category has been deleted.
Parameters:
Name Type Description
deleted Null | Boolean
Source:

(static) Category#setId(id)

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

(static) Category#setItems(items)

Set the field value Ordered list of items associated with this category.
Parameters:
Name Type Description
items Null | Array.<base.Reference> An array of
Source:

(static) Category#setMenuSection(menuSection)

Set the field value Menu Section attribute that can be expanded to menu section specific attributes
Parameters:
Name Type Description
menuSection Null | inventory.MenuSection
Source:

(static) Category#setModifiedTime(modifiedTime)

Set the field value The time this category was last modified
Parameters:
Name Type Description
modifiedTime Null | Number must be a long integer
Source:

(static) Category#setName(name)

Set the field value The name of the category which will appear in Clover Register App.
Parameters:
Name Type Description
name String
Source:

(static) Category#setSortOrder(sortOrder)

Set the field value Integer used to determine how this category is sorted against other categories.
Parameters:
Name Type Description
sortOrder Null | Number must be an integer
Source: