alexaClientSDK::avsCommon::sdkInterfaces::endpoints Namespace Reference

Namespaces
	test

Classes
struct	DefaultEndpointAnnotation
class	EndpointBuilderInterface
class	EndpointCapabilitiesBuilderInterface
class	EndpointCapabilitiesRegistrarInterface
class	EndpointInterface
struct	EndpointModificationData
class	EndpointRegistrationManagerInterface
class	EndpointRegistrationObserverInterface

Typedefs
using	EndpointIdentifier = std::string

Functions
std::ostream &	operator<< (std::ostream &stream, const EndpointRegistrationObserverInterface::RegistrationResult &registrationResult)
std::ostream &	operator<< (std::ostream &stream, const EndpointRegistrationObserverInterface::DeregistrationResult &deregistrationResult)
std::ostream &	operator<< (std::ostream &stream, const EndpointRegistrationObserverInterface::UpdateResult &updateResult)

Typedef Documentation

EndpointIdentifier

using alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointIdentifier = typedef std::string

Alias for the endpoint identifier.

Note that every endpoint must have a unique identifier across all endpoints registered to the user. Identifiers used for endpoints that represent this client or other parts that belong to this client should be generated during endpoint creation using the EndpointBuilderInterface. Endpoints that are considered external to this client, i.e., that can be connected to different clients, must be able to provide its unique identifier and ensure that the identifier stays the same.

Note

The identifier must not exceed 256 characters and it can contain letters or numbers, spaces, and the following special characters: _ - = # ; : ? @ &.

Function Documentation

operator<<() [1/3]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::operator<< ( std::ostream &  stream, const EndpointRegistrationObserverInterface::RegistrationResult &  registrationResult  )

inline

Write an RegistrationResult value to an ostream as a string.

Parameters

stream	The stream to write the value to.
registrationResult	The RegistrationResult value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [2/3]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::operator<< ( std::ostream &  stream, const EndpointRegistrationObserverInterface::DeregistrationResult &  deregistrationResult  )

inline

Write an DeregistrationResult value to an ostream as a string.

Parameters

stream	The stream to write the value to.
deregistrationResult	The DeregistrationResult value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [3/3]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::endpoints::operator<< ( std::ostream &  stream, const EndpointRegistrationObserverInterface::UpdateResult &  updateResult  )

inline

Write an UpdateResult value to an ostream as a string.

Parameters

stream	The stream to write the value to.
deregistrationResult	The DeregistrationResult value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.