Package com.slack.api.methods.request.files

Class FilesListRequest.FilesListRequestBuilder

java.lang.Object

com.slack.api.methods.request.files.FilesListRequest.FilesListRequestBuilder

Enclosing class:

FilesListRequest

public static class FilesListRequest.FilesListRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
FilesListRequest	build()
FilesListRequest.FilesListRequestBuilder	channel(String channel)	Filter files appearing in a specific channel, indicated by its ID.
FilesListRequest.FilesListRequestBuilder	count(Integer count)
FilesListRequest.FilesListRequestBuilder	page(Integer page)
FilesListRequest.FilesListRequestBuilder	showFilesHiddenByLimit(boolean showFilesHiddenByLimit)	https://api.slack.com/changelog/2019-03-wild-west-for-files-no-more
FilesListRequest.FilesListRequestBuilder	teamId(String teamId)	Required for org-wide apps.
FilesListRequest.FilesListRequestBuilder	token(String token)	Authentication token.
String	toString()
FilesListRequest.FilesListRequestBuilder	tsFrom(String tsFrom)	Filter files created after this timestamp (inclusive).
FilesListRequest.FilesListRequestBuilder	tsTo(String tsTo)	Filter files created before this timestamp (inclusive).
FilesListRequest.FilesListRequestBuilder	types(List<String> types)	Filter files by type:\n\n* `all` - All files
FilesListRequest.FilesListRequestBuilder	user(String user)	Filter files created by a single user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

token

public FilesListRequest.FilesListRequestBuilder token(String token)

Authentication token. Requires scope: `files:read`

Returns:

this.

user

public FilesListRequest.FilesListRequestBuilder user(String user)

Filter files created by a single user.

Returns:

this.

channel

public FilesListRequest.FilesListRequestBuilder channel(String channel)

Filter files appearing in a specific channel, indicated by its ID.

Returns:

this.

tsFrom

public FilesListRequest.FilesListRequestBuilder tsFrom(String tsFrom)

Filter files created after this timestamp (inclusive).

Returns:

this.

tsTo

public FilesListRequest.FilesListRequestBuilder tsTo(String tsTo)

Filter files created before this timestamp (inclusive).

Returns:

this.

types

public FilesListRequest.FilesListRequestBuilder types(List<String> types)

Filter files by type:\n\n* `all` - All files

`spaces` - Posts\n* `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.

Returns:

this.

count

public FilesListRequest.FilesListRequestBuilder count(Integer count)

page

public FilesListRequest.FilesListRequestBuilder page(Integer page)

showFilesHiddenByLimit

public FilesListRequest.FilesListRequestBuilder showFilesHiddenByLimit(boolean showFilesHiddenByLimit)

https://api.slack.com/changelog/2019-03-wild-west-for-files-no-more

In order to gather information on tombstoned files in Free workspaces, so that you can delete or revoke them, pass the show_files_hidden_by_limit parameter. While the yielded files will still be redacted, you'll gain the id of the files so that you can delete or revoke them.

Returns:

this.

teamId

public FilesListRequest.FilesListRequestBuilder teamId(String teamId)

Required for org-wide apps.

Returns:

this.

build

public FilesListRequest build()

toString

public String toString()

Overrides:

toString in class Object