Whitebeam Template Reference Documentation
System TemplateremoveByItem() - Available since version 1.3.9 Removes all files referenced by a specific catalogue item ID See Also rb.file.remove() rb.file.get() rb.file.create() rb.file.modify()Syntax number = rb.file.removeByItem(itemID) Parameters The 'removeByItem' method takes 1 parameter:
Results The 'removeByItem' method returns number:
Remarks This method takes a catalogue itemID and deletes all files associated with that item (that is all files in the 'fileRefs' array). As well as deleting the file objects the method also removes the corresponding entry in the fileRef array - on successful completion of this method the 'fileRefs' array in the item will be empty. This method is most useful as part of a process for deleting an item. Note: if a file object is shared with other items references in those items (fileRefs) will not be modified.
|
