001/*
002 * Copyright 2024 Vonage
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package com.vonage.client.voice;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020
021/**
022 * Represents the DTMF event results in {@link EventWebhook#getDtmf()}.
023 */
024public class DtmfResult extends JsonableBaseObject {
025    private String digits;
026    private boolean timedOut;
027
028    /**
029     * The button sequence pressed by the user.
030     *
031     * @return The buttons pressed as a String.
032     */
033    @JsonProperty("digits")
034    public String getDigits() {
035        return digits;
036    }
037
038    /**
039     * Whether the DTMF input timed out.
040     *
041     * @return {@code true} if the DTMF timed out, {@code false} otherwise.
042     */
043    @JsonProperty("timed_out")
044    public boolean isTimedOut() {
045        return timedOut;
046    }
047}