Module: Slack::Endpoint::Search

Included in:

Slack::Endpoint

Defined in:

lib/slack/endpoint/search.rb

Instance Method Summary

• #search_all(options = {}) ⇒ Object

  This method allows users and applications to search both messages and files in a single call.

• #search_files(options = {}) ⇒ Object

  This method returns files matching a search query.

• #search_messages(options = {}) ⇒ Object

  This method returns messages matching a search query.

Instance Method Details

#search_all(options = {}) ⇒ Object

This method allows users and applications to search both messages and files in a single call.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :query (Object) —

  Search query. May contains booleans, etc.

• :sort (Object) —

  Return matches sorted by either score or timestamp.

• :sort_dir (Object) —

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

• :highlight (Object) —

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

• :count (Object) —

  Number of items to return per page.

• :page (Object) —

  Page number of results to return.

See Also:

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

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

def search_all(options={})
  throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("search.all", options)
end

#search_files(options = {}) ⇒ Object

This method returns files matching a search query.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :query (Object) —

  Search query. May contain booleans, etc.

• :sort (Object) —

  Return matches sorted by either score or timestamp.

• :sort_dir (Object) —

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

• :highlight (Object) —

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

• :count (Object) —

  Number of items to return per page.

• :page (Object) —

  Page number of results to return.

See Also:

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

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

def search_files(options={})
  throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("search.files", options)
end

#search_messages(options = {}) ⇒ Object

This method returns messages matching a search query.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :query (Object) —

  Search query. May contains booleans, etc.

• :sort (Object) —

  Return matches sorted by either score or timestamp.

• :sort_dir (Object) —

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

• :highlight (Object) —

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

• :count (Object) —

  Number of items to return per page.

• :page (Object) —

  Page number of results to return.

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 72

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