Method: Slack::Endpoint::Search#search_messages

Defined in:

lib/slack/endpoint/search.rb

#search_messages(options = {}) ⇒ Object

Searches for messages matching a query.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :query (Object) —

  Search query. May contains booleans, etc.

• :count (Object) —

  Pass the number of results you want per “page”. Maximum of 100.

• :highlight (Object) —

  Pass a value of true to enable query highlight markers (see below).

• :page (Object) —

  Page number of results to return.

• :sort (Object) —

  Return matches sorted by either score or timestamp.

• :sort_dir (Object) —

  Change sort direction to ascending (asc) or descending (desc).

See Also:

• https://api.slack.com/methods/search.messages
• https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.json

# File 'lib/slack/endpoint/search.rb', line 70

def search_messages(options={})
  throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
  post("search.messages", options)
end