• Home
• net.optionfactory
• whatsapp-business-java-dto
• 1.0.0
• source code
• Action.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.optionfactory.whatsapp.dto.messages.Action Maven / Gradle / Ivy

package net.optionfactory.whatsapp.dto.messages;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.ArrayList;
import java.util.List;

/**
 * 

 *  
 
 button - Required for List Messages - It cannot be an empty string and must be unique within the message.
 *  Emojis are supported, markdown is not. Maximum length: 20 characters
 *
 *  
 
 buttons - Required for Reply Buttons - A button object can contain the following parameters:
 *      

 *         
type: only supported type is reply (for Reply Button)
 *         
title: Button title. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 characters.
 *         
id: Unique identifier for your button. This ID is returned in the webhook when the button is clicked by the user. Maximum length: 256 characters.
 *      
 *       
You can have up to 3 buttons. You cannot have leading or trailing spaces when setting the ID.
 *
 *  
 catalog_id - Required for Single Product Messages and Multi-Product Messages - Unique identifier of the
 *  Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via the Meta Commerce Manager.
 *
 *  
 product_retailer_id - Required for Single Product Messages and Multi-Product Messages - Unique identifier of the product in a catalog.
 *      
 To get this ID go to Meta Commerce Manager and select your Meta Business account. You will see a list of shops connected to your account.
 *      Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention.
 *      The ID for that item is displayed under the item's name.
 *
 *  
 sections - Required for List Messages and Multi-Product Messages - Array of section objects. Minimum of 1, maximum of 10. See section object.
 * 
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Action {

    @JsonProperty("catalog_id")
    private String catalogId;
    @JsonProperty("product_retailer_id")
    private String productRetailerId;
    @JsonProperty("button")
    private String buttonText;
    @JsonProperty("buttons")
    private List buttons;
    @JsonProperty("sections")
    private List
 sections;

    /**
     * Gets catalog id.
     *
     * @return the catalog id
     */
    public String getCatalogId() {
        return catalogId;
    }

    /**
     * Sets catalog id.
     *
     * @param catalogId Required for Single Product Messages and Multi-Product Messages - Unique identifier of the                  Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via the Meta Commerce Manager.
     * @return the catalog id
     */
    public Action setCatalogId(String catalogId) {
        this.catalogId = catalogId;
        return this;
    }

    /**
     * Gets product retailer id.
     *
     * @return the product retailer id
     */
    public String getProductRetailerId() {
        return productRetailerId;
    }

    /**
     * Sets product retailer id.
     *
     * @param productRetailerId the product retailer id
     * @return the product retailer id
     */
    public Action setProductRetailerId(String productRetailerId) {
        this.productRetailerId = productRetailerId;
        return this;
    }

    /**
     * Gets button text.
     *
     * @return the button text
     */
    public String getButtonText() {
        return buttonText;
    }

    /**
     * Sets button text.
     *
     * @param buttonText the button text
     * @return the button text
     */
    public Action setButtonText(String buttonText) {
        this.buttonText = buttonText;
        return this;
    }

    /**
     * Gets buttons.
     *
     * @return the buttons
     */
    public List getButtons() {
        return buttons;
    }

    /**
     * Sets buttons.
     *
     * @param buttons the buttons
     * @return the buttons
     */
    public Action setButtons(List buttons) {
        this.buttons = buttons;
        return this;
    }

    /**
     * Add button action.
     *
     * @param button the type {@link Button}
     * @return the action
     */
    public Action addButton(Button button) {
        if (this.buttons == null) this.buttons = new ArrayList<>();

        this.buttons.add(button);
        return this;
    }

    /**
     * Gets sections.
     *
     * @return the sections
     */
    public List
 getSections() {
        return sections;
    }

    /**
     * Sets sections.
     *
     * @param sections List of @{@link Section}
     * @return the sections
     */
    public Action setSections(List
 sections) {
        this.sections = sections;
        return this;
    }

    /**
     * Add section action.
     *
     * @param section the section
     * @return the action
     */
    public Action addSection(Section section) {
        if (this.sections == null) this.sections = new ArrayList<>();

        this.sections.add(section);
        return this;
    }
}