CustomContentBase::ListObjects3 (open)

Get a list of all objects within a group

Syntax

LOADLIB "mod::consilio/lib/contentproviders/customcontent.whlib";

RECORD FUNCTION ListObjects3(DATETIME commanddate, STRING groupid, RECORD ARRAY current_objects, RECORD options)

Parameters

DATETIME commanddate

Date when this command (or its oldest ancestor) was issued

STRING groupid

The group the get the list of objects of

RECORD ARRAY current_objects

List of currently present objects. Fields can be specified with GetListObjectFields (only filled in update mode, not in rebuild mode)

RECORD options

Options

BOOLEAN rebuild

If this is a rebuild action or just a check

Return value

RECORD

The result

error

Return a record with an 'error' cell of type string if an error occurred

objects

The list of objects

objects.id

The id of the object

requiredindexdate

If the indexdate of the version of the object currently stored in the index is at least this value, it is kept as-is and not re-fetched. (warning: don't use this if FetchObject returns other objects not returned by this ListObjects, because those objects will not be discovered, and subsequently removed).

status

"result" if call succeeded, "error" if an error ocurred