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.messages;
017
018/**
019 * Convenience interface to indicate that {@link MessageRequest#getMessageType()} is {@link MessageType#TEXT}.
020 *
021 * @since 8.11.0
022 */
023public interface TextMessageRequest {
024
025    /**
026     * Get the {@code text} field of the message.
027     *
028     * @return The message text as set on the builder.
029     */
030    String getText();
031
032    /**
033     * Interface for builders where {@linkplain MessageRequest#getMessageType()} is {@link MessageType#TEXT}.
034     * @param <B> The concrete builder type.
035     */
036    interface Builder<B extends MessageRequest.Builder<? extends TextMessageRequest, ? extends B>> {
037
038        /**
039         * Sets the text of the message request.
040         *
041         * @param text The message text.
042         * @return This builder.
043         */
044        B text(String text);
045    }
046}