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

Class UploadEmojiApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.UploadEmojiApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class UploadEmojiApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for uploading custom emoji images.

See Also:

• https://zulip.com/help/add-custom-emoji

Constructor Summary

Constructors

Constructor	Description
UploadEmojiApiRequest(ZulipHttpClient client, String name, File emojiFile)	Constructs a UploadEmojiApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for uploading custom emoji images.

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

client, 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

UploadEmojiApiRequest

public UploadEmojiApiRequest(ZulipHttpClient client,
 String name,
 File emojiFile)

Constructs a UploadEmojiApiRequest.

Parameters:

client - The Zulip HTTP client

name - The name of the emoji

emojiFile - The file containing the emoji image to be uploaded

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for uploading custom emoji images.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful