Module: Slack::Web::Files

Included in:
Slack::Web
Defined in:
lib/slack/web/files.rb

Overview

Module for the files methods. Get info on files uploaded to Slack, upload new files to Slack.

Constant Summary collapse

SCOPE =

Endpoint scope

'files'

Instance Method Summary collapse

Instance Method Details

#files_delete(params = {}) ⇒ Object

Deletes a file.

Parameters:

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

    API call arguments

Options Hash (params):

  • 'file' (file) —

    ID of file to delete.

See Also:



20
21
22
23
24
 
# File 'lib/slack/web/files.rb', line 20

def files_delete(params = {})
  fail ArgumentError, "Required arguments 'file' missing" if params['file'].nil?
  response = @session.do_post "#{SCOPE}.delete", params
  Slack.parse_response(response)
end

#files_info(params = {}) ⇒ Object

Gets information about a team file.

Parameters:

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

    API call arguments

Options Hash (params):

  • 'file' (file) —

    File to fetch info for

  • 'count' (Object) —

    Number of items to return per page.

  • 'page' (Object) —

    Page number of results to return.

See Also:



38
39
40
41
42
 
# File 'lib/slack/web/files.rb', line 38

def files_info(params = {})
  fail ArgumentError, "Required arguments 'file' missing" if params['file'].nil?
  response = @session.do_post "#{SCOPE}.info", params
  Slack.parse_response(response)
end

#files_list(params = {}) ⇒ Object

Lists & filters team files.

Parameters:

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

    API call arguments

Options Hash (params):

  • 'user' (user) —

    Filter files created by a single user.

  • 'ts_from' (Object) —

    Filter files created after this timestamp (inclusive).

  • 'ts_to' (Object) —

    Filter files created before this timestamp (inclusive).

  • 'types' (Object) —

    Filter files by type:

    • all - All files
    • posts - Posts
    • snippets - Snippets
    • images - Image files
    • gdocs - Google docs
    • zips - Zip files
    • pdfs - PDF files

    You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.

  • 'count' (Object) —

    Number of items to return per page.

  • 'page' (Object) —

    Page number of results to return.

See Also:



72
73
74
75
 
# File 'lib/slack/web/files.rb', line 72

def files_list(params = {})
  response = @session.do_post "#{SCOPE}.list", params
  Slack.parse_response(response)
end

#files_upload(params = {}) ⇒ Object

Uploads or creates a file.

Parameters:

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

    API call arguments

Options Hash (params):

  • 'file' (Object) —

    File contents via multipart/form-data.

  • 'content' (Object) —

    File contents via a POST var.

  • 'filetype' (Object) —

    Slack-internal file type identifier.

  • 'filename' (Object) —

    Filename of file.

  • 'title' (Object) —

    Title of file.

  • 'initial_comment' (Object) —

    Initial comment to add to file.

  • 'channels' (channel) —

    Comma separated list of channels to share the file into.

See Also:



96
97
98
99
 
# File 'lib/slack/web/files.rb', line 96

def files_upload(params = {})
  response = @session.do_post "#{SCOPE}.upload", params
  Slack.parse_response(response)
end