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

Class CheckThumbnailStatusApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Boolean>

public class CheckThumbnailStatusApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Boolean>

Zulip API request builder for checking whether a thumbnail exists for a user-uploaded file.

See Also:

• https://zulip.com/api/check-thumbnail-status

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Boolean	execute()	Executes the Zulip API request for checking whether a thumbnail exists for a user-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

CheckThumbnailStatusApiRequest

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

Constructs a CheckThumbnailStatusApiRequest.

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 Boolean execute()
                throws ZulipClientException

Executes the Zulip API request for checking whether a thumbnail exists for a user-uploaded file.

Specified by:

execute in interface ExecutableApiRequest<Boolean>

Returns:

true if a thumbnail exists for the file, false otherwise

Throws:

ZulipClientException - if the request was not successful