org.whispersystems.signalservice.api.messages

Class SignalServiceDataMessage

java.lang.Object

org.whispersystems.signalservice.api.messages.SignalServiceDataMessage

public class SignalServiceDataMessage
extends java.lang.Object

Represents a decrypted Signal Service data message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignalServiceDataMessage.Builder

Constructor Summary

Constructors

Constructor and Description
SignalServiceDataMessage(long timestamp, java.util.List<SignalServiceAttachment> attachments, java.lang.String body) Construct a SignalServiceDataMessage with a body and list of attachments.
SignalServiceDataMessage(long timestamp, java.util.List<SignalServiceAttachment> attachments, java.lang.String body, int expiresInSeconds) Construct an expiring SignalServiceDataMessage with a body and list of attachments.
SignalServiceDataMessage(long timestamp, SignalServiceAttachment attachment, java.lang.String body)
SignalServiceDataMessage(long timestamp, SignalServiceGroup group, java.util.List<SignalServiceAttachment> attachments, java.lang.String body) Construct a SignalServiceDataMessage group message with attachments and body.
SignalServiceDataMessage(long timestamp, SignalServiceGroup group, java.util.List<SignalServiceAttachment> attachments, java.lang.String body, boolean endSession, int expiresInSeconds, boolean expirationUpdate) Construct a SignalServiceDataMessage.
SignalServiceDataMessage(long timestamp, SignalServiceGroup group, java.util.List<SignalServiceAttachment> attachments, java.lang.String body, int expiresInSeconds) Construct an expiring SignalServiceDataMessage group message with attachments and body.
SignalServiceDataMessage(long timestamp, java.lang.String body) Construct a SignalServiceDataMessage with a body and no attachments.
SignalServiceDataMessage(long timestamp, java.lang.String body, int expiresInSeconds) Construct an expiring SignalServiceDataMessage with a body and no attachments.

Method Summary

Modifier and Type	Method and Description
org.whispersystems.libsignal.util.guava.Optional<java.util.List<SignalServiceAttachment>>	getAttachments()
org.whispersystems.libsignal.util.guava.Optional<java.lang.String>	getBody()
int	getExpiresInSeconds()
org.whispersystems.libsignal.util.guava.Optional<SignalServiceGroup>	getGroupInfo()
long	getTimestamp()
boolean	isEndSession()
boolean	isExpirationUpdate()
boolean	isGroupUpdate()
static SignalServiceDataMessage.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                java.lang.String body)

Construct a SignalServiceDataMessage with a body and no attachments.

Parameters:

timestamp - The sent timestamp.

body - The message contents.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                java.lang.String body,
                                int expiresInSeconds)

Construct an expiring SignalServiceDataMessage with a body and no attachments.

Parameters:

timestamp - The sent timestamp.

body - The message contents.

expiresInSeconds - The number of seconds in which the message should expire after having been seen.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                SignalServiceAttachment attachment,
                                java.lang.String body)

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                java.util.List<SignalServiceAttachment> attachments,
                                java.lang.String body)

Construct a SignalServiceDataMessage with a body and list of attachments.

Parameters:

timestamp - The sent timestamp.

attachments - The attachments.

body - The message contents.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                java.util.List<SignalServiceAttachment> attachments,
                                java.lang.String body,
                                int expiresInSeconds)

Construct an expiring SignalServiceDataMessage with a body and list of attachments.

Parameters:

timestamp - The sent timestamp.

attachments - The attachments.

body - The message contents.

expiresInSeconds - The number of seconds in which the message should expire after having been seen.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                SignalServiceGroup group,
                                java.util.List<SignalServiceAttachment> attachments,
                                java.lang.String body)

Construct a SignalServiceDataMessage group message with attachments and body.

Parameters:

timestamp - The sent timestamp.

group - The group information.

attachments - The attachments.

body - The message contents.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                SignalServiceGroup group,
                                java.util.List<SignalServiceAttachment> attachments,
                                java.lang.String body,
                                int expiresInSeconds)

Construct an expiring SignalServiceDataMessage group message with attachments and body.

Parameters:

timestamp - The sent timestamp.

group - The group information.

attachments - The attachments.

body - The message contents.

expiresInSeconds - The number of seconds in which a message should disappear after having been seen.

SignalServiceDataMessage

public SignalServiceDataMessage(long timestamp,
                                SignalServiceGroup group,
                                java.util.List<SignalServiceAttachment> attachments,
                                java.lang.String body,
                                boolean endSession,
                                int expiresInSeconds,
                                boolean expirationUpdate)

Construct a SignalServiceDataMessage.

Parameters:

timestamp - The sent timestamp.

group - The group information (or null if none).

attachments - The attachments (or null if none).

body - The message contents.

endSession - Flag indicating whether this message should close a session.

expiresInSeconds - Number of seconds in which the message should disappear after being seen.

Method Detail

newBuilder

public static SignalServiceDataMessage.Builder newBuilder()

getTimestamp

public long getTimestamp()

Returns:

The message timestamp.

getAttachments

public org.whispersystems.libsignal.util.guava.Optional<java.util.List<SignalServiceAttachment>> getAttachments()

Returns:

The message attachments (if any).

getBody

public org.whispersystems.libsignal.util.guava.Optional<java.lang.String> getBody()

Returns:

The message body (if any).

getGroupInfo

public org.whispersystems.libsignal.util.guava.Optional<SignalServiceGroup> getGroupInfo()

Returns:

The message group info (if any).

isEndSession

public boolean isEndSession()

isExpirationUpdate

public boolean isExpirationUpdate()

isGroupUpdate

public boolean isGroupUpdate()

getExpiresInSeconds

public int getExpiresInSeconds()