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

Class MessageService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.message.MessageService

All Implemented Interfaces:

ZulipService

public class MessageService
extends Object
implements ZulipService

Zulip message APIs.

Constructor Summary

Constructors

Constructor	Description
MessageService(ZulipHttpClient client)	Constructs a MessageService.

Method Summary

Modifier and Type	Method	Description
AddEmojiReactionApiRequest	addEmojiReaction(long messageId, String emojiName)	Adds a emoji reaction to a message.
CreateMessageReminderApiRequest	createMessageReminder(long messageId, Instant scheduledDeliveryTimestamp)	Creates a message reminder.
DeleteEmojiReactionApiRequest	deleteEmojiReaction(long messageId, String emojiName)	Removes a emoji reaction.
DeleteMessageApiRequest	deleteMessage(long messageId)	Permanently deletes a message.
DeleteMessageReminderApiRequest	deleteMessageReminder(int messageReminderId)	Deletes and cancels a previously scheduled message reminder.
DeleteScheduledMessageApiRequest	deleteScheduledMessage(long scheduledMessageId)	Deletes and cancels the sending of a previously scheduled message.
EditMessageApiRequest	editMessage(long messageId)	Edits the content or topic of a message.
EditScheduledMessageApiRequest	editScheduledMessage(long scheduledMessageId)	Edits an existing scheduled message.
FileUploadApiRequest	fileUpload(File file)	Uploads a file to the Zulip server.
GetMessageApiRequest	getMessage(long messageId)	Gets a single message.
GetMessageHistoryApiRequest	getMessageHistory(long messageId)	Gets a message edit history.
GetMessageReadReceiptsApiRequest	getMessageReadReceipts(long messageId)	Gets a list containing of IDs for all users who have marked the given message as read.
GetMessageRemindersApiRequest	getMessageReminders()	Gets all message reminders for the current user.
GetMessagesApiRequest	getMessages(int numBefore, int numAfter, long anchor)	Fetch message history from a Zulip server using the specified before message id, after message id and anchor message ID.
GetMessagesApiRequest	getMessages(int numBefore, int numAfter, Anchor anchor)	Fetch message history from a Zulip server using the specified before message id, after message id and anchor value.
GetMessagesApiRequest	getMessages(List<Long> messageIds)	Gets a messages matching the given message IDs.
GetScheduledMessagesApiRequest	getScheduledMessages()	Fetch all scheduled messages for the current user.
MarkAllAsReadApiRequest	markAllAsRead()	Deprecated. use updateMessageFlagsForNarrow instead.
MarkStreamAsReadApiRequest	markStreamAsRead(long streamId)	Marks a stream as read.
MarkTopicAsReadApiRequest	markTopicAsRead(long streamId, String topicName)	Marks a topic as read.
MatchesNarrowApiRequest	matchMessages()	Searches for and matches messages with a narrow.
RenderMessageApiRequest	renderMessage(String content)	Renders a message to HTML.
ReportMessageApiRequest	reportMessage(long messageId, MessageReportReason reportReason)	Reports a message for moderation.
SendMessageApiRequest	sendChannelMessage(String content, long channelId, String topic)	Sends a channel message to the given channel id and topic.
SendMessageApiRequest	sendChannelMessage(String content, String channelName, String topic)	Sends a channel message to the given channel name and topic.
SendMessageApiRequest	sendDirectMessage(String content, long... userIds)	Sends a direct message to the users matching the given email user ids.
SendMessageApiRequest	sendDirectMessage(String content, String... userEmails)	Sends a direct message to the users matching the given email addresses.
SendScheduledMessageApiRequest	sendScheduledMessage(MessageType type, String content, Instant deliveryTimestamp, long... to)	Schedules the sending of a message to a specified stream or users.
SendMessageApiRequest	sendStreamMessage(String content, long streamId, String topic)	Sends a stream message to the given stream id and topic.
SendMessageApiRequest	sendStreamMessage(String content, String streamName, String topic)	Sends a stream message to the given stream name and topic.
UpdateMessageFlagsApiRequest	updateMessageFlags(MessageFlag flag, Operation operation, long... messageIds)	Add or remove personal message flags on a collection of message ids
UpdateMessageFlagsForNarrowApiRequest	updateMessageFlagsForNarrow(int anchor, int numBefore, int numAfter, Operation operation, MessageFlag flag, Narrow... narrows)	Add or remove personal message flags with a narrow
UpdateMessageFlagsForNarrowApiRequest	updateMessageFlagsForNarrow(Anchor anchor, int numBefore, int numAfter, Operation operation, MessageFlag flag, Narrow... narrows)	Add or remove personal message flags with a narrow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessageService

public MessageService(ZulipHttpClient client)

Constructs a MessageService.

Parameters:

client - The Zulip HTTP client

Method Details

addEmojiReaction

public AddEmojiReactionApiRequest addEmojiReaction(long messageId,
 String emojiName)

Adds a emoji reaction to a message.

Parameters:

messageId - The id of the message to add an emoji reaction to

emojiName - The name of the emoji to add

Returns:

The AddEmojiReactionApiRequest builder object

See Also:

• https://zulip.com/api/add-reaction

createMessageReminder

public CreateMessageReminderApiRequest createMessageReminder(long messageId,
 Instant scheduledDeliveryTimestamp)

Creates a message reminder.

Parameters:

messageId - The id of the previously sent message to reference in the message reminder

scheduledDeliveryTimestamp - The timestamp for when the message reminder will be sent

Returns:

The CreateMessageReminderApiRequest builder object

See Also:

• https://zulip.com/api/create-message-reminder

deleteEmojiReaction

public DeleteEmojiReactionApiRequest deleteEmojiReaction(long messageId,
 String emojiName)

Removes a emoji reaction.

Parameters:

messageId - The id of the message to remove the reaction from

emojiName - The name of the emoji to remove

Returns:

The DeleteEmojiReactionApiRequest builder object

See Also:

• https://zulip.com/api/remove-reaction

deleteMessage

public DeleteMessageApiRequest deleteMessage(long messageId)

Permanently deletes a message.

Parameters:

messageId - The id of the message to delete

Returns:

The DeleteMessageApiRequest builder object

See Also:

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

deleteMessageReminder

public DeleteMessageReminderApiRequest deleteMessageReminder(int messageReminderId)

Deletes and cancels a previously scheduled message reminder.

Parameters:

messageReminderId - The id of the message reminder to delete

Returns:

The DeleteMessageReminderApiRequest builder object

See Also:

• https://zulip.com/api/delete-reminder

deleteScheduledMessage

public DeleteScheduledMessageApiRequest deleteScheduledMessage(long scheduledMessageId)

Deletes and cancels the sending of a previously scheduled message.

Parameters:

scheduledMessageId - The id of the scheduled message to delete

Returns:

The DeleteMessageApiRequest builder object

See Also:

• https://zulip.com/api/delete-scheduled-message

editMessage

public EditMessageApiRequest editMessage(long messageId)

Edits the content or topic of a message.

Parameters:

messageId - The id of the message to edit

Returns:

The EditMessageApiRequest builder object

See Also:

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

editScheduledMessage

public EditScheduledMessageApiRequest editScheduledMessage(long scheduledMessageId)

Edits an existing scheduled message.

Parameters:

scheduledMessageId - The id of the scheduled message to edit

Returns:

The EditMessageApiRequest builder object

See Also:

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

fileUpload

public FileUploadApiRequest fileUpload(File file)

Uploads a file to the Zulip server.

Parameters:

file - The file to upload

Returns:

The FileUploadApiRequest builder object

See Also:

• https://zulip.com/api/upload-file

getMessageHistory

public GetMessageHistoryApiRequest getMessageHistory(long messageId)

Gets a message edit history.

Parameters:

messageId - The id of the message to get edit history

Returns:

The GetMessageHistoryApiRequest builder object

See Also:

• https://zulip.com/api/get-message-history

getMessage

public GetMessageApiRequest getMessage(long messageId)

Gets a single message.

Parameters:

messageId - The id of the message to get

Returns:

The GetMessageApiRequest builder object

See Also:

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

getMessages

public GetMessagesApiRequest getMessages(List<Long> messageIds)

Gets a messages matching the given message IDs.

Parameters:

messageIds - The IDs of the messages to fetch

Returns:

The GetMessagesApiRequest builder object

getMessages

public GetMessagesApiRequest getMessages(int numBefore,
 int numAfter,
 Anchor anchor)

Fetch message history from a Zulip server using the specified before message id, after message id and anchor value.

To refine the list of messages returned, use the returned GetMessagesApiRequest builder object to set an anchor and narrow expression.

Note that a maximum of 5000 messages can be obtained per request. Therefore Zulip recommends using a numBefore value of <= 1000 and a numAfter value <= 1000.

Parameters:

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

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

anchor - The value for the server to compute the anchor from

Returns:

The GetMessagesApiRequest builder object

See Also:

• https://www.zulipchat.com/api/get-messages

getMessages

public GetMessagesApiRequest getMessages(int numBefore,
 int numAfter,
 long anchor)

Fetch message history from a Zulip server using the specified before message id, after message id and anchor message ID.

To refine the list of messages returned, use the returned GetMessagesApiRequest builder object to set an anchor and narrow expression.

Note that a maximum of 5000 messages can be obtained per request. Therefore Zulip recommends using a numBefore value of <= 1000 and a numAfter vlaue <= 1000.

Parameters:

numBefore - The number of messages with IDs less than the (optional) anchor to retrieve

numAfter - The number of messages with IDs greater than the (optional) anchor to retrieve

anchor - The message ID to anchor fetching of new message

Returns:

The GetMessagesApiRequest builder object

See Also:

• https://www.zulipchat.com/api/get-messages

getMessageReadReceipts

public GetMessageReadReceiptsApiRequest getMessageReadReceipts(long messageId)

Gets a list containing of IDs for all users who have marked the given message as read.

Parameters:

messageId - The id of the message to get read recipients for

Returns:

The GetMessageReadReceiptsApiRequest builder object

See Also:

• https://zulip.com/api/get-read-receipts

getMessageReminders

public GetMessageRemindersApiRequest getMessageReminders()

Gets all message reminders for the current user.

Returns:

The GetMessageReadReceiptsApiRequest builder object

See Also:

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

getScheduledMessages

public GetScheduledMessagesApiRequest getScheduledMessages()

Fetch all scheduled messages for the current user.

Returns:

The GetScheduledMessagesApiRequest builder object

See Also:

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

markAllAsRead

@Deprecated
public MarkAllAsReadApiRequest markAllAsRead()

Deprecated.

use updateMessageFlagsForNarrow instead.

Marks all of the current user unread messages as read.

Returns:

The MarkAllAsReadApiRequest builder object

See Also:

• https://zulip.com/api/mark-all-as-read

markStreamAsRead

public MarkStreamAsReadApiRequest markStreamAsRead(long streamId)

Marks a stream as read.

Parameters:

streamId - The id of the stream to mark as read

Returns:

The MarkStreamAsReadApiRequest builder object

See Also:

• https://zulip.com/api/mark-all-as-read#mark-messages-in-a-stream-as-read

markTopicAsRead

public MarkTopicAsReadApiRequest markTopicAsRead(long streamId,
 String topicName)

Marks a topic as read.

Parameters:

streamId - The id of the stream wher the topic resides

topicName - The name of the topic to mark as read

Returns:

The MarkTopicAsReadApiRequest builder object

See Also:

• https://zulip.com/api/mark-all-as-read#mark-messages-in-a-topic-as-read

matchMessages

public MatchesNarrowApiRequest matchMessages()

Searches for and matches messages with a narrow.

Returns:

The MatchesNarrowApiRequest builder object

See Also:

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

renderMessage

public RenderMessageApiRequest renderMessage(String content)

Renders a message to HTML.

Parameters:

content - The content to render as HTML

Returns:

The RenderMessageApiRequest builder object

See Also:

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

reportMessage

public ReportMessageApiRequest reportMessage(long messageId,
 MessageReportReason reportReason)

Reports a message for moderation.

Parameters:

messageId - The id of the message to report

reportReason - The reason for the message report

Returns:

The ReportMessageApiRequest builder object

See Also:

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

sendChannelMessage

public SendMessageApiRequest sendChannelMessage(String content,
 String channelName,
 String topic)

Sends a channel message to the given channel name and topic.

Parameters:

content - The content of the message

channelName - The name of the channel to send the message to

topic - The name of the message topic

Returns:

The SendMessageApiRequest builder object

See Also:

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

sendChannelMessage

public SendMessageApiRequest sendChannelMessage(String content,
 long channelId,
 String topic)

Sends a channel message to the given channel id and topic.

Parameters:

content - The content of the message

channelId - The id of the stream to send the message to

topic - The name of the message topic

Returns:

The SendMessageApiRequest builder object

See Also:

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

sendDirectMessage

public SendMessageApiRequest sendDirectMessage(String content,
 String... userEmails)

Sends a direct message to the users matching the given email addresses.

Parameters:

content - The content of the message

userEmails - The email addresses of the users to send the message to

Returns:

The SendMessageApiRequest builder object

See Also:

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

sendDirectMessage

public SendMessageApiRequest sendDirectMessage(String content,
 long... userIds)

Sends a direct message to the users matching the given email user ids.

Parameters:

content - The content of the message

userIds - The ids of the users to send the message to

Returns:

The SendMessageApiRequest builder object

See Also:

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

sendScheduledMessage

public SendScheduledMessageApiRequest sendScheduledMessage(MessageType type,
 String content,
 Instant deliveryTimestamp,
 long... to)

Schedules the sending of a message to a specified stream or users.

Parameters:

type - The type of scheduled message to be sent

content - The content of the message

deliveryTimestamp - Instant set to the UNIX epoch timestamp for when the message will be sent

to - If the type is 'stream' then this is the id of the stream. Else one or more user ids may be specified

Returns:

The SendScheduledMessageApiRequest

sendStreamMessage

public SendMessageApiRequest sendStreamMessage(String content,
 String streamName,
 String topic)

Sends a stream message to the given stream name and topic.

Parameters:

content - The content of the message

streamName - The name of the stream to send the message to

topic - The name of the message topic

Returns:

The SendMessageApiRequest builder object

See Also:

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

sendStreamMessage

public SendMessageApiRequest sendStreamMessage(String content,
 long streamId,
 String topic)

Sends a stream message to the given stream id and topic.

Parameters:

content - The content of the message

streamId - The id of the stream to send the message to

topic - The name of the message topic

Returns:

The SendMessageApiRequest builder object

See Also:

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

updateMessageFlags

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

Add or remove personal message flags on a collection of message ids

Parameters:

flag - The MessageFlag to add or remove

operation - The Operation to apply

messageIds - The message ids to update flags on

Returns:

The UpdateMessageFlagsApiRequest builder object

See Also:

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

updateMessageFlagsForNarrow

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

Add or remove personal message flags with a narrow

Parameters:

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

Returns:

The UpdateMessageFlagsApiRequest builder object

See Also:

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

updateMessageFlagsForNarrow

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

Add or remove personal message flags with a narrow

Parameters:

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

Returns:

The UpdateMessageFlagsApiRequest builder object

See Also:

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