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

Class FilesUploadV2Request.FilesUploadV2RequestBuilder

java.lang.Object

com.slack.api.methods.request.files.FilesUploadV2Request.FilesUploadV2RequestBuilder

Enclosing class:

FilesUploadV2Request

public static class FilesUploadV2Request.FilesUploadV2RequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
FilesUploadV2Request.FilesUploadV2RequestBuilder	altTxt(String altTxt)	Description of image for screen-reader.
FilesUploadV2Request	build()
FilesUploadV2Request.FilesUploadV2RequestBuilder	channel(String channel)	Channel ID where the file will be shared.
FilesUploadV2Request.FilesUploadV2RequestBuilder	channels(List<String> channels)	Comma-separated string of channel IDs where the file will be shared.
FilesUploadV2Request.FilesUploadV2RequestBuilder	content(String content)	File contents via a POST variable.
FilesUploadV2Request.FilesUploadV2RequestBuilder	file(File file)	File contents via `multipart/form-data`.
FilesUploadV2Request.FilesUploadV2RequestBuilder	fileData(byte[] fileData)	File contents via `multipart/form-data`.
FilesUploadV2Request.FilesUploadV2RequestBuilder	filename(String filename)	Name of the file being uploaded.
FilesUploadV2Request.FilesUploadV2RequestBuilder	initialComment(String initialComment)	The message text introducing the file in specified channel.
FilesUploadV2Request.FilesUploadV2RequestBuilder	requestFileInfo(boolean requestFileInfo)	Deprecated.
FilesUploadV2Request.FilesUploadV2RequestBuilder	snippetType(String snippetType)	Syntax type of the snippet being uploaded.
FilesUploadV2Request.FilesUploadV2RequestBuilder	threadTs(String threadTs)	Provide another message's ts value to upload this file as a reply.
FilesUploadV2Request.FilesUploadV2RequestBuilder	title(String title)	Title of the file, which is visible in the Slack UI.
FilesUploadV2Request.FilesUploadV2RequestBuilder	token(String token)	Authentication token.
String	toString()
FilesUploadV2Request.FilesUploadV2RequestBuilder	uploadFiles(List<FilesUploadV2Request.UploadFile> uploadFiles)	Multiple files to upload

Methods inherited from class java.lang.Object

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

Method Details

token

public FilesUploadV2Request.FilesUploadV2RequestBuilder token(String token)

Authentication token. Requires scope: `files:write`

Returns:

this.

file

public FilesUploadV2Request.FilesUploadV2RequestBuilder file(File file)

File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

fileData

public FilesUploadV2Request.FilesUploadV2RequestBuilder fileData(byte[] fileData)

File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

content

public FilesUploadV2Request.FilesUploadV2RequestBuilder content(String content)

File contents via a POST variable. If omitting this parameter, you must provide a `file`. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

filename

public FilesUploadV2Request.FilesUploadV2RequestBuilder filename(String filename)

Name of the file being uploaded. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

title

public FilesUploadV2Request.FilesUploadV2RequestBuilder title(String title)

Title of the file, which is visible in the Slack UI. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

altTxt

public FilesUploadV2Request.FilesUploadV2RequestBuilder altTxt(String altTxt)

Description of image for screen-reader. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

snippetType

public FilesUploadV2Request.FilesUploadV2RequestBuilder snippetType(String snippetType)

Syntax type of the snippet being uploaded. (this is mainly for backward compatibility - using uploadFiles instead is recommended)

Returns:

this.

requestFileInfo

@Deprecated
public FilesUploadV2Request.FilesUploadV2RequestBuilder requestFileInfo(boolean requestFileInfo)

Deprecated.

Fetches all the file metadata for better v1 compatibility when this property is true. Note that, starting in v1.34, this flag does not do anything. The full file metadata is now returned without additional files.info API calls.

Returns:

this.

uploadFiles

public FilesUploadV2Request.FilesUploadV2RequestBuilder uploadFiles(List<FilesUploadV2Request.UploadFile> uploadFiles)

Multiple files to upload

Returns:

this.

initialComment

public FilesUploadV2Request.FilesUploadV2RequestBuilder initialComment(String initialComment)

The message text introducing the file in specified channel.

Returns:

this.

channel

public FilesUploadV2Request.FilesUploadV2RequestBuilder channel(String channel)

Channel ID where the file will be shared. If not specified the file will be private.

Returns:

this.

channels

public FilesUploadV2Request.FilesUploadV2RequestBuilder channels(List<String> channels)

Comma-separated string of channel IDs where the file will be shared.

Returns:

this.

threadTs

public FilesUploadV2Request.FilesUploadV2RequestBuilder threadTs(String threadTs)

Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.

Returns:

this.

build

public FilesUploadV2Request build()

toString

public String toString()

Overrides:

toString in class Object