• Home
• com.sap.cloud.s4hana.services
• recast-ai
• 2.22.0
• source code
• ButtonResponse.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.

com.sap.cloud.sdk.services.recastai.botresponses.ButtonResponse Maven / Gradle / Ivy

/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.services.recastai.botresponses;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.google.common.annotations.Beta;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

/**
 * Represents all different types of button responses. They include Quick Replies and ButtonResponse. Each of them can
 * be different types of buttons. Including phonenumber, a web url and a reply.
 */
@Beta
public class ButtonResponse implements ResponseInterface
{
    @SerializedName( "type" )
    @Expose
    private String type = "buttons";

    @SerializedName( "content" )
    @Expose
    private ButtonCollection content;

    /**
     * Assumes buttons as a type - full button style instead of quick replies.
     * 
     * @param content
     *            the ButtonCollection to be sent as content of this buttonresponse.
     */
    public ButtonResponse( @Nonnull final ButtonCollection content )
    {
        this.content = content;
    }

    /**
     * Create a response with only POSTBACK buttons.
     *
     * @param content
     *            the buttons to set. Don't use Button type buttons.
     * @return the new response
     */
    @Nonnull
    public static ButtonResponse createForQuickReplies( @Nonnull final ButtonCollection content )
    {
        return new ButtonResponse("quickReplies", content);
    }

    /**
     * Create a button response with complex buttons which allow visiting web urls or dial phone numbers, on top of the
     * regular postback feature.
     *
     * @param content
     *            the buttons.
     * @return the new response
     */
    @Nonnull
    public static ButtonResponse createForFullButtons( @Nonnull final ButtonCollection content )
    {
        return new ButtonResponse("buttons", content);
    }

    /**
     * Allows to set type to either quickReplies or buttons.
     * 
     * @param buttonResponseType
     *            one of buttons or quickReplies
     * @param content
     *            a button collection with all buttons to be sent back
     */
    public ButtonResponse( @Nonnull final String buttonResponseType, @Nonnull final ButtonCollection content )
    {
        type = buttonResponseType;
        this.content = content;
    }

    /**
     * This Function returns the button collection of this response.
     * 
     * @return a ButtonCollection object
     */
    @Nullable
    public ButtonCollection getContent()
    {
        return content;
    }

    /**
     * Sets the content of the button collection to the given one.
     * 
     * @param content
     *            the new ButtonCollection
     */
    public void setContent( @Nonnull final ButtonCollection content )
    {
        this.content = content;
    }

    /**
     * Returns the type of this button response
     * 
     * @return a string representation of the ButtonResponseTypes enums
     */
    @Nullable
    @Override
    public String getType()
    {
        return type;
    }
}