com.vonage.client.voice.ncco.VbcEndpoint Maven / Gradle / Ivy

Go to download
/*
 *   Copyright 2024 Vonage
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package com.vonage.client.voice.ncco;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.vonage.client.JsonableBaseObject;
import com.vonage.client.voice.EndpointType;

/**
 * Represents a VBC endpoint used in a {@link ConnectAction}. See
 * 
 * the documentation for an example.
 *
 * @since 7.3.0
 */
public class VbcEndpoint extends JsonableBaseObject implements Endpoint {
    private final String extension;

    private VbcEndpoint(Builder builder) {
        this.extension = builder.extension;
    }

    /**
     * The VBC extension to connect the call to.
     *
     * @return The VBC extension number as a string.
     */
    @JsonProperty("extension")
    public String getExtension() {
        return extension;
    }

    @Override
    public String getType() {
        return EndpointType.VBC.toString();
    }

    /**
     * Entry point for constructing an instance of this class.
     *
     * @param extension The VBC extension number as a string.
     *
     * @return A new Builder.
     */
    public static Builder builder(String extension) {
        return new Builder(extension);
    }

    /**
     * Builder for specifying properties of a VBC endpoint.
     */
    public static class Builder {
        private String extension;

        Builder(String extension) {
            this.extension = extension;
        }

        /**
         * The VBC extension to connect the call to.
         *
         * @param extension The VBC extension number as a string.
         *
         * @return This builder.
         */
        public Builder extension(String extension) {
            this.extension = extension;
            return this;
        }

        /**
         * Builds the VbcEndpoint with this builder's properties.
         *
         * @return A new VbcEndpoint instance.
         */
        public VbcEndpoint build() {
            return new VbcEndpoint(this);
        }
    }
}