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

Class UpdateUserStatusApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.UpdateUserStatusApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateUserStatusApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating user status.

See Also:

• https://zulip.com/api/update-status-for-user

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
UpdateUserStatusApiRequest(ZulipHttpClient client, long userId)	Constructs a UpdateUserStatusApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Invokes the HTTP client to send the request to the Zulip REST API.
UpdateUserStatusApiRequest	withEmojiCode(String emojiCode)	Sets the unique identifier defining the emoji.
UpdateUserStatusApiRequest	withEmojiName(String emojiName)	Sets the name for the emoji to associate with this status.
UpdateUserStatusApiRequest	withReactionType(ReactionType reactionType)	Sets the reaction type.
UpdateUserStatusApiRequest	withStatusText(String statusText)	Sets the content of the status message.

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

STATUS_TEXT

public static final String STATUS_TEXT

See Also:

• Constant Field Values

EMOJI_NAME

public static final String EMOJI_NAME

See Also:

• Constant Field Values

EMOJI_CODE

public static final String EMOJI_CODE

See Also:

• Constant Field Values

REACTION_TYPE

public static final String REACTION_TYPE

See Also:

• Constant Field Values

Constructor Details

UpdateUserStatusApiRequest

public UpdateUserStatusApiRequest(ZulipHttpClient client,
 long userId)

Constructs a UpdateUserStatusApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withStatusText

public UpdateUserStatusApiRequest withStatusText(String statusText)

Sets the content of the status message.

Parameters:

statusText - The content of the status message

Returns:

This UpdateUserStatusApiRequest instance

See Also:

• https://zulip.com/api/update-status-for-user#parameter-status_text

withEmojiName

public UpdateUserStatusApiRequest withEmojiName(String emojiName)

Sets the name for the emoji to associate with this status.

Parameters:

emojiName - The name for the emoji to associate with this status

Returns:

This UpdateUserStatusApiRequest instance

See Also:

• https://zulip.com/api/update-status-for-user#parameter-status_text

withEmojiCode

public UpdateUserStatusApiRequest withEmojiCode(String emojiCode)

Sets the unique identifier defining the emoji.

Parameters:

emojiCode - The unique identifier defining the specific emoji

Returns:

This UpdateUserStatusApiRequest instance

See Also:

• https://zulip.com/api/update-status-for-user#parameter-emoji_code

withReactionType

public UpdateUserStatusApiRequest withReactionType(ReactionType reactionType)

Sets the reaction type.

Parameters:

reactionType - The reaction type

Returns:

This UpdateUserStatusApiRequest instance

See Also:

• https://zulip.com/api/update-status-for-user#parameter-reaction_type

execute

public void execute()
             throws ZulipClientException

Description copied from interface: VoidExecutableApiRequest

Invokes the HTTP client to send the request to the Zulip REST API.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException