Ordering

@Beta
class Ordering

Represents an ordering criterion for sorting documents in a Firestore pipeline.

You create Ordering instances using the ascending and descending helper methods.

Summary

Nested types

Public companion functions
Ordering

Create an Ordering that sorts documents in ascending order based on value of expr.
Ordering
ascending(fieldName: String)

Creates an Ordering that sorts documents in ascending order based on field.
Ordering

Create an Ordering that sorts documents in descending order based on value of expr.
Ordering
descending(fieldName: String)

Creates an Ordering that sorts documents in descending order based on field.

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
Ordering.Direction
Expression

Public companion functions

ascending

fun ascending(expr: Expression): Ordering

Create an Ordering that sorts documents in ascending order based on value of expr.

Parameters
expr: Expression

The order is based on the evaluation of the Expression.
Returns
Ordering

A new Ordering object with ascending sort by expr.

ascending

fun ascending(fieldName: String): Ordering

Creates an Ordering that sorts documents in ascending order based on field.

Parameters
fieldName: String

The name of field to sort documents.
Returns
Ordering

A new Ordering object with ascending sort by field.

descending

fun descending(expr: Expression): Ordering

Create an Ordering that sorts documents in descending order based on value of expr.

Parameters
expr: Expression

The order is based on the evaluation of the Expression.
Returns
Ordering

A new Ordering object with descending sort by expr.

descending

fun descending(fieldName: String): Ordering

Creates an Ordering that sorts documents in descending order based on field.

Parameters
fieldName: String

The name of field to sort documents.
Returns
Ordering

A new Ordering object with descending sort by field.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

dir

val dir: Ordering.Direction

expr

val expr: Expression