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

Class GetUserPresenceApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Map<String,UserPresenceDetail>>

public class GetUserPresenceApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Map<String,UserPresenceDetail>>

Zulip API request builder for getting user presence information.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetUserPresenceApiRequest(ZulipHttpClient client, String email)	Constructs a GetUserPresenceApiRequest.

Method Summary

Modifier and Type	Method	Description
Map<String,UserPresenceDetail>	execute()	Executes the Zulip API request for getting user presence information.

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

Constructor Details

GetUserPresenceApiRequest

public GetUserPresenceApiRequest(ZulipHttpClient client,
 String email)

Constructs a GetUserPresenceApiRequest.

Parameters:

client - The Zulip HTTP client

email - The email address of the user to get presence details for

Method Details

execute

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

Executes the Zulip API request for getting user presence information.

Specified by:

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

Returns:

Map of user presence details keyed by the source of the client name and containing a UserPresenceDetail value

Throws:

ZulipClientException - if the request was not successful