API reference
API reference
Select your platform
No SDKs available
No versions available

SortBuilder Class

Modifiers: final
A builder class for constructing sorting criteria and configurations.
This builder provides an API for defining complex sorting operations, including:
  • Multiple sort criteria with different attribute types
  • Pagination through the take method
  • Building the final sort configuration
Example usage -- Sort by the intVar attribute of the TestComponent; if there's a tie, sort by the stringVar attribute, ignoring case. Take the first 10 items: 
val sortConfig = Query.where{ has(TestComponent.id) }
                      .with {
                        by(TestComponent.intVarData)
                        by(TestComponent.stringVarData).descCaseInsensitive()
                       }.take(0, 10)

Signature

class SortBuilder

Constructors

SortBuilder () : SortBuilder
Signature 
constructor()
Returns

Functions

take ( offset , count ) : SortBuilder
Defines the range of sorting results by specifying the starting index and the number of items to include.
Signature 
fun take(offset: Int, count: Int): SortBuilder
Parameters
offset: Int
The starting index for the results (0-based).
count: Int
The number of items to include in the results.
Returns
The current instance of SortBuilder, allowing for method chaining. Example: 
// Get the first 10 items (items 0-9)
{
  with { by(TestComponent.intVarData) }
  take(0, 10)
}
// Get the next 10 items (items 10-19)
{
  with { by(TestComponent.intVarData) }
  take(10, 10)
}
with ( init ) : SortBuilder
Configures the sorting criteria using a lambda function.
Signature 
fun with(init: SortCriteriaBuilder.() -> Unit): SortBuilder
Parameters
init: Function1
A lambda function with a receiver of type SortCriteriaBuilder that defines the sort criteria. The SortCriteriaBuilder instance is the implicit this within the lambda, allowing you to call its methods directly.
Returns
The current instance of SortBuilder for method chaining. Example -- Sort by the intVar attribute of the TestComponent; if there's a tie, sort by the stringVar attribute, ignoring case; if there's still a tie, sort by the Z component of the vector3Var attribute: 
with {
  by(TestComponent.intVarData)
  by(TestComponent.stringVarData).descCaseInsensitive()
  by(TestComponent.vector3VarData).byZ()
}
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta