CustomContentBase::FetchObject (open)

Get a single object

Syntax

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

RECORD FUNCTION FetchObject(DATETIME commanddate, STRING groupid, STRING objectid)

Parameters

DATETIME commanddate

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

STRING groupid

The group the get the list of objects of

STRING objectid

If of the object

Return value

RECORD

The result

document_body

The document's body text

RECORD document_fields

List of fields and values to index (prefix DATETIME fields with "date_")

STRING error

If the call did not succeed, this cell may contain an error message

indexdate

Date of last modification of this object (optional). If not present, the document will always be replaced in the index.

links

All links found in the object

links.link

Link URL

links.text

Link text

links.type

Link type

objects

New objects found within the group

objects.data

Optional data of the object (if not provided, FetchObject will be called with the object id)

objects.id

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).

STRING status

"result" if call succeeded, "error" if an error ocurred, "notfound" if not found