slackline/api/conversations/list

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

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

import slackline/api/conversations/list as conversations_list

conversations.list()
|> conversations_list.cursor("dXNlcjpVMDYxTkZUVDI=")

Values

pub fn cursor(
  call: slackline.Call(conversations.ListMethod, r),
  cursor: String,
) -> slackline.Call(conversations.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 exclude_archived(
  call: slackline.Call(conversations.ListMethod, r),
  exclude_archived: Bool,
) -> slackline.Call(conversations.ListMethod, r)

Set to true to exclude archived channels from the list. Defaults to false.

pub fn limit(
  call: slackline.Call(conversations.ListMethod, r),
  limit: Int,
) -> slackline.Call(conversations.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 list hasn’t been reached. Must be an integer under 1000. Defaults to 100.

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

encoded team id to list channels in, required if token belongs to org-wide app

pub fn types(
  call: slackline.Call(conversations.ListMethod, r),
  types: List(String),
) -> slackline.Call(conversations.ListMethod, r)

Conversation types to include: any combination of public_channel, private_channel, mpim and im.

✨ Search Document