AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
RequesterMetadata.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 ACSDKASSETMANAGER_SRC_REQUESTERMETADATA_H_
17 #define ACSDKASSETMANAGER_SRC_REQUESTERMETADATA_H_
18 
20 
21 #include <chrono>
22 #include <string>
23 
26 
27 namespace alexaClientSDK {
28 namespace acsdkAssets {
29 namespace manager {
30 
32 public:
41  static std::unique_ptr<RequesterMetadata> create(
42  std::shared_ptr<commonInterfaces::ArtifactRequest> request,
43  std::string resourceId = "",
44  std::chrono::milliseconds lastUsed = std::chrono::milliseconds(0));
45 
52  static std::unique_ptr<RequesterMetadata> createFromFile(const std::string& metadataFile);
53 
60  bool saveToFile(const std::string& metadataFile);
61 
62  inline const std::shared_ptr<commonInterfaces::ArtifactRequest>& getRequest() {
63  return m_request;
64  }
65 
66  inline const std::string& getResourceId() const {
67  return m_resourceId;
68  }
69 
70  inline std::chrono::milliseconds getLastUsed() const {
71  return m_lastUsed;
72  }
73 
74  inline void setResourceId(const std::string& value) {
75  m_resourceId = value;
76  }
77 
78  inline void setLastUsed(const std::chrono::milliseconds value) {
79  m_lastUsed = value;
80  }
81 
82  inline void clear(const std::string& metadataFile) {
83  m_resourceId.clear();
84  alexaClientSDK::avsCommon::utils::filesystem::removeAll(metadataFile);
85  }
86 
87 private:
89  std::shared_ptr<commonInterfaces::ArtifactRequest> request,
90  std::string resourceId,
91  std::chrono::milliseconds lastUsed);
92 
93 private:
94  const std::shared_ptr<commonInterfaces::ArtifactRequest> m_request;
95  std::string m_resourceId;
96  std::chrono::milliseconds m_lastUsed;
97 };
98 
99 } // namespace manager
100 } // namespace acsdkAssets
101 } // namespace alexaClientSDK
102 
103 #endif // ACSDKASSETMANAGER_SRC_REQUESTERMETADATA_H_
Priority.h
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getLastUsed
std::chrono::milliseconds getLastUsed() const
Definition: RequesterMetadata.h:70
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getResourceId
const std::string & getResourceId() const
Definition: RequesterMetadata.h:66
ArtifactRequest.h
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::create
static std::unique_ptr< RequesterMetadata > create(std::shared_ptr< commonInterfaces::ArtifactRequest > request, std::string resourceId="", std::chrono::milliseconds lastUsed=std::chrono::milliseconds(0))
Definition: RequesterMetadata.cpp:59
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::saveToFile
bool saveToFile(const std::string &metadataFile)
Definition: RequesterMetadata.cpp:121
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::setResourceId
void setResourceId(const std::string &value)
Definition: RequesterMetadata.h:74
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::clear
void clear(const std::string &metadataFile)
Definition: RequesterMetadata.h:82
alexaClientSDK::acsdkAssets::manager::RequesterMetadata
Definition: RequesterMetadata.h:31
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::createFromFile
static std::unique_ptr< RequesterMetadata > createFromFile(const std::string &metadataFile)
Definition: RequesterMetadata.cpp:77
FileSystemUtils.h
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getRequest
const std::shared_ptr< commonInterfaces::ArtifactRequest > & getRequest()
Definition: RequesterMetadata.h:62
alexaClientSDK::acsdkAssets::manager::RequesterMetadata::setLastUsed
void setLastUsed(const std::chrono::milliseconds value)
Definition: RequesterMetadata.h:78

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