Scripting Object - VcTaskHistoryCollector

Scripting-object corresponding to
TaskHistoryCollector
Returned by
createCollectorForTasks

Scripting Object Description

TaskHistoryCollector provides a mechanism for retrieving historical data and updates when the server appends new tasks.

Attributes

Name Type Description
filter_AnyValueObject

@since VI API 2.5
filter_FloatValueNumber

@since VI API 2.5
filter_IntValueNumber

@since VI API 2.5
filter_LongValueNumber

@since VI API 2.5
idString

@since Unknown
latestPageVcTaskInfo []

@since VI API 2.5
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, destroyCollector, readNextTasks, readPreviousTasks, resetCollector, rewindCollector, setCollectorPageSize

setCollectorPageSize

Sets the "viewable latest page" size to contain at most the number of items specified by the maxCount parameter).

@since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

rewindCollector

Moves the "scrollable view" to the oldest item. If you use {@link vim.TaskHistoryCollector#readNext ReadNextTasks} or {@link vim.event.EventHistoryCollector#readNext ReadNextEvents}, all items are retrieved from the oldest item to the newest item. This is the default setting when the collector is created. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

readNextTasks

Reads the 'scrollable view' from the current position. The scrollable position is moved to the next newer page after the read. No item is returned when the end of the collector is reached.

@since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
VcTaskInfo []

destroyCollector

Destroys this collector. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

readPreviousTasks

Reads the 'scrollable view' from the current position. The scrollable position is then moved to the next older page after the read. No item is returned when the head of the collector is reached.

@since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
VcTaskInfo []

resetCollector

Moves the "scrollable view" to the item immediately preceding the "viewable latest page". If you use "readPrev", {@link vim.TaskHistoryCollector#readPrev ReadPreviousTasks} or {@link vim.event.EventHistoryCollector#readPrev ReadPreviousEvents}, all items are retrieved from the newest item to the oldest item. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None