Slack

v0.12.0

Slack v0.12.0 Slack.Web.Search

Summary

Functions

all(query, optional_params \\ %{})

Searches for messages and files matching a query

files(query, optional_params \\ %{})

Searches for files matching a query

messages(query, optional_params \\ %{})

Searches for messages matching a query

Functions

all(query, optional_params \\ %{})

Searches for messages and files matching a query.

Required Params

  • query - Search query. May contains booleans, etc. ex: pickleface

Optional Params

  • highlight - Pass a value of 1 to enable query highlight markers (see below). ex: 1
  • sort - Return matches sorted by either score or timestamp. ex: timestamp
  • sort_dir - Change sort direction to ascending (asc) or descending (desc). ex: asc

Errors the API can return:

files(query, optional_params \\ %{})

Searches for files matching a query.

Required Params

  • query - Search query. May contain booleans, etc. ex: pickleface

Optional Params

  • highlight - Pass a value of 1 to enable query highlight markers (see below). ex: 1
  • sort - Return matches sorted by either score or timestamp. ex: timestamp
  • sort_dir - Change sort direction to ascending (asc) or descending (desc). ex: asc

Errors the API can return:

messages(query, optional_params \\ %{})

Searches for messages matching a query.

Required Params

  • query - Search query. May contains booleans, etc. ex: pickleface

Optional Params

  • highlight - Pass a value of 1 to enable query highlight markers (see below). ex: 1
  • sort - Return matches sorted by either score or timestamp. ex: timestamp
  • sort_dir - Change sort direction to ascending (asc) or descending (desc). ex: asc

Errors the API can return: