Module it.auties.cobalt

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

Class ImageMessage

java.lang.Object

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

it.auties.whatsapp.model.message.standard.ImageMessage

All Implemented Interfaces:

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

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

A model class that represents a message holding an image 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 ContextInfo	contextInfo
private final Integer	experimentGroupId
private final Integer	firstScanLength
private final byte[]	firstScanSidecar
private final Integer	height
private final List<InteractiveLocationAnnotation>	interactiveAnnotations
private String	mediaDirectPath
private byte[]	mediaEncryptedSha256
private byte[]	mediaKey
private Long	mediaKeyTimestampSeconds
private byte[]	mediaSha256
private Long	mediaSize
private String	mediaUrl
private final byte[]	midQualityFileEncSha256
private final byte[]	midQualityFileSha256
private final String	mimetype
private final List<Integer>	scanLengths
private final byte[]	scansSidecar
private final String	staticUrl
private final byte[]	thumbnail
private final String	thumbnailDirectPath
private final byte[]	thumbnailEncSha256
private final byte[]	thumbnailSha256
private final boolean	viewOnce
private final Integer	width

Constructor Summary

Constructors

Constructor

Description

ImageMessage(String mediaUrl, String mimetype, String caption, byte[] mediaSha256, Long mediaSize, Integer height, Integer width, byte[] mediaKey, byte[] mediaEncryptedSha256, List<InteractiveLocationAnnotation> interactiveAnnotations, String mediaDirectPath, Long mediaKeyTimestampSeconds, byte[] thumbnail, ContextInfo contextInfo, byte[] firstScanSidecar, Integer firstScanLength, Integer experimentGroupId, byte[] scansSidecar, List<Integer> scanLengths, byte[] midQualityFileSha256, byte[] midQualityFileEncSha256, boolean viewOnce, String thumbnailDirectPath, byte[] thumbnailSha256, byte[] thumbnailEncSha256, String staticUrl)

Method Summary

Modifier and Type	Method	Description
ButtonsMessageHeader.Type	buttonHeaderType()
Optional<String>	caption()
Optional<ContextInfo>	contextInfo()
OptionalInt	experimentGroupId()
OptionalInt	firstScanLength()
Optional<byte[]>	firstScanSidecar()
OptionalInt	height()
HydratedFourRowTemplateTitle.Type	hydratedTitleType()	Return the type of this title
List<InteractiveLocationAnnotation>	interactiveAnnotations()
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<byte[]>	midQualityFileEncSha256()
Optional<byte[]>	midQualityFileSha256()
Optional<String>	mimetype()
List<Integer>	scanLengths()
Optional<byte[]>	scansSidecar()
ImageMessage	setMediaDirectPath(String mediaDirectPath)	Sets the direct path of this provider
ImageMessage	setMediaEncryptedSha256(byte[] bytes)	Sets the sha256 of the encrypted media in this provider
ImageMessage	setMediaKey(byte[] bytes)	Sets the media key of this provider
ImageMessage	setMediaKeyTimestamp(Long timestamp)	Sets the timestamp of the media key
ImageMessage	setMediaSha256(byte[] bytes)	Sets the sha256 of the media in this provider
ImageMessage	setMediaSize(long mediaSize)	Sets the size of this media
ImageMessage	setMediaUrl(String mediaUrl)	Sets the media url of this provider
(package private) static ImageMessage	simpleBuilder(byte[] media, String mimeType, String caption, byte[] thumbnail, ContextInfo contextInfo)	Constructs a new builder to create a ImageMessage.
Optional<String>	staticUrl()
Optional<byte[]>	thumbnail()
Optional<String>	thumbnailDirectPath()
Optional<byte[]>	thumbnailEncSha256()
Optional<byte[]>	thumbnailSha256()
HighlyStructuredFourRowTemplateTitle.Type	titleType()	Return the type of this title
boolean	viewOnce()
OptionalInt	width()

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

attachmentType, category, type

Field Details

mediaUrl

private String mediaUrl

mimetype

private final String mimetype

caption

private final String caption

mediaSha256

private byte[] mediaSha256

mediaSize

private Long mediaSize

height

private final Integer height

width

private final Integer width

mediaKey

private byte[] mediaKey

mediaEncryptedSha256

private byte[] mediaEncryptedSha256

interactiveAnnotations

private final List<InteractiveLocationAnnotation> interactiveAnnotations

mediaDirectPath

private String mediaDirectPath

mediaKeyTimestampSeconds

private Long mediaKeyTimestampSeconds

thumbnail

private final byte[] thumbnail

contextInfo

private final ContextInfo contextInfo

firstScanSidecar

private final byte[] firstScanSidecar

firstScanLength

private final Integer firstScanLength

experimentGroupId

private final Integer experimentGroupId

scansSidecar

private final byte[] scansSidecar

scanLengths

private final List<Integer> scanLengths

midQualityFileSha256

private final byte[] midQualityFileSha256

midQualityFileEncSha256

private final byte[] midQualityFileEncSha256

viewOnce

private final boolean viewOnce

thumbnailDirectPath

private final String thumbnailDirectPath

thumbnailSha256

private final byte[] thumbnailSha256

thumbnailEncSha256

private final byte[] thumbnailEncSha256

staticUrl

private final String staticUrl

Constructor Details

ImageMessage

public ImageMessage(String mediaUrl,
 String mimetype,
 String caption,
 byte[] mediaSha256,
 Long mediaSize,
 Integer height,
 Integer width,
 byte[] mediaKey,
 byte[] mediaEncryptedSha256,
 List<InteractiveLocationAnnotation> interactiveAnnotations,
 String mediaDirectPath,
 Long mediaKeyTimestampSeconds,
 byte[] thumbnail,
 ContextInfo contextInfo,
 byte[] firstScanSidecar,
 Integer firstScanLength,
 Integer experimentGroupId,
 byte[] scansSidecar,
 List<Integer> scanLengths,
 byte[] midQualityFileSha256,
 byte[] midQualityFileEncSha256,
 boolean viewOnce,
 String thumbnailDirectPath,
 byte[] thumbnailSha256,
 byte[] thumbnailEncSha256,
 String staticUrl)

Method Details

simpleBuilder

static ImageMessage simpleBuilder(byte[] media,
 String mimeType,
 String caption,
 byte[] thumbnail,
 ContextInfo contextInfo)

Constructs a new builder to create a ImageMessage. The newsletters can be later sent using Whatsapp.sendMessage(ChatMessageInfo)

Parameters:

media - the non-null image that the new message wraps

mimeType - the mime type of the new message, by default MediaMessageType.defaultMimeType()

caption - the caption of the new message

thumbnail - the thumbnail of the document that the new message wraps

contextInfo - the context info that the new message wraps

Returns:

a non-null new message

mediaUrl

public Optional<String> mediaUrl()

Description copied from interface: MutableAttachmentProvider

Returns the url to the media

Specified by:

mediaUrl in interface MutableAttachmentProvider<ImageMessage>

Returns:

a nullable String

setMediaUrl

public ImageMessage setMediaUrl(String mediaUrl)

Description copied from interface: MutableAttachmentProvider

Sets the media url of this provider

Specified by:

setMediaUrl in interface MutableAttachmentProvider<ImageMessage>

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

Returns:

a nullable String

setMediaDirectPath

public ImageMessage setMediaDirectPath(String mediaDirectPath)

Description copied from interface: MutableAttachmentProvider

Sets the direct path of this provider

Specified by:

setMediaDirectPath in interface MutableAttachmentProvider<ImageMessage>

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

Returns:

a non-null array of bytes

setMediaKey

public ImageMessage setMediaKey(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the media key of this provider

Specified by:

setMediaKey in interface MutableAttachmentProvider<ImageMessage>

Returns:

the same provider

setMediaKeyTimestamp

public ImageMessage setMediaKeyTimestamp(Long timestamp)

Description copied from interface: MutableAttachmentProvider

Sets the timestamp of the media key

Specified by:

setMediaKeyTimestamp in interface MutableAttachmentProvider<ImageMessage>

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

Returns:

a non-null array of bytes

setMediaSha256

public ImageMessage setMediaSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the media in this provider

Specified by:

setMediaSha256 in interface MutableAttachmentProvider<ImageMessage>

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

Returns:

a non-null array of bytes

setMediaEncryptedSha256

public ImageMessage setMediaEncryptedSha256(byte[] bytes)

Description copied from interface: MutableAttachmentProvider

Sets the sha256 of the encrypted media in this provider

Specified by:

setMediaEncryptedSha256 in interface MutableAttachmentProvider<ImageMessage>

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

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

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

Returns:

a zoned date time

setMediaSize

public ImageMessage setMediaSize(long mediaSize)

Description copied from interface: MutableAttachmentProvider

Sets the size of this media

Specified by:

setMediaSize in interface MutableAttachmentProvider<ImageMessage>

Returns:

a long

contextInfo

public Optional<ContextInfo> contextInfo()

Specified by:

contextInfo in interface ContextualMessage

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

Returns:

a non-null MediaMessageType

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

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

buttonHeaderType

public ButtonsMessageHeader.Type buttonHeaderType()

Specified by:

buttonHeaderType in interface ButtonsMessageHeader

mimetype

public Optional<String> mimetype()

caption

public Optional<String> caption()

height

public OptionalInt height()

width

public OptionalInt width()

interactiveAnnotations

public List<InteractiveLocationAnnotation> interactiveAnnotations()

thumbnail

public Optional<byte[]> thumbnail()

firstScanSidecar

public Optional<byte[]> firstScanSidecar()

firstScanLength

public OptionalInt firstScanLength()

experimentGroupId

public OptionalInt experimentGroupId()

scansSidecar

public Optional<byte[]> scansSidecar()

scanLengths

public List<Integer> scanLengths()

midQualityFileSha256

public Optional<byte[]> midQualityFileSha256()

midQualityFileEncSha256

public Optional<byte[]> midQualityFileEncSha256()

viewOnce

public boolean viewOnce()

thumbnailDirectPath

public Optional<String> thumbnailDirectPath()

thumbnailSha256

public Optional<byte[]> thumbnailSha256()

thumbnailEncSha256

public Optional<byte[]> thumbnailEncSha256()

staticUrl

public Optional<String> staticUrl()