com.bandwidth.voice.bxml.verbs.Gather Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bandwidth-sdk Show documentation
The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs
There is a newer version: 12.0.0

package com.bandwidth.voice.bxml.verbs;

import lombok.Builder;

import java.net.URI;
import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlType;

/**
 * The Gather verb is used to collect digits for some period of time.
 */
@Builder
@XmlType(name = Gather.TYPE_NAME)
public class Gather implements Verb {
    public static final String TYPE_NAME = "Gather";

    /**
     * (optional) Using the AudioProducer inside the Gather verb will play the media until a digit is received.
     */
    @XmlElements({@XmlElement(name = PlayAudio.TYPE_NAME, type = PlayAudio.class),
                  @XmlElement(name = SpeakSentence.TYPE_NAME, type = SpeakSentence.class)})
    private List audioProducer;


    /**
     * (optional) URL to send Gather event to and request new BXML.
     */
    @XmlAttribute
    private URI gatherUrl;

    /**
     * (optional) he HTTP method to use for the request to gatherUrl. GET or POST. Default value is POST.
     */
    @XmlAttribute
    private Method gatherMethod;

    /**
     * (optional) The username to send in the HTTP request to gatherUrl.
     */
    @XmlAttribute
    protected String username;

    /**
     * (optional) The password to send in the HTTP request to gatherUrl.
     */
    @XmlAttribute
    protected String password;

    /**
     * (optional) A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or cleared.
     * 

     * May be cleared by setting tag=""
     * 

     * Max length 256 characters.
     */
    @XmlAttribute
    private String tag;

    /**
     * (optional) When any of these digits are pressed, it will terminate the Gather. Default value is none.
     */
    @XmlAttribute
    private String terminatingDigits;

    /**
     * (optional) Max number of digits to collect. Default value is 50.
     */
    @XmlAttribute
    private Integer maxDigits;

    /**
     * (optional) Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60.
     */
    @XmlAttribute
    private Double interDigitTimeout;

    /**
     * (optional) Time (in seconds) to pause after any audio from nested  or  verb is played (in seconds) before terminating the Gather. Can use decimal values.
     */
    @XmlAttribute
    private Double firstDigitTimeout;

    /**
     * (optional) The number of times the audio prompt should be repeated if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. The delay between repetitions will be equal to firstDigitTimeout. Default value is 1. Range: 1-25.
     */
    @XmlAttribute
    private Integer repeatCount;

    @XmlAttribute
    protected String fallbackUsername;

    @XmlAttribute
    protected String fallbackPassword;

    @XmlAttribute
    protected URI gatherFallbackUrl;

    @XmlAttribute
    protected Method gatherFallbackMethod;

    public static class GatherBuilder{

        /**
         * (optional) URL to send Gather event to and request new BXML. Converts string using URI.create(url).
         */
        public GatherBuilder gatherUrl(String url){
            return this.gatherUrl(URI.create(url));
        }

        /**
         * (optional) URL to send Gather event to and request new BXML.
         */
        public GatherBuilder gatherUrl(URI url){
            this.gatherUrl = url;
            return this;
        }

        public GatherBuilder gatherFallbackUrl(String url){
            return this.gatherFallbackUrl(URI.create(url));
        }

        public GatherBuilder gatherFallbackUrl(URI url){
            this.gatherFallbackUrl = url;
            return this;
        }

        public GatherBuilder gatherFallbackMethod(String method){
            return this.gatherFallbackMethod(Method.fromValue(method));
        }

        public GatherBuilder gatherFallbackMethod(Method method){
            this.gatherFallbackMethod = method;
            return this;
        }

        /**
         * (optional) Using the AudioProducers inside the Gather verb will play the media(s) until a digit is received.
         */
        public GatherBuilder audioProducer(List audioProducers){
            this.audioProducer = audioProducers;
            return this;
        }

        /**
         * (optional) Using the AudioProducer inside the Gather verb will play the media until a digit is received.
         */
        public GatherBuilder audioProducer(AudioProducer audioProducer){
            List list = new ArrayList<>();
            list.add(audioProducer);
            return this.audioProducer(list);
        }

        /**
         * (optional) he HTTP method to use for the request to gatherUrl. GET or POST. Default value is POST. Converts String to Method using Method.fromValue(method)
         */
        public GatherBuilder gatherMethod(String method){
            return this.gatherMethod(Method.fromValue(method));
        }

        /**
         * (optional) he HTTP method to use for the request to gatherUrl. GET or POST. Default value is POST.
         */
        public GatherBuilder gatherMethod(Method method){
            this.gatherMethod = method;
            return this;
        }
    }

}