AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::DeviceInfo Class Reference

#include <DeviceInfo.h>

Public Member Functions

std::string getClientId () const
 
std::string getProductId () const
 
std::string getDeviceSerialNumber () const
 
std::string getManufacturerName () const
 
std::string getDeviceDescription () const
 
std::string getFriendlyName () const
 
std::string getDeviceType () const
 
sdkInterfaces::endpoints::EndpointIdentifier getDefaultEndpointId () const
 
std::string getRegistrationKey () const
 
std::string getProductIdKey () const
 
bool operator== (const DeviceInfo &rhs)
 
bool operator!= (const DeviceInfo &rhs)
 

Static Public Member Functions

static std::shared_ptr< DeviceInfocreateFromConfiguration (const std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > &configurationRoot)
 
static std::unique_ptr< DeviceInfocreate (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
 
static std::unique_ptr< DeviceInfocreate (const std::string &clientId, const std::string &productId, const std::string &deviceSerialNumber, const std::string &manufacturerName, const std::string &description, const std::string &friendlyName="", const std::string &deviceType="", const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId="", const std::string &registrationKey="", const std::string &productIdKey="")
 

Detailed Description

Class that defines a device's identification information.

Member Function Documentation

◆ create() [1/2]

std::unique_ptr< DeviceInfo > alexaClientSDK::avsCommon::utils::DeviceInfo::create ( const avsCommon::utils::configuration::ConfigurationNode configurationRoot)
static

Create a DeviceInfo.

Deprecated:
Parameters
configurationRootThe global config object.
Returns
If successful, returns a new DeviceInfo, otherwise nullptr.

◆ create() [2/2]

std::unique_ptr< DeviceInfo > alexaClientSDK::avsCommon::utils::DeviceInfo::create ( const std::string &  clientId,
const std::string &  productId,
const std::string &  deviceSerialNumber,
const std::string &  manufacturerName,
const std::string &  description,
const std::string &  friendlyName = "",
const std::string &  deviceType = "",
const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId = "",
const std::string &  registrationKey = "",
const std::string &  productIdKey = "" 
)
static

Create a DeviceInfo.

Parameters
clientIdClient Id.
productIdProduct Id.
deviceSerialNumberDSN.
manufacturerNameThe manufacturer name.
descriptionThe description of the device.
friendlyNameAVS friendly name for device
deviceTypeThe device type.
registrationKeyThe Registration key value.
productIdKeyThe Product Id Key value.
Returns
If successful, returns a new DeviceInfo, otherwise nullptr.

◆ createFromConfiguration()

std::shared_ptr< DeviceInfo > alexaClientSDK::avsCommon::utils::DeviceInfo::createFromConfiguration ( const std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > &  configurationRoot)
static

Create a DeviceInfo.

Parameters
configurationRootThe ConfiguratioNode to read device info from.
Returns
If successful, returns a new DeviceInfo, otherwise nullptr.

◆ getClientId()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getClientId ( ) const

Gets the client Id.

Returns
Client Id.

◆ getDefaultEndpointId()

sdkInterfaces::endpoints::EndpointIdentifier alexaClientSDK::avsCommon::utils::DeviceInfo::getDefaultEndpointId ( ) const
inline

Gets the device default endpoint id.

Returns
A string representing the default endpoint identifier.

◆ getDeviceDescription()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getDeviceDescription ( ) const
inline

Gets a description of the device.

Returns
The device description.

◆ getDeviceSerialNumber()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getDeviceSerialNumber ( ) const

Gets the device serial number.

Returns
Device serial number.

◆ getDeviceType()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getDeviceType ( ) const

Gets the deviceType.

Returns
device Type.

◆ getFriendlyName()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getFriendlyName ( ) const

Gets the device's AVS friendly name.

Returns
AVS friendly name.

◆ getManufacturerName()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getManufacturerName ( ) const
inline

Gets the device manufacturer name.

Returns
Device manufacturer name.

◆ getProductId()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getProductId ( ) const

Gets the product Id.

Returns
Product Id.

◆ getProductIdKey()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getProductIdKey ( ) const

Gets the product id key value.

Returns
product id key.

◆ getRegistrationKey()

std::string alexaClientSDK::avsCommon::utils::DeviceInfo::getRegistrationKey ( ) const

Gets the device's registration key value.

Returns
registration key.

◆ operator!=()

bool alexaClientSDK::avsCommon::utils::DeviceInfo::operator!= ( const DeviceInfo rhs)

Operator != for DeviceInfo

Parameters
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator==()

bool alexaClientSDK::avsCommon::utils::DeviceInfo::operator== ( const DeviceInfo rhs)

Operator == for DeviceInfo

Parameters
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

The documentation for this class was generated from the following files:

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