xyz.nickr.jitter.api

Interface Message

All Known Implementing Classes:

MessageImpl

public interface Message

Represents a message sent to a room by a user.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
void	edit(String message) Edits this message to contain the given text.
Optional<Date>	getEditTimestamp() Gets the Date when this message was last edited, if it ever has been.
String	getHtml() Gets this message's text in HTML.
String	getID() Gets this message's ID.
List<MentionedIssue>	getIssues() Gets any issues mentioned in this message.
Jitter	getJitter() Gets the providing Jitter object.
List<MentionedUser>	getMentions() Gets any users mentioned in this message.
MessageMetadata	getMetadata() Gets this message's metadata.
int	getReadCount() Gets the number of people who have read this message.
Room	getRoom() Gets the Room this message was sent to.
User	getSender() Gets the User this message was sent by.
Date	getSentTimestamp() Gets the Date when this message was sent.
String	getText() Gets this message's text in Markdown.
List<String>	getURLs() Gets any URLs mentioned in this message.
int	getVersion() Gets this message's version.
boolean	isRead() Gets whether or not the authenticated user has read this message.

Method Detail

getJitter

Jitter getJitter()

Gets the providing Jitter object.

Returns:

The provider.

asJSON

org.json.JSONObject asJSON()

Gets the underlying JSON object.

Returns:

The JSON.

getRoom

Room getRoom()

Gets the Room this message was sent to.

Returns:

The room.

getSender

User getSender()

Gets the User this message was sent by.

Returns:

The user.

getID

String getID()

Gets this message's ID.

Returns:

The ID.

getText

String getText()

Gets this message's text in Markdown.

Returns:

The text.

getHtml

String getHtml()

Gets this message's text in HTML.

Returns:

The message's HTML text.

getSentTimestamp

Date getSentTimestamp()

Gets the Date when this message was sent.

Returns:

The date when it was sent.

getEditTimestamp

Optional<Date> getEditTimestamp()

Gets the Date when this message was last edited, if it ever has been.

Returns:

The date when it was edited.

edit

void edit(String message)

Edits this message to contain the given text. This object is updated to reflect the changes.

Parameters:

message - The new message.

isRead

boolean isRead()

Gets whether or not the authenticated user has read this message.

NOTE: API queries don't count as reading.

Returns:

Whether or not this message has been read.

getReadCount

int getReadCount()

Gets the number of people who have read this message.

Returns:

The number of read messages.

getURLs

List<String> getURLs()

Gets any URLs mentioned in this message.

Returns:

The URLs.

getMentions

List<MentionedUser> getMentions()

Gets any users mentioned in this message.

Returns:

The users.

getIssues

List<MentionedIssue> getIssues()

Gets any issues mentioned in this message.

Returns:

The issues.

getMetadata

MessageMetadata getMetadata()

Gets this message's metadata.

Returns:

The metadata.

getVersion

int getVersion()

Gets this message's version.

Returns:

The version.