alexaClientSDK::acsdkDeviceSetupInterfaces Namespace Reference

Classes
class	DeviceSetupInterface
	Satisfies the AVS DeviceSetup Interface. More...

Enumerations
enum	AssistedSetup { AssistedSetup::NONE, AssistedSetup::ALEXA_COMPANION_APPLICATION }
	Indicates if setup was assisted by another device or application. More...

Functions
std::string	assistedSetupToString (AssistedSetup assistedSetup)
std::ostream &	operator<< (std::ostream &stream, AssistedSetup assistedSetup)

Enumeration Type Documentation

AssistedSetup

enum alexaClientSDK::acsdkDeviceSetupInterfaces::AssistedSetup

strong

Indicates if setup was assisted by another device or application.

Enumerator
NONE	Setup occurred only on the device.
ALEXA_COMPANION_APPLICATION	Setup occurred with assistance from the companion app.

Function Documentation

assistedSetupToString()

std::string alexaClientSDK::acsdkDeviceSetupInterfaces::assistedSetupToString ( AssistedSetup  assistedSetup )

inline

Converts the AssistedSetup enum to a string.

Parameters

assistedSetup

The AssistedSetup to convert.

Returns

A string representation of the AssistedSetup.

operator<<()

std::ostream& alexaClientSDK::acsdkDeviceSetupInterfaces::operator<< ( std::ostream &  stream, AssistedSetup  assistedSetup  )

inline

Overload for the AssistedSetup enum. This will write the AssistedSetup as a string to the provided stream.

Parameters

stream	An ostream to send the AssistedSetup as a string.
assisstedSetup	The AssistedSetup to convert.

Returns

The stream.