Scope

class Scope<R : Resource>(resourceClass: KClass<R>, options: Scope<R>.() -> Unit = {})(source)

A scope for querying the server.

Parameters

resourceClass

The resource to use the scope on.

options

The options for the scope.

Constructors

Scope

constructor(resourceClass: KClass<R>, options: Scope<R>.() -> Unit = {})

Types

ScopeMethod

annotation class ScopeMethod

Properties

fields

val fields: MutableMap<String, List<String>>

The fields to select.

filter

val filter: MutableMap<String, String>

The filter options.

includes

val includes: MutableList<String>

The relationships to include.

pagination

val pagination: ScopePagination

The pagination options.

params

val params: MutableMap<String, String>

The extra parameters.

sort

val sort: MutableMap<String, SortDirection>

The sort options.

Functions

all

suspend fun all(): CollectionProxy<R>

Get all the resources.

extraParam

fun extraParam(key: String, value: String): Scope<R>

Add an extra parameter to the request

find

suspend fun find(id: String): RecordProxy<R>

Find a resource by its ID

first

suspend fun first(): RecordProxy<R>

Get the first resource

includes

fun includes(vararg relationships: String): Scope<R>

Include the relationships in the response

limit

fun limit(limit: Number): Scope<R>

Set the number of items to return (Only for offset-based pagination)

offset

fun offset(offset: Number): Scope<R>

Set the number of items to skip (Only for offset-based pagination)

order

fun order(attribute: String, sortDirection: SortDirection = SortDirection.ASC): Scope<R>

Order the resources by an attribute

page

fun page(pageNumber: Number): Scope<R>

Set the page number to return (Only for page-based pagination)

per

fun per(pageSize: Number): Scope<R>

Set the number of items per page (Only for page-based pagination)

select

fun select(type: String, vararg fields: String): Scope<R>

Select the fields to return

where

fun where(attribute: String, value: Any): Scope<R>

Filter the resources by an attribute