AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
AVSMessageHeader.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGEHEADER_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGEHEADER_H_
18 
19 #include <string>
20 
21 namespace alexaClientSDK {
22 namespace avsCommon {
23 namespace avs {
24 
29 public:
43  const std::string& avsNamespace,
44  const std::string& avsName,
45  const std::string& avsMessageId,
46  const std::string& avsDialogRequestId = "",
47  const std::string& correlationToken = "",
48  const std::string& eventCorrelationToken = "",
49  const std::string& payloadVersion = "",
50  const std::string& instance = "");
51 
64  const std::string& avsNamespace,
65  const std::string& avsName,
66  const std::string& avsDialogRequestId = "",
67  const std::string& correlationToken = "",
68  const std::string& payloadVersion = "",
69  const std::string& instance = "");
70 
76  std::string getNamespace() const;
77 
83  std::string getName() const;
84 
90  std::string getMessageId() const;
91 
97  std::string getDialogRequestId() const;
98 
104  std::string getCorrelationToken() const;
105 
111  std::string getEventCorrelationToken() const;
112 
118  std::string getPayloadVersion() const;
119 
125  std::string getInstance() const;
126 
132  std::string getAsString() const;
133 
139  std::string toJson() const;
140 
141 private:
143  const std::string m_namespace;
145  const std::string m_name;
147  const std::string m_messageId;
149  const std::string m_dialogRequestId;
151  const std::string m_correlationToken;
153  const std::string m_eventCorrelationToken;
155  const std::string m_payloadVersion;
157  const std::string m_instance;
158 };
159 
160 } // namespace avs
161 } // namespace avsCommon
162 } // namespace alexaClientSDK
163 
164 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGEHEADER_H_
std::string getInstance() const
Definition: AVSMessageHeader.cpp:117
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="")
Definition: AVSMessageHeader.cpp:45
std::string getDialogRequestId() const
Definition: AVSMessageHeader.cpp:88
std::string getPayloadVersion() const
Definition: AVSMessageHeader.cpp:113
std::string getEventCorrelationToken() const
Definition: AVSMessageHeader.cpp:96
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="")
Definition: AVSMessageHeader.cpp:64
Definition: AVSMessageHeader.h:28
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
std::string getNamespace() const
Definition: AVSMessageHeader.cpp:76
std::string getAsString() const
Definition: AVSMessageHeader.cpp:100
std::string getName() const
Definition: AVSMessageHeader.cpp:80
std::string toJson() const
Definition: AVSMessageHeader.cpp:121
std::string getMessageId() const
Definition: AVSMessageHeader.cpp:84
std::string getCorrelationToken() const
Definition: AVSMessageHeader.cpp:92

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0