StreamPosition

public enum StreamPosition : BoxEnum

Stream position used for stream pagination

  • now

    When used, Box API will return 0 events and the latest streamPosition value to be used for subsequent call.

    Declaration

    Swift

    case now
  • When used, Box API will return all available events.

    Declaration

    Swift

    case zero
  • Custom value of a stream position used when using value not yet implemented in this SDK (of similar usage as none, now or zero)

    Declaration

    Swift

    case customValue(String)
  • Creates a new value

    Declaration

    Swift

    public init(_ value: String)

    Parameters

    value

    String representation of a StreamPosition rawValue

  • Returns string representation of StreamPosition

    Declaration

    Swift

    public var description: String { get }