AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Enumerations | Functions
alexaClientSDK::acsdkAssets::commonInterfaces Namespace Reference

Classes

class  AmdCommunicationInterface
 
class  ArtifactRequest
 
class  DavsRequest
 
class  InMemoryAmdCommunicationHandler
 
class  UrlRequest
 
class  VendableArtifact
 

Enumerations

enum  Priority {
  Priority::ACTIVE, Priority::PENDING_ACTIVATION, Priority::LIKELY_TO_BE_ACTIVE, Priority::UNUSED_IMPORTANT,
  Priority::UNUSED
}
 
enum  Region { Region::NA, Region::EU, Region::FE }
 
enum  ResultCode {
  ResultCode::CONNECTION_FAILED = 47, ResultCode::CONNECTION_TIMED_OUT = -51, ResultCode::CHECKSUM_MISMATCH = -52, ResultCode::NO_SPACE_AVAILABLE = -53,
  ResultCode::SUCCESS = 200, ResultCode::UP_TO_DATE = 304, ResultCode::ILLEGAL_ARGUMENT = 400, ResultCode::UNAUTHORIZED = 401,
  ResultCode::FORBIDDEN = 403, ResultCode::NO_ARTIFACT_FOUND = 404, ResultCode::UNPACK_FAILURE = -997, ResultCode::UNHANDLED_MIME_TYPE = -998,
  ResultCode::CATASTROPHIC_FAILURE = -999
}
 
enum  State {
  State::INIT, State::REQUESTING, State::DOWNLOADING, State::INVALID,
  State::LOADED
}
 
enum  Type { Type::DAVS, Type::URL }
 

Functions

bool operator== (const ArtifactRequest &lhs, const ArtifactRequest &rhs)
 
bool operator!= (const ArtifactRequest &lhs, const ArtifactRequest &rhs)
 
bool isValidPriority (int value)
 
std::string toString (Priority priority)
 
std::ostream & operator<< (std::ostream &os, Priority value)
 
std::ostream & operator<< (std::ostream &os, ResultCode result)
 
std::string toString (State state)
 
std::ostream & operator<< (std::ostream &os, State value)
 

Enumeration Type Documentation

◆ Priority

The priority given to an artifact that determines the order of its deletion when space is low. ACTIVE and PENDING_ACTIVATION are never to be deleted.

Enumerator
ACTIVE 
PENDING_ACTIVATION 
LIKELY_TO_BE_ACTIVE 
UNUSED_IMPORTANT 
UNUSED 

◆ Region

Specific DAVS endpoint region to connect to.

Enumerator
NA 
EU 
FE 

◆ ResultCode

Enumerator
CONNECTION_FAILED 
CONNECTION_TIMED_OUT 
CHECKSUM_MISMATCH 
NO_SPACE_AVAILABLE 
SUCCESS 
UP_TO_DATE 
ILLEGAL_ARGUMENT 
UNAUTHORIZED 
FORBIDDEN 
NO_ARTIFACT_FOUND 
UNPACK_FAILURE 
UNHANDLED_MIME_TYPE 
CATASTROPHIC_FAILURE 

◆ State

Enumerator
INIT 
REQUESTING 
DOWNLOADING 
INVALID 
LOADED 

◆ Type

Types of requests to download.

Enumerator
DAVS 
URL 

Function Documentation

◆ isValidPriority()

bool alexaClientSDK::acsdkAssets::commonInterfaces::isValidPriority ( int  value)
inline

◆ operator!=()

bool alexaClientSDK::acsdkAssets::commonInterfaces::operator!= ( const ArtifactRequest lhs,
const ArtifactRequest rhs 
)
inline

◆ operator<<() [1/3]

std::ostream& alexaClientSDK::acsdkAssets::commonInterfaces::operator<< ( std::ostream &  os,
ResultCode  result 
)
inline

◆ operator<<() [2/3]

std::ostream& alexaClientSDK::acsdkAssets::commonInterfaces::operator<< ( std::ostream &  os,
Priority  value 
)
inline

◆ operator<<() [3/3]

std::ostream& alexaClientSDK::acsdkAssets::commonInterfaces::operator<< ( std::ostream &  os,
State  value 
)
inline

◆ operator==()

bool alexaClientSDK::acsdkAssets::commonInterfaces::operator== ( const ArtifactRequest lhs,
const ArtifactRequest rhs 
)
inline

Use summary to determine if two requests are identical

◆ toString() [1/2]

std::string alexaClientSDK::acsdkAssets::commonInterfaces::toString ( Priority  priority)
inline

◆ toString() [2/2]

std::string alexaClientSDK::acsdkAssets::commonInterfaces::toString ( State  state)
inline

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