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

Class GetMessagesApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.message.request.GetMessagesApiRequest

All Implemented Interfaces:

ExecutableApiRequest<List<Message>>, NarrowableApiRequest<GetMessagesApiRequest>

public class GetMessagesApiRequest
extends ZulipApiRequest
implements NarrowableApiRequest<GetMessagesApiRequest>, ExecutableApiRequest<List<Message>>

Zulip API request builder for searching and getting messages.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_EMPTY_TOPIC_NAME
static final String	ANCHOR
static final String	GRAVATAR
static final String	INCLUDE_ANCHOR
static final String	MARKDOWN
static final String	MESSAGE_IDS
static final String	NARROW
static final String	NUM_AFTER
static final String	NUM_BEFORE

Constructor Summary

Constructors

Constructor	Description
GetMessagesApiRequest(ZulipHttpClient client)	Constructs a GetMessagesApiRequest.

Method Summary

Modifier and Type	Method	Description
List<Message>	execute()	Executes the Zulip API request for searching and getting messages.
GetMessagesApiRequest	withAllowEmptyTopicName(boolean allowEmptyTopicName)	Sets whether to allow empty topic names to be returned.
GetMessagesApiRequest	withAnchor(long messageId)	Sets the optional message id anchor to filter and restrict messages.
GetMessagesApiRequest	withAnchor(Anchor anchor)	Sets the optional Anchor to filter and restrict messages.
GetMessagesApiRequest	withGravatar(boolean clientGravatar)	Sets the optional choice of whether to return the users gravatar URL int the response.
GetMessagesApiRequest	withIncludeAnchor(boolean includeAnchor)	Whether a message with the specified ID matching the narrow should be included.
GetMessagesApiRequest	withMarkdown(boolean applyMarkdown)	Sets the optional choice of message content should be returned in the rendered HTML format.
GetMessagesApiRequest	withMessageIds(List<Long> messageIds)	Sets the list of message IDs to fetch.
GetMessagesApiRequest	withNarrows(Narrow... narrows)	Sets the optional narrow to fetch messages from.
GetMessagesApiRequest	withNumAfter(int numAfter)	Sets the mandatory number of messages with ids greater than the anchor to retrieve.
GetMessagesApiRequest	withNumBefore(int numBefore)	Sets the mandatory number of messages with ids less than the anchor to retrieve.

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

ALLOW_EMPTY_TOPIC_NAME

public static final String ALLOW_EMPTY_TOPIC_NAME

See Also:

• Constant Field Values

ANCHOR

public static final String ANCHOR

See Also:

• Constant Field Values

GRAVATAR

public static final String GRAVATAR

See Also:

• Constant Field Values

INCLUDE_ANCHOR

public static final String INCLUDE_ANCHOR

See Also:

• Constant Field Values

MARKDOWN

public static final String MARKDOWN

See Also:

• Constant Field Values

MESSAGE_IDS

public static final String MESSAGE_IDS

See Also:

• Constant Field Values

NARROW

public static final String NARROW

See Also:

• Constant Field Values

NUM_AFTER

public static final String NUM_AFTER

See Also:

• Constant Field Values

NUM_BEFORE

public static final String NUM_BEFORE

See Also:

• Constant Field Values

Constructor Details

GetMessagesApiRequest

public GetMessagesApiRequest(ZulipHttpClient client)

Constructs a GetMessagesApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withAllowEmptyTopicName

public GetMessagesApiRequest withAllowEmptyTopicName(boolean allowEmptyTopicName)

Sets whether to allow empty topic names to be returned.

Parameters:

allowEmptyTopicName - true to allow empty topic names. false to disallow empty topic names

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-allow_empty_topic_name

withAnchor

public GetMessagesApiRequest withAnchor(Anchor anchor)

Sets the optional Anchor to filter and restrict messages.

Parameters:

anchor - The anchor value

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-anchor

withAnchor

public GetMessagesApiRequest withAnchor(long messageId)

Sets the optional message id anchor to filter and restrict messages.

Parameters:

messageId - The message id anchor value

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-anchor

withIncludeAnchor

public GetMessagesApiRequest withIncludeAnchor(boolean includeAnchor)

Whether a message with the specified ID matching the narrow should be included.

Parameters:

includeAnchor - true if a message with the specified ID matching the narrow should be included. False if a message with the specified ID matching the narrow should not be included

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-include_anchor

withMessageIds

public GetMessagesApiRequest withMessageIds(List<Long> messageIds)

Sets the list of message IDs to fetch.

Parameters:

messageIds - The message IDs to fetch and match against

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-message_ids

withNumBefore

public GetMessagesApiRequest withNumBefore(int numBefore)

Sets the mandatory number of messages with ids less than the anchor to retrieve.

Parameters:

numBefore - The number of messages with ids less than the anchor to retrieve

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-num_before

withNumAfter

public GetMessagesApiRequest withNumAfter(int numAfter)

Sets the mandatory number of messages with ids greater than the anchor to retrieve.

Parameters:

numAfter - The number of messages with ids greater than the anchor to retrieve

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-num_after

withNarrows

public GetMessagesApiRequest withNarrows(Narrow... narrows)

Sets the optional narrow to fetch messages from.

Specified by:

withNarrows in interface NarrowableApiRequest<GetMessagesApiRequest>

Parameters:

narrows - One or more Narrow expressions

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-narrow

withGravatar

public GetMessagesApiRequest withGravatar(boolean clientGravatar)

Sets the optional choice of whether to return the users gravatar URL int the response.

Parameters:

clientGravatar - true if the gravatar should be included in the response. False if the gravatar should not be included

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-client_gravatar

withMarkdown

public GetMessagesApiRequest withMarkdown(boolean applyMarkdown)

Sets the optional choice of message content should be returned in the rendered HTML format.

Parameters:

applyMarkdown - true if to return rendered HTML. false if markdown should be returned

Returns:

This GetMessagesApiRequest instance

See Also:

• https://zulip.com/api/get-messages#parameter-apply_markdown

execute

public List<Message> execute()
                      throws ZulipClientException

Executes the Zulip API request for searching and getting messages.

Specified by:

execute in interface ExecutableApiRequest<List<Message>>

Returns:

List of Message objects that matched the search criteria

Throws:

ZulipClientException - if the request was not successful