Whitebeam Template Reference Documentation
Iterator data type representing an arc
The rb.collection.arcQueryData struct has 10 elements:
|Name ||Type/Value ||Range/Length ||Description |
|arcType||string||1-50 characters ||Required.
Type of this collection (eg 'forum membership')
The numeric type ID for this arc
|sourceType||string||C, I or N ||Required. 'C':contact, 'I':item, 'N':node|
|sourceID||number|| ||Required. The numeric ID of the source element for this link. Only useful if a starting node has *not* been specified|
|targetType||string||C, I or N ||Required. 'C':contact, 'I':item, 'N':node|
|subType||string||0-10 characters ||Optional. The short filter string logged against this arc|
|targetID||number|| ||Required. ID of the target for this arc|
|timestamp||number|| ||Optional. Time stamp stored against this record|
|relationData||MetaData|| ||Optional. A link record represents a relationship between the collection owner and the target. This field allows the application to store
application specific data that describes in more detail information about the relationship between the owner and the member
|target||MetaData|| ||Optional. Details of the item at the end of the specified arc. The contents of this object will vary depending on the value of 'type'
and with the value of 'allData' in the iterator request. With a value for allData of 0 (zero) this object is not created.
Details are held in the tutorial on the collection template.
This is the type definition for the iterator returned by rb.collection.getArcs. The values returned depend on
the attribute values in the arcSearchType object passed to 'getArcs'.
(loadtime : 183ms)