Package com.github.jamesnetherton.zulip.client.api.message.request

Class FileUploadApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.message.request.FileUploadApiRequest

All Implemented Interfaces:

ExecutableApiRequest<String>

public class FileUploadApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for uploading a file to the Zulip server.

See Also:

• https://zulip.com/api/upload-file

Constructor Summary

Constructors

Constructor	Description
FileUploadApiRequest(ZulipHttpClient client, File file)	Constructs a FileUploadApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for uploading a file.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Constructor Details

FileUploadApiRequest

public FileUploadApiRequest(ZulipHttpClient client,
 File file)

Constructs a FileUploadApiRequest.

Parameters:

client - The Zulip HTTP client

file - The file to upload

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for uploading a file.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

The response for type T

Throws:

ZulipClientException - if the request was not successful