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

Class GetAllUserPresenceApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Map<String,Map<String,UserPresenceDetail>>>

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

Zulip API request builder for getting all user presence.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetAllUserPresenceApiRequest(ZulipHttpClient client)	Constructs a GetAllUserPresenceApiRequest.

Method Summary

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

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

Constructor Details

GetAllUserPresenceApiRequest

public GetAllUserPresenceApiRequest(ZulipHttpClient client)

Constructs a GetAllUserPresenceApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

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

Executes the Zulip API request for getting all user presence.

Specified by:

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

Returns:

Map of user presence details keyed bu user id or email address

Throws:

ZulipClientException - if the request was not successful