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 a media message may have a caption.
020 *
021 * @since 8.11.0
022 */
023public interface CaptionMediaMessageRequest extends MediaMessageRequest {
024
025    /**
026     * Interface for builders with a media URL and caption.
027     * @param <B> The concrete builder type.
028     */
029    interface Builder<B extends MessageRequest.Builder<? extends CaptionMediaMessageRequest, ? extends B>> extends MediaMessageRequest.Builder<B> {
030
031        /**
032         * Sets the media's caption text.
033         * 
034         * @param caption The caption string.
035         * @return This builder.
036         */
037        B caption(String caption);
038    }
039}