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

Class UpdateMessageFlagsApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<List<Long>>

public class UpdateMessageFlagsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<List<Long>>

Zulip API request builder for updating message flags.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLAG
static final String	MESSAGES
static final String	OP

Constructor Summary

Constructors

Constructor	Description
UpdateMessageFlagsApiRequest(ZulipHttpClient client, MessageFlag flag, Operation operation, long... messageIds)	Constructs a UpdateMessageFlagsApiRequest.

Method Summary

Modifier and Type	Method	Description
List<Long>	execute()	Executes The Zulip API request for updating message flags.

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

FLAG

public static final String FLAG

See Also:

• Constant Field Values

MESSAGES

public static final String MESSAGES

See Also:

• Constant Field Values

OP

public static final String OP

See Also:

• Constant Field Values

Constructor Details

UpdateMessageFlagsApiRequest

public UpdateMessageFlagsApiRequest(ZulipHttpClient client,
 MessageFlag flag,
 Operation operation,
 long... messageIds)

Constructs a UpdateMessageFlagsApiRequest.

Parameters:

client - The Zulip HTTP client

flag - The MessageFlag to add or remove to the messages

operation - The Operation to apply for the MessageFlag

messageIds - The message ids for which to update flags for

Method Details

execute

public List<Long> execute()
                   throws ZulipClientException

Executes The Zulip API request for updating message flags.

Specified by:

execute in interface ExecutableApiRequest<List<Long>>

Returns:

List of ids for messages that were modified

Throws:

ZulipClientException - if the request was not successful