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

Class SendMessageApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class SendMessageApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for sending a message.

See Also:

• https://zulip.com/api/send-message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT
static final String	LOCAL_ID
static final String	QUEUE_ID
static final String	READ_BY_SENDER
static final String	TO
static final String	TO_DIRECT
static final String	TO_STREAM
static final String	TOPIC
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SendMessageApiRequest(ZulipHttpClient client, String content, long... to)	Constructs a SendMessageApiRequest for sending a direct message.
SendMessageApiRequest(ZulipHttpClient client, String content, long streamId, String topic)	Constructs a SendMessageApiRequest.
SendMessageApiRequest(ZulipHttpClient client, String content, long streamId, String topic, MessageType type)	Constructs a SendMessageApiRequest.
SendMessageApiRequest(ZulipHttpClient client, String content, String... to)	Constructs a SendMessageApiRequest for sending a direct message.
SendMessageApiRequest(ZulipHttpClient client, String content, String streamName, String topic)	Constructs a SendMessageApiRequest for sending a message to a stream.
SendMessageApiRequest(ZulipHttpClient client, String content, String streamName, String topic, MessageType type)	Constructs a SendMessageApiRequest for sending a message to a stream.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for sending a message.
SendMessageApiRequest	withLocalId(String localId)	The optional local id associated with the message.
SendMessageApiRequest	withQueueId(String queueId)	The optional queue id associated with the message.
SendMessageApiRequest	withReadBySender(boolean readBySender)	The optional value of whether the message should be initially marked read by its sender.

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

CONTENT

public static final String CONTENT

See Also:

• Constant Field Values

LOCAL_ID

public static final String LOCAL_ID

See Also:

• Constant Field Values

QUEUE_ID

public static final String QUEUE_ID

See Also:

• Constant Field Values

READ_BY_SENDER

public static final String READ_BY_SENDER

See Also:

• Constant Field Values

TO

public static final String TO

See Also:

• Constant Field Values

TO_DIRECT

public static final String TO_DIRECT

See Also:

• Constant Field Values

TO_STREAM

public static final String TO_STREAM

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 String... to)

Constructs a SendMessageApiRequest for sending a direct message.

Parameters:

client - The Zulip HTTP client

content - The message content

to - One or more user email addresses for which the direct message should be sent to

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 long... to)

Constructs a SendMessageApiRequest for sending a direct message.

Parameters:

client - The Zulip HTTP client

content - The message content

to - One or more user ids for which the direct message should be sent to

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 String streamName,
 String topic)

Constructs a SendMessageApiRequest for sending a message to a stream.

Parameters:

client - The Zulip HTTP client

content - The message content

streamName - The name of the stream to which the stream should be sent to

topic - The name od the topic to post the message under

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 long streamId,
 String topic)

Constructs a SendMessageApiRequest.

Parameters:

client - The Zulip HTTP client

content - The message content

streamId - The id of the stream to which the stream should be sent to

topic - The name od the topic to post the message under

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 String streamName,
 String topic,
 MessageType type)

Constructs a SendMessageApiRequest for sending a message to a stream.

Parameters:

client - The Zulip HTTP client

content - The message content

streamName - The name of the stream to which the stream should be sent to

topic - The name od the topic to post the message under

type - The MessageType for the type of message to send

SendMessageApiRequest

public SendMessageApiRequest(ZulipHttpClient client,
 String content,
 long streamId,
 String topic,
 MessageType type)

Constructs a SendMessageApiRequest.

Parameters:

client - The Zulip HTTP client

content - The message content

streamId - The id of the stream to which the stream should be sent to

topic - The name od the topic to post the message under

type - The MessageType for the type of message to send

Method Details

withLocalId

public SendMessageApiRequest withLocalId(String localId)

The optional local id associated with the message.

Parameters:

localId - The local id to associate with the message

Returns:

This SendMessageApiRequest instance

See Also:

• https://zulip.com/api/send-message#parameter-local_id

withQueueId

public SendMessageApiRequest withQueueId(String queueId)

The optional queue id associated with the message.

Parameters:

queueId - The queue id to associate with the message

Returns:

This SendMessageApiRequest instance

See Also:

• https://zulip.com/api/send-message#parameter-queue_id

withReadBySender

public SendMessageApiRequest withReadBySender(boolean readBySender)

The optional value of whether the message should be initially marked read by its sender.

Parameters:

readBySender - Whether the message should be initially marked read by its sender

Returns:

This SendMessageApiRequest instance

See Also:

• https://zulip.com/api/send-message#parameter-read_by_sender

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for sending a message.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The id of the message

Throws:

ZulipClientException - if the request was not successful