Module it.auties.whatsapp4j

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

Class HighlyStructuredFourRowTemplate

java.lang.Object

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

All Implemented Interfaces:

it.auties.protobuf.base.ProtobufMessage, TemplateFormatter

public final class HighlyStructuredFourRowTemplate
extends Object
implements TemplateFormatter

A model class that represents a four row template

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HighlyStructuredFourRowTemplate.FourRowTemplateSimpleBuilder
static class	HighlyStructuredFourRowTemplate.HighlyStructuredFourRowTemplateBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private List<HighlyStructuredButtonTemplate>	buttons	The buttons of this row
private HighlyStructuredMessage	content	The content of this row
private HighlyStructuredMessage	footer	The footer of this row
private DocumentMessage	titleDocument	The document title of this row.
private HighlyStructuredMessage	titleHighlyStructured	The highly structured title of this row.
private ImageMessage	titleImage	The image title of this row.
private LocationMessage	titleLocation	The location title of this row.
private VideoMessage	titleVideo	The video title of this row This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.VIDEO.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HighlyStructuredFourRowTemplate()
	HighlyStructuredFourRowTemplate(DocumentMessage titleDocument, HighlyStructuredMessage titleHighlyStructured, ImageMessage titleImage, VideoMessage titleVideo, LocationMessage titleLocation, HighlyStructuredMessage content, HighlyStructuredMessage footer, List<HighlyStructuredButtonTemplate> buttons)

Method Summary

Modifier and Type	Method	Description
static HighlyStructuredFourRowTemplate.HighlyStructuredFourRowTemplateBuilder	builder()
List<HighlyStructuredButtonTemplate>	buttons()	The buttons of this row
HighlyStructuredFourRowTemplate	buttons(List<HighlyStructuredButtonTemplate> buttons)	The buttons of this row
HighlyStructuredMessage	content()	The content of this row
HighlyStructuredFourRowTemplate	content(HighlyStructuredMessage content)	The content of this row
private static HighlyStructuredFourRowTemplate	customBuilder(HighlyStructuredFourRowTemplateTitle title, HighlyStructuredMessage content, HighlyStructuredMessage footer, List<HighlyStructuredButtonTemplate> buttons)	Constructs a new builder to create a four row template
boolean	equals(Object o)
HighlyStructuredMessage	footer()	The footer of this row
HighlyStructuredFourRowTemplate	footer(HighlyStructuredMessage footer)	The footer of this row
int	hashCode()
static HighlyStructuredFourRowTemplate	of()
static HighlyStructuredFourRowTemplate.FourRowTemplateSimpleBuilder	simpleBuilder()
TemplateFormatterType	templateType()	Returns the type of this formatter
Optional<HighlyStructuredFourRowTemplateTitle>	title()	Returns the title of this template
Optional<DocumentMessage>	titleDocument()	Returns the document title of this message if present
HighlyStructuredFourRowTemplate	titleDocument(DocumentMessage titleDocument)	The document title of this row.
Optional<HighlyStructuredMessage>	titleHighlyStructured()	Returns the highly structured title of this message if present
HighlyStructuredFourRowTemplate	titleHighlyStructured(HighlyStructuredMessage titleHighlyStructured)	The highly structured title of this row.
Optional<ImageMessage>	titleImage()	Returns the image title of this message if present
HighlyStructuredFourRowTemplate	titleImage(ImageMessage titleImage)	The image title of this row.
Optional<LocationMessage>	titleLocation()	Returns the location title of this message if present
HighlyStructuredFourRowTemplate	titleLocation(LocationMessage titleLocation)	The location title of this row.
HighlyStructuredFourRowTemplateTitleType	titleType()	Returns the type of title that this template wraps
Optional<VideoMessage>	titleVideo()	Returns the video title of this message if present
HighlyStructuredFourRowTemplate	titleVideo(VideoMessage titleVideo)	The video title of this row This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.VIDEO.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

titleDocument

private DocumentMessage titleDocument

The document title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.DOCUMENT.

titleHighlyStructured

private HighlyStructuredMessage titleHighlyStructured

The highly structured title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.HIGHLY_STRUCTURED.

titleImage

private ImageMessage titleImage

The image title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.IMAGE.

titleVideo

private VideoMessage titleVideo

The video title of this row This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.VIDEO.

titleLocation

private LocationMessage titleLocation

The location title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.LOCATION.

content

private HighlyStructuredMessage content

The content of this row

footer

private HighlyStructuredMessage footer

The footer of this row

buttons

private List<HighlyStructuredButtonTemplate> buttons

The buttons of this row

Constructor Details

HighlyStructuredFourRowTemplate

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

HighlyStructuredFourRowTemplate

private HighlyStructuredFourRowTemplate()

Method Details

customBuilder

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

Constructs a new builder to create a four row template

Parameters:

content - the content of this template

footer - the footer of this template

buttons - the buttons of this template

Returns:

a non-null new template

titleType

public HighlyStructuredFourRowTemplateTitleType titleType()

Returns the type of title that this template wraps

Returns:

a non-null title type

title

public Optional<HighlyStructuredFourRowTemplateTitle> title()

Returns the title of this template

Returns:

an optional

titleDocument

public Optional<DocumentMessage> titleDocument()

Returns the document title of this message if present

Returns:

an optional

titleHighlyStructured

public Optional<HighlyStructuredMessage> titleHighlyStructured()

Returns the highly structured title of this message if present

Returns:

an optional

titleImage

public Optional<ImageMessage> titleImage()

Returns the image title of this message if present

Returns:

an optional

titleVideo

public Optional<VideoMessage> titleVideo()

Returns the video title of this message if present

Returns:

an optional

titleLocation

public Optional<LocationMessage> titleLocation()

Returns the location title of this message if present

Returns:

an optional

templateType

public TemplateFormatterType templateType()

Description copied from interface: TemplateFormatter

Returns the type of this formatter

Specified by:

templateType in interface TemplateFormatter

Returns:

a non-null type

builder

public static HighlyStructuredFourRowTemplate.HighlyStructuredFourRowTemplateBuilder builder()

simpleBuilder

public static HighlyStructuredFourRowTemplate.FourRowTemplateSimpleBuilder simpleBuilder()

of

public static HighlyStructuredFourRowTemplate of()

content

public HighlyStructuredMessage content()

The content of this row

footer

public HighlyStructuredMessage footer()

The footer of this row

buttons

public List<HighlyStructuredButtonTemplate> buttons()

The buttons of this row

titleDocument

public HighlyStructuredFourRowTemplate titleDocument(DocumentMessage titleDocument)

The document title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.DOCUMENT.

Returns:

this.

titleHighlyStructured

public HighlyStructuredFourRowTemplate titleHighlyStructured(HighlyStructuredMessage titleHighlyStructured)

The highly structured title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.HIGHLY_STRUCTURED.

Returns:

this.

titleImage

public HighlyStructuredFourRowTemplate titleImage(ImageMessage titleImage)

The image title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.IMAGE.

Returns:

this.

titleVideo

public HighlyStructuredFourRowTemplate titleVideo(VideoMessage titleVideo)

The video title of this row This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.VIDEO.

Returns:

this.

titleLocation

public HighlyStructuredFourRowTemplate titleLocation(LocationMessage titleLocation)

The location title of this row. This property is defined only if titleType() == HighlyStructuredFourRowTemplateTitleType.LOCATION.

Returns:

this.

content

public HighlyStructuredFourRowTemplate content(HighlyStructuredMessage content)

The content of this row

Returns:

this.

footer

public HighlyStructuredFourRowTemplate footer(HighlyStructuredMessage footer)

The footer of this row

Returns:

this.

buttons

public HighlyStructuredFourRowTemplate buttons(List<HighlyStructuredButtonTemplate> buttons)

The buttons of this row

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object