com.amazon.speech.speechlet.interfaces.messaging.request.MessageReceivedRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alexa-skills-kit Show documentation
Contains classes used by the Alexa Skills Kit.
There is a newer version: 1.8.1
/*
    Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.

    Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file
    except in compliance with the License. A copy of the License is located at

        http://aws.amazon.com/apache2.0/

    or in the "license" file accompanying this file. This file 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.amazon.speech.speechlet.interfaces.messaging.request;

import java.util.Date;
import java.util.Locale;
import java.util.Map;

import org.apache.commons.lang3.Validate;

import com.amazon.speech.speechlet.SpeechletRequest;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;

@JsonTypeName("Messaging.MessageReceived")
public class MessageReceivedRequest extends SpeechletRequest {
    private Map message;

    /**
     * Returns a new builder instance used to construct a new {@code MessageReceivedRequest}.
     *
     * @return the builder
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Private constructor to return a new {@code MessageReceivedRequest} from a {@code Builder}.
     *
     * @param builder
     *            the builder used to construct the {@code MessageReceivedRequest}
     */
    private MessageReceivedRequest(final Builder builder) {
        super(builder);
        this.message = builder.message;
    }

    /**
     * Protected constructor used for JSON serialization and for extending this class.
     *
     * @param requestId
     *            the unique identifier associated with the request
     * @param timestamp
     *            the request timestamp
     * @param locale
     *            the locale of the request
     * @param message
     *            the message needs to be delivered
     */
    protected MessageReceivedRequest(@JsonProperty("requestId") final String requestId,
            @JsonProperty("timestamp") final Date timestamp,
            @JsonProperty("locale") final Locale locale,
            @JsonProperty("message") final Map message) {
        super(requestId, timestamp, locale);
        this.message = message;
    }

    /**
     * Returns the message associated with this request.
     *
     * @return the message to be delivered
     */
    public Map getMessage() {
        return message;
    }

    /**
     * Builder used to construct a new {@code MessageReceivedRequest}.
     */
    public static final class Builder extends
            SpeechletRequest.SpeechletRequestBuilder {
        private Map message;

        private Builder() {
        }

        public Builder withMessage(final Map message) {
            this.message = message;
            return this;
        }

        @Override
        public MessageReceivedRequest build() {
            Validate.notNull(message, "Message must be defined");
            return new MessageReceivedRequest(this);
        }
    }
}