StreamPaginationIterator

public class StreamPaginationIterator : PaginationIterator<Event>

Implements pagination specifically for events using nextStreamPosition instead of marker or offset.

  • The next position in the Box event stream. Use this position in your next request to get the next set of events. If no nextStreamPosition is defined, then Box sends all available events beginning with the oldest stream position.

    Declaration

    Swift

    public private(set) var nextStreamPosition: String?
  • Maximum number of items for a page.

    Declaration

    Swift

    public private(set) var limit: Int?
  • Gets next collection of items based on nextStreamPosition

    Declaration

    Swift

    public override func nextItems(completion: @escaping (Result<[Event], BoxSDKError>) -> Void)

    Parameters

    completion

    Returns either collection of items or an error.