Module: Slack::Web::Api::Endpoints::SlackListsDownload

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

Instance Method Summary collapse

Instance Method Details

#slackLists_download_get(options = {}) ⇒ Object

Retrieve List download URL from an export job to download List contents.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :list_id (string) —

    ID of the List to export.

  • :job_id (string) —

    The ID of the recently started job to export the List.

Raises:

  • (ArgumentError)

See Also:



18
19
20
21
22
 
# File 'lib/slack/web/api/endpoints/slackLists_download.rb', line 18

def slackLists_download_get(options = {})
  raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
  raise ArgumentError, 'Required arguments :job_id missing' if options[:job_id].nil?
  post('slackLists.download.get', options)
end

#slackLists_download_start(options = {}) ⇒ Object

Initiate a job to export List contents.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :list_id (string) —

    ID of the List to export.

  • :include_archived (boolean)

Raises:

  • (ArgumentError)

See Also:



32
33
34
35
 
# File 'lib/slack/web/api/endpoints/slackLists_download.rb', line 32

def slackLists_download_start(options = {})
  raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
  post('slackLists.download.start', options)
end