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

Class GetOwnUserApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<User>

public class GetOwnUserApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<User>

Zulip API request builder for getting information about the user who invoked this endpoint.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
GetOwnUserApiRequest(ZulipHttpClient client)	Constructs a GetOwnUserApiRequest.

Method Summary

Modifier and Type	Method	Description
User	execute()	Executes the Zulip API request for getting information about the user who invoked this endpoint.

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

GetOwnUserApiRequest

public GetOwnUserApiRequest(ZulipHttpClient client)

Constructs a GetOwnUserApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public User execute()
             throws ZulipClientException

Executes the Zulip API request for getting information about the user who invoked this endpoint.

Specified by:

execute in interface ExecutableApiRequest<User>

Returns:

User contining information about the user who invoked this endpoint

Throws:

ZulipClientException - if the request was not successful