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.mms;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.messages.CaptionMediaMessageRequest;
020import com.vonage.client.messages.MessageType;
021import com.vonage.client.messages.internal.MessagePayload;
022
023public final class MmsImageRequest extends MmsRequest implements CaptionMediaMessageRequest {
024
025        MmsImageRequest(Builder builder) {
026                super(builder, MessageType.IMAGE);
027                media.validateUrlExtension("jpg", "jpeg", "png", "gif");
028        }
029
030        @JsonProperty("image")
031        public MessagePayload getImage() {
032                return media;
033        }
034
035        public static Builder builder() {
036                return new Builder();
037        }
038
039        public static final class Builder extends MmsRequest.Builder<MmsImageRequest, Builder> implements CaptionMediaMessageRequest.Builder<Builder> {
040                Builder() {}
041
042                /**
043                 * (REQUIRED)
044                 * Sets the URL of the image attachment. Supports only {@code .jpg},
045                 * {@code .jpeg}, {@code .png} and {@code .gif} file extensions.
046                 *
047                 * @param url The URL as a string.
048                 * @return This builder.
049                 */
050                @Override
051                public Builder url(String url) {
052                        return super.url(url);
053                }
054
055                /**
056                 * (OPTIONAL)
057                 * Additional text to accompany the image. Must be between 1 and 2000 characters.
058                 *
059                 * @param caption The caption string.
060                 * @return This builder.
061                 */
062                @Override
063                public Builder caption(String caption) {
064                        return super.caption(caption);
065                }
066
067                @Override
068                public MmsImageRequest build() {
069                        return new MmsImageRequest(this);
070                }
071        }
072}