@plentymarkets/shop-api / categoryEntryGetters
Variable: categoryEntryGetters ​
constcategoryEntryGetters:object
Defined in: getters/categoryEntryGetters.ts:143
Type Declaration ​
getChildCount ​
getChildCount: (
categoryEntry) =>number
Returns the number of child categories for a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
number
The child count, or 0 if not set.
getChildren ​
getChildren: (
categoryEntry) =>CategoryEntry[]
Returns the child category entries of a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
An array of child CategoryEntry objects, or an empty array if none exist.
getClients ​
getClients: (
categoryEntry) =>client[]
Returns the list of webstore clients associated with a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
client[]
An array of client objects, or an empty array if none exist.
getDetails ​
getDetails: (
categoryEntry) =>CategoryDetails[]
Returns the localised details of a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
An array of CategoryDetails objects, or an empty array if none exist.
getId ​
getId: (
categoryEntry) =>number
Returns the numeric ID of a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
number
The category ID, or 0 if not set.
getItemCount ​
getItemCount: (
categoryEntry) =>ItemCount[]
Returns the item count entries for a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
An array of ItemCount objects, or an empty array if not set.
getLevel ​
getLevel: (
categoryEntry) =>number
Returns the nesting level of a category entry in the category tree.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
number
The level number, or 0 if not set.
getLinklist ​
getLinklist: (
categoryEntry) =>string
Returns whether the category is displayed as a link list in the frontend.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
string
The linklist flag string (e.g. "Y" or "N"), or an empty string if not set.
getParentCategoryId ​
getParentCategoryId: (
categoryEntry) =>number
Returns the ID of the parent category for a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
number
The parent category ID, or 0 if the category is a root category.
getRight ​
getRight: (
categoryEntry) =>string
Returns the access right of a category entry (e.g. "all", "customer").
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
string
The right string, or an empty string if not set.
getRobots ​
getRobots: (
categoryEntry) =>string
Returns the robots meta tag setting for a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
string
The robots string (e.g. "ALL", "NOINDEX"), or an empty string if not set.
getSitemap ​
getSitemap: (
categoryEntry) =>string
Returns the sitemap inclusion setting for a category entry.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
string
The sitemap flag string, or an empty string if not set.
getType ​
getType: (
categoryEntry) =>string
Returns the type of a category entry (e.g. "item", "container", "content").
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
string
The category type string, or an empty string if not set.
hasChildren ​
hasChildren: (
categoryEntry) =>boolean
Returns whether the category entry has child categories.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
boolean
true if the category has children, otherwise false.
isLinkedToWebstore ​
isLinkedToWebstore: (
categoryEntry) =>boolean
Returns whether the category entry is linked to the active webstore.
Parameters ​
categoryEntry ​
The category entry object.
Returns ​
boolean
true if linked to the webstore, otherwise false.