AggregateValue

open class AggregateValue: TransformValue

Encapsulates an OData aggregate transformation item.

  • The items in the from clause of the aggregate item.

    Declaration

    Swift

    final public var aggregateFromList: AggregateFromList = AggregateFromList()

  • The alias of the aggregate transformation item.

    Declaration

    Swift

    open var alias: String?

  • Creates a $count aggregate transformation item.

    Declaration

    Swift

    open class func count(as alias: String) -> AggregateValue

    Parameters

    alias

    The alias for the aggregate item.

    Return Value

    The aggregate transformation value.

  • Creates an aggregate transformation item.

    Declaration

    Swift

    open class func create(_ value: DataValue?, method: AggregateMethod?, alias: String?) -> AggregateValue

    Parameters

    value

    The value to be aggregated.
    method

    The aggregate method to be used for aggregating.
    alias

    The alias for the returned result property.

    Return Value

    The aggregate transformation value.

  • Adds a ‘from’ clause to the aggregate.

    Declaration

    Swift

    open func from(_ propertyPath: PropertyPath, method: AggregateMethod?) -> AggregateValue

    Parameters

    propertyPath

    The property path for the ‘from’ clause.
    method

    The aggregate method for the ‘from’ clause.

    Return Value

    The aggregate transformation value.

  • True if the aggregate transformation item represents a $count item.

    Declaration

    Swift

    open var isCount: Bool

  • The method of the aggregate transformation item.

    Declaration

    Swift

    open var method: AggregateMethod?

  • The value of the aggregate transformation item.

    Declaration

    Swift

    open var value: DataValue?