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

Class UpdateOwnUserStatusApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class UpdateOwnUserStatusApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for updating own user status.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AWAY
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
UpdateOwnUserStatusApiRequest(ZulipHttpClient client)	Constructs a UpdateOwnUserStatusApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for updating a user status.
UpdateOwnUserStatusApiRequest	withAway(boolean away)	Deprecated, for removal: This API element is subject to removal in a future version. away is a legacy way to access the user's presence_enabled setting, with away = !
UpdateOwnUserStatusApiRequest	withEmojiCode(String emojiCode)	Sets whether the user should be marked as "away".
UpdateOwnUserStatusApiRequest	withEmojiName(String emojiName)	Sets whether the user should be marked as "away".
UpdateOwnUserStatusApiRequest	withReactionType(ReactionType type)	Sets reaction type for the emoji.
UpdateOwnUserStatusApiRequest	withStatusText(String statusText)	The text content of the status message.

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

Field Details

AWAY

public static final String AWAY

See Also:

• Constant Field Values

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

STATUS_TEXT

public static final String STATUS_TEXT

See Also:

• Constant Field Values

Constructor Details

UpdateOwnUserStatusApiRequest

public UpdateOwnUserStatusApiRequest(ZulipHttpClient client)

Constructs a UpdateOwnUserStatusApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withAway

@Deprecated(forRemoval=true)
public UpdateOwnUserStatusApiRequest withAway(boolean away)

Deprecated, for removal: This API element is subject to removal in a future version.

away is a legacy way to access the user's presence_enabled setting, with away = !presence_enabled

Sets whether the user should be marked as "away".

Parameters:

away - true to set the user status as 'away'. false to not set the user status as 'away'

Returns:

This UpdateOwnUserStatusApiRequest instance

withEmojiCode

public UpdateOwnUserStatusApiRequest withEmojiCode(String emojiCode)

Sets whether the user should be marked as "away".

Parameters:

emojiCode - A unique identifier, defining the specific emoji codepoint requested, within the namespace of the reaction_type

Returns:

This UpdateOwnUserStatusApiRequest instance

withEmojiName

public UpdateOwnUserStatusApiRequest withEmojiName(String emojiName)

Sets whether the user should be marked as "away".

Parameters:

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

Returns:

This UpdateOwnUserStatusApiRequest instance

withReactionType

public UpdateOwnUserStatusApiRequest withReactionType(ReactionType type)

Sets reaction type for the emoji.

Parameters:

type - The emoji reaction type

Returns:

This UpdateOwnUserStatusApiRequest instance

See Also:

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

withStatusText

public UpdateOwnUserStatusApiRequest withStatusText(String statusText)

The text content of the status message.

Parameters:

statusText - The text content of the status message. Sending the empty string will clear the user's status

Returns:

This UpdateOwnUserStatusApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for updating a user status.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful