AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface Class Referenceabstract

#include <DiscoveryEventSenderInterface.h>

Inheritance diagram for alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface:
Collaboration graph
[legend]

Public Member Functions

virtual bool sendDiscoveryEvents (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)=0
 
virtual void stop ()=0
 
virtual void addDiscoveryStatusObserver (const std::shared_ptr< DiscoveryStatusObserverInterface > &observer)=0
 
virtual void removeDiscoveryStatusObserver (const std::shared_ptr< DiscoveryStatusObserverInterface > &observer)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface
virtual ~AlexaEventProcessedObserverInterface ()=default
 
virtual void onAlexaEventProcessedReceived (const std::string &eventCorrelationToken)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
virtual ~AuthObserverInterface ()=default
 
virtual void onAuthStateChange (State newState, Error error)=0
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::AuthObserverInterface
enum  State {
  State::UNINITIALIZED, State::REFRESHED, State::EXPIRED, State::UNRECOVERABLE_ERROR,
  State::AUTHORIZING
}
 The enum State describes the state of authorization. More...
 
enum  Error {
  Error::SUCCESS, Error::UNKNOWN_ERROR, Error::AUTHORIZATION_FAILED, Error::UNAUTHORIZED_CLIENT,
  Error::SERVER_ERROR, Error::INVALID_REQUEST, Error::INVALID_VALUE, Error::AUTHORIZATION_EXPIRED,
  Error::UNSUPPORTED_GRANT_TYPE, Error::INVALID_CODE_PAIR, Error::AUTHORIZATION_PENDING, Error::SLOW_DOWN,
  Error::INTERNAL_ERROR, Error::INVALID_CBL_CLIENT_ID
}
 The enum Error encodes possible errors which may occur when changing state. More...
 

Detailed Description

Interface to send Discovery events.

Member Function Documentation

◆ addDiscoveryStatusObserver()

virtual void alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface::addDiscoveryStatusObserver ( const std::shared_ptr< DiscoveryStatusObserverInterface > &  observer)
pure virtual

◆ removeDiscoveryStatusObserver()

virtual void alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface::removeDiscoveryStatusObserver ( const std::shared_ptr< DiscoveryStatusObserverInterface > &  observer)
pure virtual

◆ sendDiscoveryEvents()

virtual bool alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface::sendDiscoveryEvents ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender)
pure virtual

Sends Discovery.AddOrUpdateReport and Discovery.deleteReport events for the addOrUpdateEndpoints and deleteReportEndpoints with which this object was created.

Parameters
messageSenderThe MessageSenderInterface to send messages.
Returns
Whether sending the Discovery events was successful.

Implemented in alexaClientSDK::capabilitiesDelegate::DiscoveryEventSender.

◆ stop()

virtual void alexaClientSDK::capabilitiesDelegate::DiscoveryEventSenderInterface::stop ( )
pure virtual

Method to stop execution and unblock any condition variables that are waiting.

Implemented in alexaClientSDK::capabilitiesDelegate::DiscoveryEventSender.


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

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