lib/slack/web/api/endpoints/files.rb in slack-ruby-client-0.14.1 vs lib/slack/web/api/endpoints/files.rb in slack-ruby-client-0.14.2
- old
+ new
@@ -4,11 +4,11 @@
module Web
module Api
module Endpoints
module Files
#
- # Deletes a file.
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [file] :file
# ID of file to delete.
# @see https://api.slack.com/methods/files.delete
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.delete.json
@@ -33,11 +33,11 @@
logger.warn('The files.edit method is undocumented.')
post('files.edit', options)
end
#
- # Gets information about a team file.
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [file] :file
# Specify a file by providing its ID.
# @option options [Object] :cursor
# Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details.
@@ -55,31 +55,20 @@
post('files.info', options)
end
end
#
- # Lists & filters team files.
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [channel] :channel
# Filter files appearing in a specific channel, indicated by its ID.
# @option options [Object] :ts_from
# Filter files created after this timestamp (inclusive).
# @option options [Object] :ts_to
# Filter files created before this timestamp (inclusive).
# @option options [Object] :types
- # Filter files by type:
- # * `all` - All files
- # * `spaces` - 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=spaces,snippets`.The default value is `all`, which does not filter the list.
- #
- # .
+ # Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
# @option options [user] :user
# Filter files created by a single user.
# @see https://api.slack.com/methods/files.list
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.list.json
def files_list(options = {})
@@ -87,11 +76,11 @@
options = options.merge(user: users_id(options)['user']['id']) if options[:user]
post('files.list', options)
end
#
- # Revokes public/external sharing access for a file
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [file] :file
# File to revoke.
# @see https://api.slack.com/methods/files.revokePublicURL
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.revokePublicURL.json
@@ -115,11 +104,11 @@
logger.warn('The files.share method is undocumented.')
post('files.share', options)
end
#
- # Enables a file for public/external sharing.
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [file] :file
# File to share.
# @see https://api.slack.com/methods/files.sharedPublicURL
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.sharedPublicURL.json
@@ -127,10 +116,10 @@
throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
post('files.sharedPublicURL', options)
end
#
- # Uploads or creates a file.
+ # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
#
# @option options [Object] :channels
# Comma-separated list of channel names or IDs where the file will be shared.
# @option options [Object] :content
# File contents via a POST variable. If omitting this parameter, you must provide a file.