Module it.auties.cobalt

Package it.auties.whatsapp.model.button.template.hsm

Record Class HighlyStructuredFourRowTemplate

java.lang.Object

java.lang.Record

it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplate

All Implemented Interfaces:

it.auties.protobuf.model.ProtobufMessage, it.auties.protobuf.model.ProtobufObject, TemplateFormatter

public record HighlyStructuredFourRowTemplate(Optional<DocumentMessage> titleDocument, Optional<HighlyStructuredMessage> titleHighlyStructured, Optional<ImageMessage> titleImage, Optional<VideoOrGifMessage> titleVideo, Optional<LocationMessage> titleLocation, HighlyStructuredMessage content, Optional<HighlyStructuredMessage> footer, List<HighlyStructuredButtonTemplate> buttons)
extends Record
implements TemplateFormatter

A model class that represents a four row template

Nested Class Summary

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

TemplateFormatter.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final List<HighlyStructuredButtonTemplate>	buttons	The field for the buttons record component.
private final HighlyStructuredMessage	content	The field for the content record component.
private final Optional<HighlyStructuredMessage>	footer	The field for the footer record component.
private final Optional<DocumentMessage>	titleDocument	The field for the titleDocument record component.
private final Optional<HighlyStructuredMessage>	titleHighlyStructured	The field for the titleHighlyStructured record component.
private final Optional<ImageMessage>	titleImage	The field for the titleImage record component.
private final Optional<LocationMessage>	titleLocation	The field for the titleLocation record component.
private final Optional<VideoOrGifMessage>	titleVideo	The field for the titleVideo record component.

Constructor Summary

Constructors

Constructor	Description
HighlyStructuredFourRowTemplate(Optional<DocumentMessage> titleDocument, Optional<HighlyStructuredMessage> titleHighlyStructured, Optional<ImageMessage> titleImage, Optional<VideoOrGifMessage> titleVideo, Optional<LocationMessage> titleLocation, HighlyStructuredMessage content, Optional<HighlyStructuredMessage> footer, List<HighlyStructuredButtonTemplate> buttons)	Creates an instance of a HighlyStructuredFourRowTemplate record class.

Method Summary

Modifier and Type	Method	Description
List<HighlyStructuredButtonTemplate>	buttons()	Returns the value of the buttons record component.
HighlyStructuredMessage	content()	Returns the value of the content record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<HighlyStructuredMessage>	footer()	Returns the value of the footer record component.
private static List<HighlyStructuredButtonTemplate>	getIndexedButtons(List<HighlyStructuredButtonTemplate> buttons)
final int	hashCode()	Returns a hash code value for this object.
(package private) static HighlyStructuredFourRowTemplate	simpleBuilder(HighlyStructuredFourRowTemplateTitle title, HighlyStructuredMessage content, HighlyStructuredMessage footer, List<HighlyStructuredButtonTemplate> buttons)
TemplateFormatter.Type	templateType()	Returns the type of this formatter
Optional<? extends HighlyStructuredFourRowTemplateTitle>	title()	Returns the title of this template
Optional<DocumentMessage>	titleDocument()	Returns the value of the titleDocument record component.
Optional<HighlyStructuredMessage>	titleHighlyStructured()	Returns the value of the titleHighlyStructured record component.
Optional<ImageMessage>	titleImage()	Returns the value of the titleImage record component.
Optional<LocationMessage>	titleLocation()	Returns the value of the titleLocation record component.
HighlyStructuredFourRowTemplateTitle.Type	titleType()	Returns the type of title that this template wraps
Optional<VideoOrGifMessage>	titleVideo()	Returns the value of the titleVideo record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

titleDocument

private final Optional<DocumentMessage> titleDocument

The field for the titleDocument record component.

titleHighlyStructured

private final Optional<HighlyStructuredMessage> titleHighlyStructured

The field for the titleHighlyStructured record component.

titleImage

private final Optional<ImageMessage> titleImage

The field for the titleImage record component.

titleVideo

private final Optional<VideoOrGifMessage> titleVideo

The field for the titleVideo record component.

titleLocation

private final Optional<LocationMessage> titleLocation

The field for the titleLocation record component.

content

private final HighlyStructuredMessage content

The field for the content record component.

footer

private final Optional<HighlyStructuredMessage> footer

The field for the footer record component.

buttons

private final List<HighlyStructuredButtonTemplate> buttons

The field for the buttons record component.

Constructor Details

HighlyStructuredFourRowTemplate

public HighlyStructuredFourRowTemplate(Optional<DocumentMessage> titleDocument,
 Optional<HighlyStructuredMessage> titleHighlyStructured,
 Optional<ImageMessage> titleImage,
 Optional<VideoOrGifMessage> titleVideo,
 Optional<LocationMessage> titleLocation,
 HighlyStructuredMessage content,
 Optional<HighlyStructuredMessage> footer,
 List<HighlyStructuredButtonTemplate> buttons)

Creates an instance of a HighlyStructuredFourRowTemplate record class.

Parameters:

titleDocument - the value for the titleDocument record component

titleHighlyStructured - the value for the titleHighlyStructured record component

titleImage - the value for the titleImage record component

titleVideo - the value for the titleVideo record component

titleLocation - the value for the titleLocation record component

content - the value for the content record component

footer - the value for the footer record component

buttons - the value for the buttons record component

Method Details

simpleBuilder

static HighlyStructuredFourRowTemplate simpleBuilder(HighlyStructuredFourRowTemplateTitle title,
 HighlyStructuredMessage content,
 HighlyStructuredMessage footer,
 List<HighlyStructuredButtonTemplate> buttons)

getIndexedButtons

private static List<HighlyStructuredButtonTemplate> getIndexedButtons(List<HighlyStructuredButtonTemplate> buttons)

titleType

public HighlyStructuredFourRowTemplateTitle.Type titleType()

Returns the type of title that this template wraps

Returns:

a non-null title type

title

public Optional<? extends HighlyStructuredFourRowTemplateTitle> title()

Returns the title of this template

Returns:

an optional

templateType

public TemplateFormatter.Type templateType()

Description copied from interface: TemplateFormatter

Returns the type of this formatter

Specified by:

templateType in interface TemplateFormatter

Returns:

a non-null type

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

titleDocument

public Optional<DocumentMessage> titleDocument()

Returns the value of the titleDocument record component.

Returns:

the value of the titleDocument record component

titleHighlyStructured

public Optional<HighlyStructuredMessage> titleHighlyStructured()

Returns the value of the titleHighlyStructured record component.

Returns:

the value of the titleHighlyStructured record component

titleImage

public Optional<ImageMessage> titleImage()

Returns the value of the titleImage record component.

Returns:

the value of the titleImage record component

titleVideo

public Optional<VideoOrGifMessage> titleVideo()

Returns the value of the titleVideo record component.

Returns:

the value of the titleVideo record component

titleLocation

public Optional<LocationMessage> titleLocation()

Returns the value of the titleLocation record component.

Returns:

the value of the titleLocation record component

content

public HighlyStructuredMessage content()

Returns the value of the content record component.

Returns:

the value of the content record component

footer

public Optional<HighlyStructuredMessage> footer()

Returns the value of the footer record component.

Returns:

the value of the footer record component

buttons

public List<HighlyStructuredButtonTemplate> buttons()

Returns the value of the buttons record component.

Returns:

the value of the buttons record component