AVSMessageHeader.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_AVSMESSAGEHEADER_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGEHEADER_H_

#include <string>

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class AVSMessageHeader {
public:
    AVSMessageHeader(
        const std::string& avsNamespace,
        const std::string& avsName,
        const std::string& avsMessageId,
        const std::string& avsDialogRequestId = "",
        const std::string& correlationToken = "",
        const std::string& eventCorrelationToken = "",
        const std::string& payloadVersion = "",
        const std::string& instance = "");

    static AVSMessageHeader createAVSEventHeader(
        const std::string& avsNamespace,
        const std::string& avsName,
        const std::string& avsDialogRequestId = "",
        const std::string& correlationToken = "",
        const std::string& payloadVersion = "",
        const std::string& instance = "");

    std::string getNamespace() const;

    std::string getName() const;

    std::string getMessageId() const;

    std::string getDialogRequestId() const;

    std::string getCorrelationToken() const;

    std::string getEventCorrelationToken() const;

    std::string getPayloadVersion() const;

    std::string getInstance() const;

    std::string getAsString() const;

    std::string toJson() const;

private:
    const std::string m_namespace;
    const std::string m_name;
    const std::string m_messageId;
    const std::string m_dialogRequestId;
    const std::string m_correlationToken;
    const std::string m_eventCorrelationToken;
    const std::string m_payloadVersion;
    const std::string m_instance;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGEHEADER_H_