ExScimClient.Sorting (ex_scim_client v0.2.1)

Sorting configuration for list requests.

Examples

iex> sorting = ExScimClient.Sorting.new("meta.created")
iex> sorting.by
"meta.created"
iex> sorting.order
:asc

iex> sorting = ExScimClient.Sorting.new("displayName", :desc)
iex> sorting.order
:desc

Summary

Types

t()

Functions

new(by, order \\ :asc)

Creates a new sorting struct.

Types

t()

@type t() :: %ExScimClient.Sorting{by: String.t(), order: :asc | :desc}

Functions

new(by, order \\ :asc)

@spec new(String.t(), :asc | :desc) :: %ExScimClient.Sorting{
  by: term(),
  order: term()
}

Creates a new sorting struct.

Parameters

by - Attribute name to sort by
order - Sort order, either :asc (default) or :desc

Examples

iex> sorting = ExScimClient.Sorting.new("userName")
iex> %ExScimClient.Sorting{by: "userName", order: :asc} = sorting

iex> sorting = ExScimClient.Sorting.new("meta.lastModified", :desc)
iex> %ExScimClient.Sorting{by: "meta.lastModified", order: :desc} = sorting