AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
AVSMessage.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_AVSMESSAGE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGE_H_
18 
19 #include <memory>
20 #include <string>
21 
23 
26 
27 namespace alexaClientSDK {
28 namespace avsCommon {
29 namespace avs {
30 
35 class AVSMessage {
36 public:
45  AVSMessage(
46  std::shared_ptr<AVSMessageHeader> avsMessageHeader,
47  std::string payload,
49 
53  virtual ~AVSMessage() = default;
54 
60  std::string getNamespace() const;
61 
67  std::string getName() const;
68 
74  std::string getMessageId() const;
75 
81  std::string getCorrelationToken() const;
82 
88  std::string getEventCorrelationToken() const;
89 
95  std::string getPayloadVersion() const;
96 
102  std::string getInstance() const;
103 
109  std::string getDialogRequestId() const;
110 
116  std::string getPayload() const;
117 
123  std::shared_ptr<const AVSMessageHeader> getHeader() const;
124 
130  std::string getHeaderAsString() const;
131 
138 
139 private:
141  const std::shared_ptr<AVSMessageHeader> m_header;
142 
144  const std::string m_payload;
145 
147  const utils::Optional<AVSMessageEndpoint> m_endpoint;
148 };
149 
150 } // namespace avs
151 } // namespace avsCommon
152 } // namespace alexaClientSDK
153 
154 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSMESSAGE_H_
std::string getEventCorrelationToken() const
Definition: AVSMessage.cpp:47
std::string getDialogRequestId() const
Definition: AVSMessage.cpp:59
std::string getPayload() const
Definition: AVSMessage.cpp:63
std::string getCorrelationToken() const
Definition: AVSMessage.cpp:43
std::string getMessageId() const
Definition: AVSMessage.cpp:39
std::string getNamespace() const
Definition: AVSMessage.cpp:31
utils::Optional< AVSMessageEndpoint > getEndpoint() const
Definition: AVSMessage.cpp:75
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
std::string getPayloadVersion() const
Definition: AVSMessage.cpp:51
std::string getInstance() const
Definition: AVSMessage.cpp:55
AVSMessage(std::shared_ptr< AVSMessageHeader > avsMessageHeader, std::string payload, const utils::Optional< AVSMessageEndpoint > &endpoint=utils::Optional< AVSMessageEndpoint >())
Definition: AVSMessage.cpp:22
std::string getName() const
Definition: AVSMessage.cpp:35
std::string getHeaderAsString() const
Definition: AVSMessage.cpp:71
std::shared_ptr< const AVSMessageHeader > getHeader() const
Definition: AVSMessage.cpp:67

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