module Slack::Web::Search
Module for the search methods. Search
your team's files and messages.
Constants
- SCOPE
Endpoint scope
Public Instance Methods
Searches for messages and files matching a query.
@param [Hash] params
API call arguments
@option params [Object] 'query'
Search query. May contains booleans, etc.
@option params [Object] 'sort'
Return matches sorted by either `score` or `timestamp`.
@option params [Object] 'sort_dir'
Change sort direction to ascending (`asc`) or descending (`desc`).
@option params [Object] 'highlight'
Pass a value of `1` to enable query highlight markers.
@option params [Object] 'count'
Number of items to return per page.
@option params [Object] 'page'
Page number of results to return.
@see api.slack.com/methods/search.all
# File lib/slack/web/search.rb, line 30 def search_all(params = {}) fail ArgumentError, "Required arguments 'query' missing" if params['query'].nil? response = @session.do_post "#{SCOPE}.all", params Slack.parse_response(response) end
Searches for files matching a query.
@param [Hash] params
API call arguments
@option params [Object] 'query'
Search query. May contains booleans, etc.
@option params [Object] 'sort'
Return matches sorted by either `score` or `timestamp`.
@option params [Object] 'sort_dir'
Change sort direction to ascending (`asc`) or descending (`desc`).
@option params [Object] 'highlight'
Pass a value of `1` to enable query highlight markers.
@option params [Object] 'count'
Number of items to return per page.
@option params [Object] 'page'
Page number of results to return.
@see api.slack.com/methods/search.files
# File lib/slack/web/search.rb, line 54 def search_files(params = {}) fail ArgumentError, "Required arguments 'query' missing" if params['query'].nil? response = @session.do_post "#{SCOPE}.files", params Slack.parse_response(response) end
Searches for messages matching a query.
@param [Hash] params
API call arguments
@option params [Object] 'query'
Search query. May contains booleans, etc.
@option params [Object] 'sort'
Return matches sorted by either `score` or `timestamp`.
@option params [Object] 'sort_dir'
Change sort direction to ascending (`asc`) or descending (`desc`).
@option params [Object] 'highlight'
Pass a value of `1` to enable query highlight markers.
@option params [Object] 'count'
Number of items to return per page.
@option params [Object] 'page'
Page number of results to return.
@see api.slack.com/methods/search.messages
# File lib/slack/web/search.rb, line 78 def search_messages(params = {}) fail ArgumentError, "Required arguments 'query' missing" if params['query'].nil? response = @session.do_post "#{SCOPE}.messages", params Slack.parse_response(response) end