ExScimClient.Pagination (ex_scim_client v0.2.2)

Copy Markdown View Source

Pagination configuration for list requests.

Examples

iex> pagination = ExScimClient.Pagination.new(50, 101)
iex> pagination.count
50
iex> pagination.start_index
101

Summary

Types

t()

Functions

new(count, start_index \\ 1)

Creates a new pagination struct.

Types

t()

@type t() :: %ExScimClient.Pagination{
  count: pos_integer(),
  start_index: pos_integer()
}

Functions

new(count, start_index \\ 1)

@spec new(pos_integer(), pos_integer()) :: %ExScimClient.Pagination{
  count: term(),
  start_index: term()
}

Creates a new pagination struct.

Parameters

  • count - Maximum number of results to return
  • start_index - 1-based index of the first result (defaults to 1)

Examples

iex> pagination = ExScimClient.Pagination.new(25)
iex> %ExScimClient.Pagination{count: 25, start_index: 1} = pagination

iex> pagination = ExScimClient.Pagination.new(10, 51)
iex> %ExScimClient.Pagination{count: 10, start_index: 51} = pagination