Package com.symphony.api.model

Class V4Message

java.lang.Object

com.symphony.api.model.V4Message

public class V4Message
extends Object

A representation of a message sent by a user of Symphony

Constructor Summary

Constructors

Constructor	Description
V4Message()

Method Summary

Modifier and Type	Method	Description
V4Message	addAttachmentsItem(V4AttachmentInfo attachmentsItem)
V4Message	attachments(List<V4AttachmentInfo> attachments)
V4Message	data(String data)
V4Message	diagnostic(String diagnostic)
V4Message	disclaimer(String disclaimer)
V4Message	externalRecipients(Boolean externalRecipients)
List<V4AttachmentInfo>	getAttachments()	Message attachments
String	getData()	Message data in EntityJSON
String	getDiagnostic()	Details if event failed to parse for any reason.
String	getDisclaimer()	Message that may be sent along with a regular message if configured for the POD, usually the first message sent in a room that day.
String	getMessage()	Message content in MessageMLV2
String	getMessageId()	Id of the message
String	getOriginalFormat()	Indicates the format in which the message was originally sent.
V4Message	getSharedMessage()	Get sharedMessage
V4Stream	getStream()	Get stream
Long	getTimestamp()	Timestamp of the message in milliseconds since Jan 1 1970
V4User	getUser()	Get user
String	getUserAgent()	User agent string for client that sent the message.
Boolean	isisExternalRecipients()	Indicates if the message have external recipients.
V4Message	message(String message)
V4Message	messageId(String messageId)
V4Message	originalFormat(String originalFormat)
void	setAttachments(List<V4AttachmentInfo> attachments)
void	setData(String data)
void	setDiagnostic(String diagnostic)
void	setDisclaimer(String disclaimer)
void	setExternalRecipients(Boolean externalRecipients)
void	setMessage(String message)
void	setMessageId(String messageId)
void	setOriginalFormat(String originalFormat)
void	setSharedMessage(V4Message sharedMessage)
void	setStream(V4Stream stream)
void	setTimestamp(Long timestamp)
void	setUser(V4User user)
void	setUserAgent(String userAgent)
V4Message	sharedMessage(V4Message sharedMessage)
V4Message	stream(V4Stream stream)
V4Message	timestamp(Long timestamp)
String	toString()
V4Message	user(V4User user)
V4Message	userAgent(String userAgent)

Methods inherited from class java.lang.Object

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

Constructor Detail

V4Message

public V4Message()

Method Detail

getMessageId

public String getMessageId()

Id of the message

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

messageId

public V4Message messageId(String messageId)

getTimestamp

public Long getTimestamp()

Timestamp of the message in milliseconds since Jan 1 1970

Returns:

timestamp

setTimestamp

public void setTimestamp(Long timestamp)

timestamp

public V4Message timestamp(Long timestamp)

getMessage

public String getMessage()

Message content in MessageMLV2

Returns:

message

setMessage

public void setMessage(String message)

message

public V4Message message(String message)

getSharedMessage

public V4Message getSharedMessage()

Get sharedMessage

Returns:

sharedMessage

setSharedMessage

public void setSharedMessage(V4Message sharedMessage)

sharedMessage

public V4Message sharedMessage(V4Message sharedMessage)

getData

public String getData()

Message data in EntityJSON

Returns:

data

setData

public void setData(String data)

data

public V4Message data(String data)

getAttachments

public List<V4AttachmentInfo> getAttachments()

Message attachments

Returns:

attachments

setAttachments

public void setAttachments(List<V4AttachmentInfo> attachments)

attachments

public V4Message attachments(List<V4AttachmentInfo> attachments)

addAttachmentsItem

public V4Message addAttachmentsItem(V4AttachmentInfo attachmentsItem)

getUser

public V4User getUser()

Get user

Returns:

user

setUser

public void setUser(V4User user)

user

public V4Message user(V4User user)

getStream

public V4Stream getStream()

Get stream

Returns:

stream

setStream

public void setStream(V4Stream stream)

stream

public V4Message stream(V4Stream stream)

isisExternalRecipients

public Boolean isisExternalRecipients()

Indicates if the message have external recipients. Only present on real time messaging.

Returns:

externalRecipients

setExternalRecipients

public void setExternalRecipients(Boolean externalRecipients)

externalRecipients

public V4Message externalRecipients(Boolean externalRecipients)

getDiagnostic

public String getDiagnostic()

Details if event failed to parse for any reason. The contents of this field may not be useful, depending on the nature of the error. Only present when error occurs.

Returns:

diagnostic

setDiagnostic

public void setDiagnostic(String diagnostic)

diagnostic

public V4Message diagnostic(String diagnostic)

getUserAgent

public String getUserAgent()

User agent string for client that sent the message. Allows callers to identify which client sent the origin message (e.g. API Agent, SFE Client, mobile, etc)

Returns:

userAgent

setUserAgent

public void setUserAgent(String userAgent)

userAgent

public V4Message userAgent(String userAgent)

getOriginalFormat

public String getOriginalFormat()

Indicates the format in which the message was originally sent. This could have been either: - com.symphony.markdown - Markdown OR Message ML V1 - com.symphony.messageml.v2 - Message ML V2

Returns:

originalFormat

setOriginalFormat

public void setOriginalFormat(String originalFormat)

originalFormat

public V4Message originalFormat(String originalFormat)

getDisclaimer

public String getDisclaimer()

Message that may be sent along with a regular message if configured for the POD, usually the first message sent in a room that day.

Returns:

disclaimer

setDisclaimer

public void setDisclaimer(String disclaimer)

disclaimer

public V4Message disclaimer(String disclaimer)

toString

public String toString()

Overrides:

toString in class Object