it.auties.whatsapp.model.message.button.ListMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of whatsappweb4j Show documentation
Standalone fully-featured Whatsapp Web API for Java and Kotlin
There is a newer version: 3.5.1
package it.auties.whatsapp.model.message.button;

import com.fasterxml.jackson.annotation.JsonCreator;
import it.auties.protobuf.base.ProtobufMessage;
import it.auties.protobuf.base.ProtobufName;
import it.auties.protobuf.base.ProtobufProperty;
import it.auties.whatsapp.model.button.misc.ButtonSection;
import it.auties.whatsapp.model.info.ContextInfo;
import it.auties.whatsapp.model.info.ProductListInfo;
import it.auties.whatsapp.model.message.model.ButtonMessage;
import it.auties.whatsapp.model.message.model.ContextualMessage;
import it.auties.whatsapp.model.message.model.MessageType;
import lombok.*;
import lombok.experimental.Accessors;
import lombok.extern.jackson.Jacksonized;

import java.util.Arrays;
import java.util.List;

import static it.auties.protobuf.base.ProtobufType.MESSAGE;
import static it.auties.protobuf.base.ProtobufType.STRING;

/**
 * A model class that represents a message that contains a list of buttons or a list of products
 */
@AllArgsConstructor
@NoArgsConstructor
@Data
@EqualsAndHashCode(callSuper = true)
@Jacksonized
@Builder
@Accessors(fluent = true)
public final class ListMessage extends ContextualMessage implements ButtonMessage {
    /**
     * The title of this message
     */
    @ProtobufProperty(index = 1, type = STRING)
    private String title;

    /**
     * The description of this message
     */
    @ProtobufProperty(index = 2, type = STRING)
    private String description;

    /**
     * The text of the button of this message
     */
    @ProtobufProperty(index = 3, type = STRING)
    private String button;

    /**
     * The type of this message
     */
    @ProtobufProperty(index = 4, type = MESSAGE, implementation = ListMessage.Type.class)
    private Type listType;

    /**
     * The button sections of this message
     */
    @ProtobufProperty(index = 5, type = MESSAGE, implementation = ButtonSection.class, repeated = true)
    private List sections;

    /**
     * The product info of this message
     */
    @ProtobufProperty(index = 6, type = MESSAGE, implementation = ProductListInfo.class)
    private ProductListInfo productListInfo;

    /**
     * The footer text of this message
     */
    @ProtobufProperty(index = 7, type = STRING)
    private String footer;

    /**
     * The context info of this message
     */
    @ProtobufProperty(index = 8, type = MESSAGE, implementation = ContextInfo.class)
    private ContextInfo contextInfo;

    @Override
    public MessageType type() {
        return MessageType.LIST;
    }

    /**
     * The constants of this enumerated type describe the various types of {@link ListMessage}
     */
    @AllArgsConstructor
    @Accessors(fluent = true)
    @ProtobufName("ListType")
    public enum Type implements ProtobufMessage {
        /**
         * Unknown
         */
        UNKNOWN(0),
        /**
         * Only one option can be selected
         */
        SINGLE_SELECT(1),
        /**
         * A list of products
         */
        PRODUCT_LIST(2);
        
        @Getter
        private final int index;

        @JsonCreator
        public static Type of(int index) {
            return Arrays.stream(values()).filter(entry -> entry.index() == index).findFirst().orElse(null);
        }
    }
}