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

Class GetUserStatusApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<UserStatus>

public class GetUserStatusApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<UserStatus>

Zulip API request builder for getting a user status.

See Also:

• https://zulip.com/api/get-user-status

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UserStatus	execute()	Executes the Zulip API request for getting a user status.

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

client, getParam, getParams, putParam, putParamAsJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetUserStatusApiRequest

public GetUserStatusApiRequest(ZulipHttpClient client,
 long userId)

Constructs a GetUserStatusApiRequest.

Parameters:

client - The Zulip HTTP client

userId - The ID of the user to fetch the status for

Method Details

execute

public UserStatus execute()
                   throws ZulipClientException

Executes the Zulip API request for getting a user status.

Specified by:

execute in interface ExecutableApiRequest<UserStatus>

Returns:

UserStatus representing the status of the user

Throws:

ZulipClientException - if the request was not successful