slackline/api/users/list

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of users.list. Each setter takes the call that users.list returns and sets one argument:

import slackline/api/users/list as users_list

users.list()
|> users_list.cursor("dXNlcjpVMDYxTkZUVDI=")

Values

pub fn cursor(
  call: slackline.Call(users.ListMethod, r),
  cursor: String,
) -> slackline.Call(users.ListMethod, r)

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

pub fn include_locale(
  call: slackline.Call(users.ListMethod, r),
  include_locale: Bool,
) -> slackline.Call(users.ListMethod, r)

Set this to true to receive the locale for users. Defaults to false

pub fn limit(
  call: slackline.Call(users.ListMethod, r),
  limit: Int,
) -> slackline.Call(users.ListMethod, r)

The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn’t been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.

pub fn team_id(
  call: slackline.Call(users.ListMethod, r),
  team_id: String,
) -> slackline.Call(users.ListMethod, r)

encoded team id to list users in, required if org token is used

✨ Search Document