org.whispersystems.signalservice.api.messages

Class SignalServiceEnvelope

java.lang.Object

org.whispersystems.signalservice.api.messages.SignalServiceEnvelope

public class SignalServiceEnvelope
extends java.lang.Object

This class represents an encrypted Signal Service envelope. The envelope contains the wrapping information, such as the sender, the message timestamp, the encrypted message type, etc.

Constructor Summary

Constructors

Constructor and Description
SignalServiceEnvelope(byte[] ciphertext, java.lang.String signalingKey) Construct an envelope from a serialized SignalServiceEnvelope, encrypted with a signaling key.
SignalServiceEnvelope(int type, java.lang.String source, int sourceDevice, java.lang.String relay, long timestamp, byte[] legacyMessage, byte[] content)
SignalServiceEnvelope(java.lang.String message, java.lang.String signalingKey) Construct an envelope from a serialized, Base64 encoded SignalServiceEnvelope, encrypted with a signaling key.

Method Summary

Modifier and Type	Method and Description
byte[]	getContent()
byte[]	getLegacyMessage()
java.lang.String	getRelay()
java.lang.String	getSource()
SignalServiceAddress	getSourceAddress()
int	getSourceDevice()
long	getTimestamp()
int	getType()
boolean	hasContent()
boolean	hasLegacyMessage()
boolean	isPreKeySignalMessage()
boolean	isReceipt()
boolean	isSignalMessage()

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalServiceEnvelope

public SignalServiceEnvelope(java.lang.String message,
                             java.lang.String signalingKey)
                      throws java.io.IOException,
                             org.whispersystems.libsignal.InvalidVersionException

Construct an envelope from a serialized, Base64 encoded SignalServiceEnvelope, encrypted with a signaling key.

Parameters:

message - The serialized SignalServiceEnvelope, base64 encoded and encrypted.

signalingKey - The signaling key.

Throws:

java.io.IOException

org.whispersystems.libsignal.InvalidVersionException

SignalServiceEnvelope

public SignalServiceEnvelope(byte[] ciphertext,
                             java.lang.String signalingKey)
                      throws org.whispersystems.libsignal.InvalidVersionException,
                             java.io.IOException

Construct an envelope from a serialized SignalServiceEnvelope, encrypted with a signaling key.

Parameters:

ciphertext - The serialized and encrypted SignalServiceEnvelope.

signalingKey - The signaling key.

Throws:

org.whispersystems.libsignal.InvalidVersionException

java.io.IOException

SignalServiceEnvelope

public SignalServiceEnvelope(int type,
                             java.lang.String source,
                             int sourceDevice,
                             java.lang.String relay,
                             long timestamp,
                             byte[] legacyMessage,
                             byte[] content)

Method Detail

getSource

public java.lang.String getSource()

Returns:

The envelope's sender.

getSourceDevice

public int getSourceDevice()

Returns:

The envelope's sender device ID.

getSourceAddress

public SignalServiceAddress getSourceAddress()

Returns:

The envelope's sender as a SignalServiceAddress.

getType

public int getType()

Returns:

The envelope content type.

getRelay

public java.lang.String getRelay()

Returns:

The federated server this envelope came from.

getTimestamp

public long getTimestamp()

Returns:

The timestamp this envelope was sent.

hasLegacyMessage

public boolean hasLegacyMessage()

Returns:

Whether the envelope contains a SignalServiceDataMessage

getLegacyMessage

public byte[] getLegacyMessage()

Returns:

The envelope's containing SignalService message.

hasContent

public boolean hasContent()

Returns:

Whether the envelope contains an encrypted SignalServiceContent

getContent

public byte[] getContent()

Returns:

The envelope's encrypted SignalServiceContent.

isSignalMessage

public boolean isSignalMessage()

Returns:

true if the containing message is a SignalMessage

isPreKeySignalMessage

public boolean isPreKeySignalMessage()

Returns:

true if the containing message is a PreKeySignalMessage

isReceipt

public boolean isReceipt()

Returns:

true if the containing message is a delivery receipt.