xyz.nickr.jitter.impl

Class MessageImpl

java.lang.Object

xyz.nickr.jitter.impl.MessageImpl

All Implemented Interfaces:

Message

public class MessageImpl
extends Object
implements Message

Constructor Summary

Constructors

Constructor and Description
MessageImpl(Jitter jitter, Room room, User user, org.json.JSONObject json)

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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageImpl

public MessageImpl(Jitter jitter,
                   Room room,
                   User user,
                   org.json.JSONObject json)

Method Detail

getJitter

public Jitter getJitter()

Description copied from interface: Message

Gets the providing Jitter object.

Specified by:

getJitter in interface Message

Returns:

The provider.

asJSON

public org.json.JSONObject asJSON()

Description copied from interface: Message

Gets the underlying JSON object.

Specified by:

asJSON in interface Message

Returns:

The JSON.

getRoom

public Room getRoom()

Description copied from interface: Message

Gets the Room this message was sent to.

Specified by:

getRoom in interface Message

Returns:

The room.

getSender

public User getSender()

Description copied from interface: Message

Gets the User this message was sent by.

Specified by:

getSender in interface Message

Returns:

The user.

getID

public String getID()

Description copied from interface: Message

Gets this message's ID.

Specified by:

getID in interface Message

Returns:

The ID.

getText

public String getText()

Description copied from interface: Message

Gets this message's text in Markdown.

Specified by:

getText in interface Message

Returns:

The text.

getHtml

public String getHtml()

Description copied from interface: Message

Gets this message's text in HTML.

Specified by:

getHtml in interface Message

Returns:

The message's HTML text.

getSentTimestamp

public Date getSentTimestamp()

Description copied from interface: Message

Gets the Date when this message was sent.

Specified by:

getSentTimestamp in interface Message

Returns:

The date when it was sent.

getEditTimestamp

public Optional<Date> getEditTimestamp()

Description copied from interface: Message

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

Specified by:

getEditTimestamp in interface Message

Returns:

The date when it was edited.

edit

public void edit(String message)

Description copied from interface: Message

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

Specified by:

edit in interface Message

Parameters:

message - The new message.

isRead

public boolean isRead()

Description copied from interface: Message

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

NOTE: API queries don't count as reading.

Specified by:

isRead in interface Message

Returns:

Whether or not this message has been read.

getReadCount

public int getReadCount()

Description copied from interface: Message

Gets the number of people who have read this message.

Specified by:

getReadCount in interface Message

Returns:

The number of read messages.

getURLs

public List<String> getURLs()

Description copied from interface: Message

Gets any URLs mentioned in this message.

Specified by:

getURLs in interface Message

Returns:

The URLs.

getMentions

public List<MentionedUser> getMentions()

Description copied from interface: Message

Gets any users mentioned in this message.

Specified by:

getMentions in interface Message

Returns:

The users.

getIssues

public List<MentionedIssue> getIssues()

Description copied from interface: Message

Gets any issues mentioned in this message.

Specified by:

getIssues in interface Message

Returns:

The issues.

getMetadata

public MessageMetadata getMetadata()

Description copied from interface: Message

Gets this message's metadata.

Specified by:

getMetadata in interface Message

Returns:

The metadata.

getVersion

public int getVersion()

Description copied from interface: Message

Gets this message's version.

Specified by:

getVersion in interface Message

Returns:

The version.

toString

public String toString()

Overrides:

toString in class Object