Managing the HistoryCollector

The
HistoryCollector
managed object provides operations for managing the life-cycle and scrollable view of a collection.
  • DestroyCollector
    – A
    HistoryCollector
    exists only for the current session. Invoke the
    DestroyCollector
    operation to explicitly destroy the collector before the session ends.
  • ResetCollector
    – Adjusts the starting position for the subset of objects from the collector to the object immediately preceding the current
    latestPage
    .
  • RewindCollector
    – Positions the
    latestPage
    to the oldest item in the array. When a
    HistoryCollector
    is created, this is the default location.
  • SetCollectorPageSize
    – Accepts an integer parameter to set the size of the
    latestPage
    property of a
    HistoryCollector
    . The default size of a
    HistoryCollector
    is an array that consists of at most 1000 objects of the appropriate type (
    Task
    ,
    Event
    ). The array is sorted by creation date and time of the objects.