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

Class MatchesNarrowApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Map<Long,MessageMatch>>, NarrowableApiRequest<MatchesNarrowApiRequest>

public class MatchesNarrowApiRequest
extends ZulipApiRequest
implements NarrowableApiRequest<MatchesNarrowApiRequest>, ExecutableApiRequest<Map<Long,MessageMatch>>

Zulip API request builder for checking if a set of messages matches a narrow.

See Also:

• https://zulip.com/api/check-narrow-matches
• https://zulip.com/api/construct-narrow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_IDS
static final String	NARROW

Constructor Summary

Constructors

Constructor	Description
MatchesNarrowApiRequest(ZulipHttpClient client)	Constructs a MatchesNarrowApiRequest.

Method Summary

Modifier and Type	Method	Description
Map<Long,MessageMatch>	execute()	Executes the Zulip API request for checking if a set of messages matches a narrow.
MatchesNarrowApiRequest	withMessageIds(long... messageIds)	Sets the mandatory message ids to check.
MatchesNarrowApiRequest	withNarrows(Narrow... narrows)	Sets the narrow expressions to check.

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

MESSAGE_IDS

public static final String MESSAGE_IDS

See Also:

• Constant Field Values

NARROW

public static final String NARROW

See Also:

• Constant Field Values

Constructor Details

MatchesNarrowApiRequest

public MatchesNarrowApiRequest(ZulipHttpClient client)

Constructs a MatchesNarrowApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withMessageIds

public MatchesNarrowApiRequest withMessageIds(long... messageIds)

Sets the mandatory message ids to check.

Parameters:

messageIds - One or message ids to check

Returns:

This MatchesNarrowApiRequest instance

See Also:

• https://zulip.com/api/check-narrow-matches#parameter-msg_ids

withNarrows

public MatchesNarrowApiRequest withNarrows(Narrow... narrows)

Sets the narrow expressions to check.

Specified by:

withNarrows in interface NarrowableApiRequest<MatchesNarrowApiRequest>

Parameters:

narrows - One or Narrow expressions to check

Returns:

This MatchesNarrowApiRequest instance

See Also:

• https://zulip.com/api/check-narrow-matches#parameter-narrow

execute

public Map<Long,MessageMatch> execute()
                               throws ZulipClientException

Executes the Zulip API request for checking if a set of messages matches a narrow.

Specified by:

execute in interface ExecutableApiRequest<Map<Long,MessageMatch>>

Returns:

map keyed by message id where the value is a MessageMatch

Throws:

ZulipClientException - if the request was not successful