Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

Catalogue Template

category.linkItems()

Creates and removes associations between an item and categories in the catalogue.

See Also

rb.catalogue.category.unlinkItem()    rb.catalogue.category.linkItem()    rb.catalogue.category.item.create()   

Syntax

number = rb.catalogue.category.linkItems(itemID, parentNodeIDList)

Parameters

The 'category.linkItems' method takes 2 parameters:

Name Type/Value Range/Length Description
itemIDnumberValid itemID Required. Identifier of the item being linked to a category node.
parentNodeIDListarray of numbersValid nodeID Required. A list of category nodeIDs. If the nodeID is negative then remove association between this item and the absolute value of the node ID specified.

Results

The 'category.linkItems' method returns number:

Type/Value Range/Length Description
number itemID, -1 Identifier of the item being linked.

Remarks

An item can be explicitly associated with one or more existing categories. An item that is not explicitly linked using this method is referred to as an 'orphan' item (default when created).

Whitebeam release 1.3.36
(loadtime : 92ms)