Module it.auties.cobalt

Package it.auties.whatsapp.model.message.payment

Class PaymentInvoiceMessage

java.lang.Object

it.auties.whatsapp.model.message.payment.PaymentInvoiceMessage

All Implemented Interfaces:

it.auties.protobuf.model.ProtobufMessage, it.auties.protobuf.model.ProtobufObject, MutableAttachmentProvider<PaymentInvoiceMessage>, ContextualMessage, MediaMessage<PaymentInvoiceMessage>, Message, PaymentMessage

public final class PaymentInvoiceMessage
extends Object
implements PaymentMessage, MediaMessage<PaymentInvoiceMessage>

A model class that represents a message to notify the invoice about a successful payment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PaymentInvoiceMessage.PaymentAttachmentType	The constants of this enumerated type describe the various types of attachment that an invoice can wrap

Field Summary

Fields

Modifier and Type	Field	Description
private final ContextInfo	contextInfo
private String	mediaDirectPath
private byte[]	mediaEncryptedSha256
private byte[]	mediaKey
private Long	mediaKeyTimestampSeconds
private byte[]	mediaSha256
private final String	mimeType
private final String	note
private final PaymentInvoiceMessage.PaymentAttachmentType	paymentAttachmentType
private final byte[]	thumbnail
private final String	token

Constructor Summary

Constructors

Constructor	Description
PaymentInvoiceMessage(String note, String token, PaymentInvoiceMessage.PaymentAttachmentType paymentAttachmentType, String mimeType, byte[] mediaKey, Long mediaKeyTimestampSeconds, byte[] mediaSha256, byte[] mediaEncryptedSha256, String mediaDirectPath, byte[] thumbnail, ContextInfo contextInfo)

Method Summary

Modifier and Type	Method	Description
AttachmentType	attachmentType()	Returns the type of this attachment
MessageCategory	category()	Return message category
Optional<ContextInfo>	contextInfo()
Optional<String>	mediaDirectPath()	Returns the direct path to the media
Optional<byte[]>	mediaEncryptedSha256()	Returns the sha256 of this encrypted media
Optional<byte[]>	mediaKey()	Returns the key of this media
Optional<ZonedDateTime>	mediaKeyTimestamp()	Returns the timestampSeconds forMutableAttachmentProvider.mediaKey()
OptionalLong	mediaKeyTimestampSeconds()	Returns the timestampSeconds, that is the seconds elapsed since Instant.EPOCH, forMutableAttachmentProvider.mediaKey()
Optional<byte[]>	mediaSha256()	Returns the sha256 of this media
OptionalLong	mediaSize()	Returns the size of this media
MediaMessageType	mediaType()	Returns the media type of the media that this object wraps
Optional<String>	mediaUrl()	Returns the url to the media
Optional<String>	mimeType()
Optional<String>	note()
Optional<PaymentInvoiceMessage.PaymentAttachmentType>	paymentAttachmentType()
PaymentInvoiceMessage	setMediaDirectPath(String mediaDirectPath)	Sets the direct path of this provider
PaymentInvoiceMessage	setMediaEncryptedSha256(byte[] bytes)	Sets the sha256 of the encrypted media in this provider
PaymentInvoiceMessage	setMediaKey(byte[] bytes)	Sets the media key of this provider
PaymentInvoiceMessage	setMediaKeyTimestamp(Long timestamp)	Sets the timestamp of the media key
PaymentInvoiceMessage	setMediaSha256(byte[] bytes)	Sets the sha256 of the media in this provider
PaymentInvoiceMessage	setMediaSize(long mediaSize)	Sets the size of this media
PaymentInvoiceMessage	setMediaUrl(String mediaUrl)	Sets the media url of this provider
Optional<byte[]>	thumbnail()
String	token()
MessageType	type()	Return message type

Methods inherited from class java.lang.Object

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

Field Details

note

private final String note

token

private final String token

paymentAttachmentType

private final PaymentInvoiceMessage.PaymentAttachmentType paymentAttachmentType

mimeType

private final String mimeType

mediaKey

private byte[] mediaKey

mediaKeyTimestampSeconds

private Long mediaKeyTimestampSeconds

mediaSha256

private byte[] mediaSha256

mediaEncryptedSha256

private byte[] mediaEncryptedSha256

mediaDirectPath

private String mediaDirectPath

thumbnail

private final byte[] thumbnail

contextInfo

private final ContextInfo contextInfo

Constructor Details

PaymentInvoiceMessage

public PaymentInvoiceMessage(String note,
 String token,
 PaymentInvoiceMessage.PaymentAttachmentType paymentAttachmentType,
 String mimeType,
 byte[] mediaKey,
 Long mediaKeyTimestampSeconds,
 byte[] mediaSha256,
 byte[] mediaEncryptedSha256,
 String mediaDirectPath,
 byte[] thumbnail,
 ContextInfo contextInfo)

Method Details

note

public Optional<String> note()

token

public String token()

thumbnail

public Optional<byte[]> thumbnail()

paymentAttachmentType

public Optional<PaymentInvoiceMessage.PaymentAttachmentType> paymentAttachmentType()

mimeType

public Optional<String> mimeType()

mediaKey

public Optional<byte[]> mediaKey()

Description copied from interface: MutableAttachmentProvider

Returns the key of this media

Specified by:

mediaKey in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a non-null array of bytes

setMediaKey

public PaymentInvoiceMessage setMediaKey(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the media key of this provider

Specified by:

setMediaKey in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

setMediaKeyTimestamp

public PaymentInvoiceMessage setMediaKeyTimestamp(Long timestamp)

Description copied from interface: MutableAttachmentProvider

Sets the timestamp of the media key

Specified by:

setMediaKeyTimestamp in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

mediaKeyTimestampSeconds

public OptionalLong mediaKeyTimestampSeconds()

Description copied from interface: MediaMessage

Returns the timestampSeconds, that is the seconds elapsed since Instant.EPOCH, forMutableAttachmentProvider.mediaKey()

Specified by:

mediaKeyTimestampSeconds in interface MediaMessage<PaymentInvoiceMessage>

Returns:

an unsigned long

mediaKeyTimestamp

public Optional<ZonedDateTime> mediaKeyTimestamp()

Description copied from interface: MediaMessage

Returns the timestampSeconds forMutableAttachmentProvider.mediaKey()

Specified by:

mediaKeyTimestamp in interface MediaMessage<PaymentInvoiceMessage>

Returns:

a zoned date time

mediaSha256

public Optional<byte[]> mediaSha256()

Description copied from interface: MutableAttachmentProvider

Returns the sha256 of this media

Specified by:

mediaSha256 in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a non-null array of bytes

setMediaSha256

public PaymentInvoiceMessage setMediaSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the media in this provider

Specified by:

setMediaSha256 in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

mediaEncryptedSha256

public Optional<byte[]> mediaEncryptedSha256()

Description copied from interface: MutableAttachmentProvider

Returns the sha256 of this encrypted media

Specified by:

mediaEncryptedSha256 in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a non-null array of bytes

setMediaEncryptedSha256

public PaymentInvoiceMessage setMediaEncryptedSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the encrypted media in this provider

Specified by:

setMediaEncryptedSha256 in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

mediaDirectPath

public Optional<String> mediaDirectPath()

Description copied from interface: MutableAttachmentProvider

Returns the direct path to the media

Specified by:

mediaDirectPath in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a nullable String

setMediaDirectPath

public PaymentInvoiceMessage setMediaDirectPath(String mediaDirectPath)

Description copied from interface: MutableAttachmentProvider

Sets the direct path of this provider

Specified by:

setMediaDirectPath in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

mediaUrl

public Optional<String> mediaUrl()

Description copied from interface: MutableAttachmentProvider

Returns the url to the media

Specified by:

mediaUrl in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a nullable String

setMediaUrl

public PaymentInvoiceMessage setMediaUrl(String mediaUrl)

Description copied from interface: MutableAttachmentProvider

Sets the media url of this provider

Specified by:

setMediaUrl in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

the same provider

mediaSize

public OptionalLong mediaSize()

Description copied from interface: MutableAttachmentProvider

Returns the size of this media

Specified by:

mediaSize in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a long

setMediaSize

public PaymentInvoiceMessage setMediaSize(long mediaSize)

Description copied from interface: MutableAttachmentProvider

Sets the size of this media

Specified by:

setMediaSize in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a long

type

public MessageType type()

Description copied from interface: Message

Return message type

Specified by:

type in interface MediaMessage<PaymentInvoiceMessage>

Specified by:

type in interface Message

Returns:

a non-null message type

attachmentType

public AttachmentType attachmentType()

Description copied from interface: MutableAttachmentProvider

Returns the type of this attachment

Specified by:

attachmentType in interface MediaMessage<PaymentInvoiceMessage>

Specified by:

attachmentType in interface MutableAttachmentProvider<PaymentInvoiceMessage>

Returns:

a non-null attachment

mediaType

public MediaMessageType mediaType()

Description copied from interface: MediaMessage

Returns the media type of the media that this object wraps

Specified by:

mediaType in interface MediaMessage<PaymentInvoiceMessage>

Returns:

a non-null MediaMessageType

contextInfo

public Optional<ContextInfo> contextInfo()

Specified by:

contextInfo in interface ContextualMessage

category

public MessageCategory category()

Description copied from interface: Message

Return message category

Specified by:

category in interface MediaMessage<PaymentInvoiceMessage>

Specified by:

category in interface Message

Specified by:

category in interface PaymentMessage

Returns:

a non-null message category