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

Class GetFileTemporaryUrlApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<String>

public class GetFileTemporaryUrlApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<String>

Zulip API request builder for getting a temporary URL for access to an uploaded file without authentication.

See Also:

• https://zulip.com/api/get-file-temporary-url

Constructor Summary

Constructors

Constructor	Description
GetFileTemporaryUrlApiRequest(ZulipHttpClient client, String realmIdStr, String filename)	Constructs a GetFileTemporaryUrlApiRequest.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the Zulip API request for getting a temporary URL for an uploaded 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

GetFileTemporaryUrlApiRequest

public GetFileTemporaryUrlApiRequest(ZulipHttpClient client,
 String realmIdStr,
 String filename)

Constructs a GetFileTemporaryUrlApiRequest.

Parameters:

client - The Zulip HTTP client

realmIdStr - The realm ID component of the file's path_id

filename - The file path component of the file's path_id (everything after the first /)

Method Details

execute

public String execute()
               throws ZulipClientException

Executes the Zulip API request for getting a temporary URL for an uploaded file.

Specified by:

execute in interface ExecutableApiRequest<String>

Returns:

A temporary URL that provides unauthenticated access to the file

Throws:

ZulipClientException - if the request was not successful