Module: Slack::Web::Api::Endpoints::ChatScheduledmessages

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/chat_scheduledMessages.rb

Instance Method Summary collapse

Instance Method Details

#chat_scheduledMessages_list(options = {}) ⇒ Object

Returns a list of scheduled messages.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    The channel of the scheduled messages.

  • :cursor (string) —

    For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.

  • :latest (timestamp) —

    A UNIX timestamp of the latest value in the time range.

  • :limit (integer) —

    Maximum number of original entries to return.

  • :oldest (timestamp) —

    A UNIX timestamp of the oldest value in the time range.

  • :team_id (string) —

    encoded team id to list channels in, required if org token is used.

See Also:



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/slack/web/api/endpoints/chat_scheduledMessages.rb', line 26

def chat_scheduledMessages_list(options = {})
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :chat_scheduledMessages_list, options).each do |page|
      yield page
    end
  else
    post('chat.scheduledMessages.list', options)
  end
end