|
|
Whitebeam Template Reference Documentation
|
Catalogue Template
item.remove()
Deletes an item, its prices and associations to categories, files and contacts.
Syntax
number = rb.catalogue.item.remove(itemID, andFiles)
Parameters
The 'item.remove' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | itemID | number | Valid itemID | Required. Identifier of an item to be removed. | | andFiles | bool | | Optional, default = 0
If specified then remove all files that are attached to this catalogue item. |
Results
The 'item.remove' method returns number:
| Type/Value | Range/Length | Description |
| number |
itemID, -1 | itemID of the deleted item.
|
Remarks
The item is irreversibly removed along with prices, categories, file and contact
associations. Files are not removed but may implicitly become orphaned.
Also, contentsMkr of its parent category will be altered if this was its only sub item.
For a container item, any contained items will become self-contained. For a contained item,
its container will be made self-contained when it has no more contained items.
|
|
|
(loadtime : 63ms) |
