AVSMessage.h

Go to the documentation of this file.

/*
 * Copyright 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.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGE_H_

#include <memory>
#include <string>

#include <AVSCommon/Utils/Optional.h>

#include "AVSCommon/AVS/AVSMessageEndpoint.h"
#include "AVSCommon/AVS/AVSMessageHeader.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class AVSMessage {
public:
    AVSMessage(
        std::shared_ptr<AVSMessageHeader> avsMessageHeader,
        std::string payload,
        const utils::Optional<AVSMessageEndpoint>& endpoint = utils::Optional<AVSMessageEndpoint>());

    virtual ~AVSMessage() = default;

    std::string getNamespace() const;

    std::string getName() const;

    std::string getMessageId() const;

    std::string getCorrelationToken() const;

    std::string getEventCorrelationToken() const;

    std::string getPayloadVersion() const;

    std::string getInstance() const;

    std::string getDialogRequestId() const;

    std::string getPayload() const;

    std::shared_ptr<const AVSMessageHeader> getHeader() const;

    std::string getHeaderAsString() const;

    utils::Optional<AVSMessageEndpoint> getEndpoint() const;

private:
    const std::shared_ptr<AVSMessageHeader> m_header;

    const std::string m_payload;

    const utils::Optional<AVSMessageEndpoint> m_endpoint;
};

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGE_H_