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

Class AddEmojiReactionApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class AddEmojiReactionApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for adding emoji reactions to a message.

See Also:

• https://zulip.com/api/add-reaction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMOJI_CODE
static final String	EMOJI_NAME
static final String	REACTION_TYPE

Constructor Summary

Constructors

Constructor	Description
AddEmojiReactionApiRequest(ZulipHttpClient client, long messageId, String emojiName)	Constructs a AddEmojiReactionApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for adding a emoji reaction to a message.
AddEmojiReactionApiRequest	withEmojiCode(String code)	Sets an optional unique identifier defining the specific emoji codepoint requested.
AddEmojiReactionApiRequest	withReactionType(ReactionType type)	Sets an optional reaction type.

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

Field Details

EMOJI_CODE

public static final String EMOJI_CODE

See Also:

• Constant Field Values

EMOJI_NAME

public static final String EMOJI_NAME

See Also:

• Constant Field Values

REACTION_TYPE

public static final String REACTION_TYPE

See Also:

• Constant Field Values

Constructor Details

AddEmojiReactionApiRequest

public AddEmojiReactionApiRequest(ZulipHttpClient client,
 long messageId,
 String emojiName)

Constructs a AddEmojiReactionApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to add the emoji reaction to

emojiName - The name of the emoji to use

Method Details

withEmojiCode

public AddEmojiReactionApiRequest withEmojiCode(String code)

Sets an optional unique identifier defining the specific emoji codepoint requested. This is usually not required to be specified.

Parameters:

code - The emoji unique identifier

Returns:

This AddEmojiReactionApiRequest instance

See Also:

• https://zulip.com/api/add-reaction#parameter-emoji_code

withReactionType

public AddEmojiReactionApiRequest withReactionType(ReactionType type)

Sets an optional reaction type.

Parameters:

type - The emoji reaction type

Returns:

This AddEmojiReactionApiRequest instance

See Also:

• https://zulip.com/api/add-reaction#parameter-reaction_type

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for adding a emoji reaction to a message.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful