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

Class UpdateMessageFlagsForNarrowApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<MessageFlagsUpdateResult>

public class UpdateMessageFlagsForNarrowApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<MessageFlagsUpdateResult>

Zulip API request builder for updating message flags with a narrow.

See Also:

• https://zulip.com/api/update-message-flags-for-narrow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANCHOR
static final String	FLAG
static final String	INCLUDE_ANCHOR
static final String	NARROW
static final String	NUM_AFTER
static final String	NUM_BEFORE
static final String	OP

Constructor Summary

Constructors

Constructor	Description
UpdateMessageFlagsForNarrowApiRequest(ZulipHttpClient client, int anchor, int numBefore, int numAfter, Operation operation, MessageFlag flag, Narrow... narrows)	Constructs a UpdateMessageFlagsForNarrowApiRequest.
UpdateMessageFlagsForNarrowApiRequest(ZulipHttpClient client, Anchor anchor, int numBefore, int numAfter, Operation operation, MessageFlag flag, Narrow... narrows)	Constructs a UpdateMessageFlagsForNarrowApiRequest.

Method Summary

Modifier and Type	Method	Description
MessageFlagsUpdateResult	execute()	Executes The Zulip API request for updating message flags with a narrow.
UpdateMessageFlagsForNarrowApiRequest	withIncludeAnchor(boolean isIncludeAnchor)	Sets whether a message with the specified ID matching the narrow should be included in the update range.

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

ANCHOR

public static final String ANCHOR

See Also:

• Constant Field Values

FLAG

public static final String FLAG

See Also:

• Constant Field Values

INCLUDE_ANCHOR

public static final String INCLUDE_ANCHOR

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

OP

public static final String OP

See Also:

• Constant Field Values

Constructor Details

UpdateMessageFlagsForNarrowApiRequest

public UpdateMessageFlagsForNarrowApiRequest(ZulipHttpClient client,
 Anchor anchor,
 int numBefore,
 int numAfter,
 Operation operation,
 MessageFlag flag,
 Narrow... narrows)

Constructs a UpdateMessageFlagsForNarrowApiRequest.

Parameters:

client - The Zulip HTTP client

anchor - The Anchor to use

numBefore - The number of messages preceding the anchor in the update range

numAfter - The number of messages following the anchor in the update range

operation - The Operation to apply for the MessageFlag

flag - The MessageFlag to add or remove to the messages

narrows - The Narrow expressions to use

UpdateMessageFlagsForNarrowApiRequest

public UpdateMessageFlagsForNarrowApiRequest(ZulipHttpClient client,
 int anchor,
 int numBefore,
 int numAfter,
 Operation operation,
 MessageFlag flag,
 Narrow... narrows)

Constructs a UpdateMessageFlagsForNarrowApiRequest.

Parameters:

client - The Zulip HTTP client

anchor - The message id anchor to filter and restrict messages

numBefore - The number of messages preceding the anchor in the update range

numAfter - The number of messages following the anchor in the update range

operation - The Operation to apply for the MessageFlag

flag - The MessageFlag to add or remove to the messages

narrows - The Narrow expressions to use

Method Details

withIncludeAnchor

public UpdateMessageFlagsForNarrowApiRequest withIncludeAnchor(boolean isIncludeAnchor)

Sets whether a message with the specified ID matching the narrow should be included in the update range.

Parameters:

isIncludeAnchor - Whether a message with the specified ID matching the narrow should be included in the update range

Returns:

This UpdateMessageFlagsForNarrowApiRequest instance

execute

public MessageFlagsUpdateResult execute()
                                 throws ZulipClientException

Executes The Zulip API request for updating message flags with a narrow.

Specified by:

execute in interface ExecutableApiRequest<MessageFlagsUpdateResult>

Returns:

The result of the update

Throws:

ZulipClientException - if the request was not successful