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.ncco;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Represents the input mode for {@link InputAction}.
023 *
024 * @since 8.12.0
025 */
026public enum InputMode {
027    /**
028     * Process input synchronously (the default). This is the standard behaviour if not set.
029     */
030    SYNCHRONOUS,
031
032    /**
033     * Process input asynchronously. For DTMF, this means that the input is sent to the event URL webhook one digit
034     * at a time. Consequently, the {@link DtmfSettings} are ignored.
035     */
036    ASYNCHRONOUS;
037
038    @JsonValue
039    @Override
040    public String toString() {
041        return name().toLowerCase();
042    }
043
044    @JsonCreator
045    public static InputMode fromString(String name) {
046        if (name == null) return null;
047        try {
048            return InputMode.valueOf(name.toUpperCase());
049        }
050        catch (IllegalArgumentException ex) {
051            return null;
052        }
053    }
054}