Module it.auties.cobalt

Package it.auties.whatsapp.model.message.standard

Class DocumentMessage

java.lang.Object

it.auties.whatsapp.model.message.model.reserved.ExtendedMediaMessage<DocumentMessage>

it.auties.whatsapp.model.message.standard.DocumentMessage

All Implemented Interfaces:

it.auties.protobuf.model.ProtobufMessage, it.auties.protobuf.model.ProtobufObject, InteractiveHeaderAttachment, HighlyStructuredFourRowTemplateTitle, HydratedFourRowTemplateTitle, MutableAttachmentProvider<DocumentMessage>, ButtonsMessageHeader, ContextualMessage<DocumentMessage>, MediaMessage<DocumentMessage>, Message

public final class DocumentMessage
extends it.auties.whatsapp.model.message.model.reserved.ExtendedMediaMessage<DocumentMessage>
implements MediaMessage<DocumentMessage>, InteractiveHeaderAttachment, ButtonsMessageHeader, HighlyStructuredFourRowTemplateTitle, HydratedFourRowTemplateTitle

A model class that represents a message holding a document inside

Nested Class Summary

Nested classes/interfaces inherited from interface it.auties.whatsapp.model.message.button.ButtonsMessageHeader

ButtonsMessageHeader.Type

Nested classes/interfaces inherited from interface it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplateTitle

HighlyStructuredFourRowTemplateTitle.Type

Nested classes/interfaces inherited from interface it.auties.whatsapp.model.button.template.hydrated.HydratedFourRowTemplateTitle

HydratedFourRowTemplateTitle.Type

Nested classes/interfaces inherited from interface it.auties.whatsapp.model.button.interactive.InteractiveHeaderAttachment

InteractiveHeaderAttachment.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final String	caption
private final boolean	contactVcard
private ContextInfo	contextInfo
private final String	fileName
private String	mediaDirectPath
private byte[]	mediaEncryptedSha256
private byte[]	mediaKey
private Long	mediaKeyTimestampSeconds
private byte[]	mediaSha256
private Long	mediaSize
private String	mediaUrl
private final String	mimetype
private final Integer	pageCount
private final byte[]	thumbnail
private final String	thumbnailDirectPath
private final byte[]	thumbnailEncSha256
private final Integer	thumbnailHeight
private final byte[]	thumbnailSha256
private final Integer	thumbnailWidth
private final String	title

Constructor Summary

Constructors

Constructor

Description

DocumentMessage(String mediaUrl, String mimetype, String title, byte[] mediaSha256, Long mediaSize, Integer pageCount, byte[] mediaKey, String fileName, byte[] mediaEncryptedSha256, String mediaDirectPath, Long mediaKeyTimestampSeconds, byte[] thumbnail, boolean contactVcard, String thumbnailDirectPath, byte[] thumbnailSha256, byte[] thumbnailEncSha256, ContextInfo contextInfo, Integer thumbnailHeight, Integer thumbnailWidth, String caption)

Method Summary

Modifier and Type	Method	Description
AttachmentType	attachmentType()	Returns the type of this attachment
ButtonsMessageHeader.Type	buttonHeaderType()
Optional<String>	caption()
boolean	contactVcard()
Optional<ContextInfo>	contextInfo()
(package private) static DocumentMessage	customBuilder(byte[] media, String fileName, String mimeType, String title, int pageCount, byte[] thumbnail, ContextInfo contextInfo)
Optional<String>	fileName()
private static String	getMimeType(byte[] media, String fileName, String mimeType)
HydratedFourRowTemplateTitle.Type	hydratedTitleType()	Return the type of this title
InteractiveHeaderAttachment.Type	interactiveHeaderType()
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()
OptionalInt	pageCount()
DocumentMessage	setContextInfo(ContextInfo contextInfo)
DocumentMessage	setMediaDirectPath(String mediaDirectPath)	Sets the direct path of this provider
DocumentMessage	setMediaEncryptedSha256(byte[] bytes)	Sets the sha256 of the encrypted media in this provider
DocumentMessage	setMediaKey(byte[] bytes)	Sets the media key of this provider
DocumentMessage	setMediaKeyTimestamp(Long timestamp)	Sets the timestamp of the media key
DocumentMessage	setMediaSha256(byte[] bytes)	Sets the sha256 of the media in this provider
DocumentMessage	setMediaSize(long mediaSize)	Sets the size of this media
DocumentMessage	setMediaUrl(String mediaUrl)	Sets the media url of this provider
Optional<byte[]>	thumbnail()
Optional<String>	thumbnailDirectPath()
Optional<byte[]>	thumbnailEncSha256()
OptionalInt	thumbnailHeight()
Optional<byte[]>	thumbnailSha256()
OptionalInt	thumbnailWidth()
Optional<String>	title()
HighlyStructuredFourRowTemplateTitle.Type	titleType()	Return the type of this title

Methods inherited from class it.auties.whatsapp.model.message.model.reserved.ExtendedMediaMessage

decodedMedia, handle, setDecodedMedia, setHandle

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.auties.whatsapp.model.message.model.MediaMessage

category, type

Field Details

mediaUrl

private String mediaUrl

mimetype

private final String mimetype

title

private final String title

mediaSha256

private byte[] mediaSha256

mediaSize

private Long mediaSize

pageCount

private final Integer pageCount

mediaKey

private byte[] mediaKey

fileName

private final String fileName

mediaEncryptedSha256

private byte[] mediaEncryptedSha256

mediaDirectPath

private String mediaDirectPath

mediaKeyTimestampSeconds

private Long mediaKeyTimestampSeconds

thumbnail

private final byte[] thumbnail

contactVcard

private final boolean contactVcard

thumbnailDirectPath

private final String thumbnailDirectPath

thumbnailSha256

private final byte[] thumbnailSha256

thumbnailEncSha256

private final byte[] thumbnailEncSha256

contextInfo

private ContextInfo contextInfo

thumbnailHeight

private final Integer thumbnailHeight

thumbnailWidth

private final Integer thumbnailWidth

caption

private final String caption

Constructor Details

DocumentMessage

public DocumentMessage(String mediaUrl,
 String mimetype,
 String title,
 byte[] mediaSha256,
 Long mediaSize,
 Integer pageCount,
 byte[] mediaKey,
 String fileName,
 byte[] mediaEncryptedSha256,
 String mediaDirectPath,
 Long mediaKeyTimestampSeconds,
 byte[] thumbnail,
 boolean contactVcard,
 String thumbnailDirectPath,
 byte[] thumbnailSha256,
 byte[] thumbnailEncSha256,
 ContextInfo contextInfo,
 Integer thumbnailHeight,
 Integer thumbnailWidth,
 String caption)

Method Details

customBuilder

static DocumentMessage customBuilder(byte[] media,
 String fileName,
 String mimeType,
 String title,
 int pageCount,
 byte[] thumbnail,
 ContextInfo contextInfo)

getMimeType

private static String getMimeType(byte[] media,
 String fileName,
 String mimeType)

pageCount

public OptionalInt pageCount()

title

public Optional<String> title()

fileName

public Optional<String> fileName()

contactVcard

public boolean contactVcard()

caption

public Optional<String> caption()

mediaUrl

public Optional<String> mediaUrl()

Description copied from interface: MutableAttachmentProvider

Returns the url to the media

Specified by:

mediaUrl in interface MutableAttachmentProvider<DocumentMessage>

Returns:

a nullable String

setMediaUrl

public DocumentMessage setMediaUrl(String mediaUrl)

Description copied from interface: MutableAttachmentProvider

Sets the media url of this provider

Specified by:

setMediaUrl in interface MutableAttachmentProvider<DocumentMessage>

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<DocumentMessage>

Returns:

a nullable String

setMediaDirectPath

public DocumentMessage setMediaDirectPath(String mediaDirectPath)

Description copied from interface: MutableAttachmentProvider

Sets the direct path of this provider

Specified by:

setMediaDirectPath in interface MutableAttachmentProvider<DocumentMessage>

Returns:

the same provider

mediaKey

public Optional<byte[]> mediaKey()

Description copied from interface: MutableAttachmentProvider

Returns the key of this media

Specified by:

mediaKey in interface MutableAttachmentProvider<DocumentMessage>

Returns:

a non-null array of bytes

setMediaKey

public DocumentMessage setMediaKey(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the media key of this provider

Specified by:

setMediaKey in interface MutableAttachmentProvider<DocumentMessage>

Returns:

the same provider

setMediaKeyTimestamp

public DocumentMessage setMediaKeyTimestamp(Long timestamp)

Description copied from interface: MutableAttachmentProvider

Sets the timestamp of the media key

Specified by:

setMediaKeyTimestamp in interface MutableAttachmentProvider<DocumentMessage>

Returns:

the same provider

mediaSha256

public Optional<byte[]> mediaSha256()

Description copied from interface: MutableAttachmentProvider

Returns the sha256 of this media

Specified by:

mediaSha256 in interface MutableAttachmentProvider<DocumentMessage>

Returns:

a non-null array of bytes

setMediaSha256

public DocumentMessage setMediaSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the media in this provider

Specified by:

setMediaSha256 in interface MutableAttachmentProvider<DocumentMessage>

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<DocumentMessage>

Returns:

a non-null array of bytes

setMediaEncryptedSha256

public DocumentMessage setMediaEncryptedSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the encrypted media in this provider

Specified by:

setMediaEncryptedSha256 in interface MutableAttachmentProvider<DocumentMessage>

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<DocumentMessage>

Returns:

a long

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<DocumentMessage>

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<DocumentMessage>

Returns:

a zoned date time

setMediaSize

public DocumentMessage setMediaSize(long mediaSize)

Description copied from interface: MutableAttachmentProvider

Sets the size of this media

Specified by:

setMediaSize in interface MutableAttachmentProvider<DocumentMessage>

Returns:

a long

contextInfo

public Optional<ContextInfo> contextInfo()

Specified by:

contextInfo in interface ContextualMessage<DocumentMessage>

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<DocumentMessage>

Returns:

a non-null MediaMessageType

attachmentType

public AttachmentType attachmentType()

Description copied from interface: MutableAttachmentProvider

Returns the type of this attachment

Specified by:

attachmentType in interface MediaMessage<DocumentMessage>

Specified by:

attachmentType in interface MutableAttachmentProvider<DocumentMessage>

Returns:

a non-null attachment

titleType

public HighlyStructuredFourRowTemplateTitle.Type titleType()

Description copied from interface: HighlyStructuredFourRowTemplateTitle

Return the type of this title

Specified by:

titleType in interface HighlyStructuredFourRowTemplateTitle

Returns:

a non-null type

buttonHeaderType

public ButtonsMessageHeader.Type buttonHeaderType()

Specified by:

buttonHeaderType in interface ButtonsMessageHeader

hydratedTitleType

public HydratedFourRowTemplateTitle.Type hydratedTitleType()

Description copied from interface: HydratedFourRowTemplateTitle

Return the type of this title

Specified by:

hydratedTitleType in interface HydratedFourRowTemplateTitle

Returns:

a non-null type

interactiveHeaderType

public InteractiveHeaderAttachment.Type interactiveHeaderType()

Specified by:

interactiveHeaderType in interface InteractiveHeaderAttachment

mimetype

public Optional<String> mimetype()

thumbnail

public Optional<byte[]> thumbnail()

thumbnailDirectPath

public Optional<String> thumbnailDirectPath()

thumbnailSha256

public Optional<byte[]> thumbnailSha256()

thumbnailEncSha256

public Optional<byte[]> thumbnailEncSha256()

thumbnailHeight

public OptionalInt thumbnailHeight()

thumbnailWidth

public OptionalInt thumbnailWidth()

setContextInfo

public DocumentMessage setContextInfo(ContextInfo contextInfo)

Specified by:

setContextInfo in interface ContextualMessage<DocumentMessage>