slackline - v1.0.0

slackline/api/admin/conversations/search

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

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

conversations.search()
|> search.team_ids(team_ids)

Values

connected_team_ids

</> 
pub fn connected_team_ids(
  call: slackline.Call(conversations.Search, r),
  connected_team_ids: List(String),
) -> slackline.Call(conversations.Search, r)

Array of encoded team IDs, signifying the external orgs to search through.

cursor

</> 
pub fn cursor(
  call: slackline.Call(conversations.Search, r),
  cursor: String,
) -> slackline.Call(conversations.Search, r)

Set cursor to next_cursor returned by the previous call to list items in the next page.

limit

</> 
pub fn limit(
  call: slackline.Call(conversations.Search, r),
  limit: Int,
) -> slackline.Call(conversations.Search, r)

Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. Defaults to 10.

query

</> 
pub fn query(
  call: slackline.Call(conversations.Search, r),
  query: String,
) -> slackline.Call(conversations.Search, r)

Name of the channel to query by.

search_channel_types

</> 
pub fn search_channel_types(
  call: slackline.Call(conversations.Search, r),
  search_channel_types: List(String),
) -> slackline.Call(conversations.Search, r)

The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.

sort

</> 
pub fn sort(
  call: slackline.Call(conversations.Search, r),
  sort: conversations.ConversationSearchSort,
) -> slackline.Call(conversations.Search, r)

Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted Defaults to member_count.

sort_dir

</> 
pub fn sort_dir(
  call: slackline.Call(conversations.Search, r),
  sort_dir: common.SortDirection,
) -> slackline.Call(conversations.Search, r)

Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a) Defaults to desc.

team_ids

</> 
pub fn team_ids(
  call: slackline.Call(conversations.Search, r),
  team_ids: List(String),
) -> slackline.Call(conversations.Search, r)

Comma separated string of team IDs, signifying the internal workspaces to search through.

total_count_only

</> 
pub fn total_count_only(
  call: slackline.Call(conversations.Search, r),
  total_count_only: Bool,
) -> slackline.Call(conversations.Search, r)

Only return the total_count of channels. Omits channel data and allows access for admins without channel manager permissions.

✨ Search Document