com.adyen.model.nexo.SoundRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
There is a newer version: 28.4.0
Show newest version
package com.adyen.model.nexo;

import io.swagger.v3.oas.annotations.media.Schema;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import java.math.BigInteger;


/**
 * Definition: Content of the Sound Request messageType. -- Usage: It conveys the data to start a sound,  stop a sound, or modify the default sound volume. The sound to play may be a preloaded sound or a text to play.
 *
 * Java class for SoundRequest complex type.
 *
 * 
The following schema fragment specifies the expected content contained within this class.
 *
 * 
 * <complexType name="SoundRequest">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="SoundContent" type="{}SoundContent"/>
 *       </sequence>
 *       <attribute name="ResponseMode" type="{}ResponseModeType" default="NotRequired" />
 *       <attribute name="SoundAction" use="required" type="{}SoundActionType" />
 *       <attribute name="SoundVolume" type="{}SoundVolume" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SoundRequest", propOrder = {
        "soundContent"
})
public class SoundRequest {

    /**
     * The Sound content.
     */
    @XmlElement(name = "SoundContent", required = true)
    @Schema(description = "Content of the Sound to play. --Rule: Absent if SoundAction is SetDefaultVolume, otherwise mandatory.")
    protected SoundContent soundContent;
    /**
     * The Response mode.
     */
    @XmlElement(name = "ResponseMode")
    @Schema(description = "Message response awaited by the initiator of the Request")
    protected ResponseModeType responseMode;
    /**
     * The Sound action.
     */
    @XmlElement(name = "SoundAction", required = true)
    @Schema(description = "Type of action to perform on the sound.")
    protected SoundActionType soundAction;
    /**
     * The Sound volume.
     */
    @XmlElement(name = "SoundVolume")
    @Schema(description = "Volume of a sound, either in a pourcentage of the maximum volume, or 0 to mute. --Rule: Mandatory if SoundAction is SetDefaultVolume")
    protected BigInteger soundVolume;

    /**
     * Gets the value of the soundContent property.
     *
     * @return possible      object is     {@link SoundContent }
     */
    public SoundContent getSoundContent() {
        return soundContent;
    }

    /**
     * Sets the value of the soundContent property.
     *
     * @param value allowed object is     {@link SoundContent }
     */
    public void setSoundContent(SoundContent value) {
        this.soundContent = value;
    }

    /**
     * Gets the value of the responseMode property.
     *
     * @return possible      object is     {@link ResponseModeType }
     */
    public ResponseModeType getResponseMode() {
        if (responseMode == null) {
            return ResponseModeType.NOT_REQUIRED;
        } else {
            return responseMode;
        }
    }

    /**
     * Sets the value of the responseMode property.
     *
     * @param value allowed object is     {@link ResponseModeType }
     */
    public void setResponseMode(ResponseModeType value) {
        this.responseMode = value;
    }

    /**
     * Gets the value of the soundAction property.
     *
     * @return possible      object is     {@link SoundActionType }
     */
    public SoundActionType getSoundAction() {
        return soundAction;
    }

    /**
     * Sets the value of the soundAction property.
     *
     * @param value allowed object is     {@link SoundActionType }
     */
    public void setSoundAction(SoundActionType value) {
        this.soundAction = value;
    }

    /**
     * Gets the value of the soundVolume property.
     *
     * @return possible      object is     {@link BigInteger }
     */
    public BigInteger getSoundVolume() {
        return soundVolume;
    }

    /**
     * Sets the value of the soundVolume property.
     *
     * @param value allowed object is     {@link BigInteger }
     */
    public void setSoundVolume(BigInteger value) {
        this.soundVolume = value;
    }

}