AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Functions
alexaClientSDK::avsCommon::sdkInterfaces::endpoints Namespace Reference

Namespaces

 test
 

Classes

class  EndpointBuilderInterface
 
class  EndpointInterface
 
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)
 

Typedef Documentation

◆ EndpointIdentifier

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/2]

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
streamThe stream to write the value to.
registrationResultThe RegistrationResult value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [2/2]

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
streamThe stream to write the value to.
deregistrationResultThe DeregistrationResult value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

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