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

Class UpdateOwnUserPresenceApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Map<Long,UserPresenceDetail>>

public class UpdateOwnUserPresenceApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Map<Long,UserPresenceDetail>>

Zulip API request builder for updating own user presence.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HISTORY_LIMIT_DAYS
static final String	LAST_UPDATE_ID
static final String	NEW_USER_INPUT
static final String	PING_ONLY
static final String	STATUS

Constructor Summary

Constructors

Constructor	Description
UpdateOwnUserPresenceApiRequest(ZulipHttpClient client, UserPresenceStatus status)	Constructs a UpdateOwnUserPresenceApiRequest.

Method Summary

Modifier and Type	Method	Description
Map<Long,UserPresenceDetail>	execute()	Executes the Zulip API request for updating own user presence.
UpdateOwnUserPresenceApiRequest	withHistoryLimitDays(int historyLimitDays)	Sets how far back in time to fetch user presence data.
UpdateOwnUserPresenceApiRequest	withLastUpdateId(int lastUpdateId)	Sets the identifier that specifies what presence data the client already has received.
UpdateOwnUserPresenceApiRequest	withNewUserInput(boolean newUserInput)	Sets whether new user interaction has occurred.
UpdateOwnUserPresenceApiRequest	withPingOnly(boolean pingOnly)	Sets whether the client is sending a ping-only request.

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

HISTORY_LIMIT_DAYS

public static final String HISTORY_LIMIT_DAYS

See Also:

• Constant Field Values

LAST_UPDATE_ID

public static final String LAST_UPDATE_ID

See Also:

• Constant Field Values

NEW_USER_INPUT

public static final String NEW_USER_INPUT

See Also:

• Constant Field Values

PING_ONLY

public static final String PING_ONLY

See Also:

• Constant Field Values

STATUS

public static final String STATUS

See Also:

• Constant Field Values

Constructor Details

UpdateOwnUserPresenceApiRequest

public UpdateOwnUserPresenceApiRequest(ZulipHttpClient client,
 UserPresenceStatus status)

Constructs a UpdateOwnUserPresenceApiRequest.

Parameters:

client - The Zulip HTTP client

status - The status of the user

Method Details

withHistoryLimitDays

public UpdateOwnUserPresenceApiRequest withHistoryLimitDays(int historyLimitDays)

Sets how far back in time to fetch user presence data.

Parameters:

historyLimitDays - how far back in time to fetch user presence data

Returns:

This UpdateOwnUserPresenceApiRequest instance

See Also:

• https://zulip.com/api/update-presence#parameter-history_limit_days

withLastUpdateId

public UpdateOwnUserPresenceApiRequest withLastUpdateId(int lastUpdateId)

Sets the identifier that specifies what presence data the client already has received.

Parameters:

lastUpdateId - The identifier that specifies what presence data the client already has received

Returns:

This UpdateOwnUserPresenceApiRequest instance

See Also:

• https://zulip.com/api/update-presence#parameter-last_update_id

withNewUserInput

public UpdateOwnUserPresenceApiRequest withNewUserInput(boolean newUserInput)

Sets whether new user interaction has occurred.

Parameters:

newUserInput - whether new user interaction has occurred

Returns:

This UpdateOwnUserPresenceApiRequest instance

See Also:

• https://zulip.com/api/update-presence#parameter-new_user_input

withPingOnly

public UpdateOwnUserPresenceApiRequest withPingOnly(boolean pingOnly)

Sets whether the client is sending a ping-only request.

Parameters:

pingOnly - whether this is ping-only request

Returns:

This UpdateOwnUserPresenceApiRequest instance

See Also:

• https://zulip.com/api/update-presence#parameter-ping_only

execute

public Map<Long,UserPresenceDetail> execute()
                                     throws ZulipClientException

Executes the Zulip API request for updating own user presence.

Specified by:

execute in interface ExecutableApiRequest<Map<Long,UserPresenceDetail>>

Returns:

Map of UserPresenceDetail keyed by user id

Throws:

ZulipClientException - if the request was not successful