Method: Slack::Web::Api::Endpoints::Conversations#conversations_history

Defined in:

lib/slack/web/api/endpoints/conversations.rb

#conversations_history(options = {}) ⇒ Object

Fetches a conversation’s history of messages and events.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (channel) —

  Conversation ID to fetch history for.

• :cursor (Object) —

  Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

• :inclusive (Object) —

  Include messages with latest or oldest timestamp in results only when either timestamp is specified.

• :latest (timestamp) —

  End of time range of messages to include in results.

• :limit (Object) —

  The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn’t been reached.

• :oldest (timestamp) —

  Start of time range of messages to include in results.

See Also:

• https://api.slack.com/methods/conversations.history
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.history.json

# File 'lib/slack/web/api/endpoints/conversations.rb', line 68

def conversations_history(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :conversations_history, options).each do |page|
      yield page
    end
  else
    post('conversations.history', options)
  end
end