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::DiscoveryStatusObserverInterface Class Referenceabstract

#include <DiscoveryStatusObserverInterface.h>

Inheritance diagram for alexaClientSDK::capabilitiesDelegate::DiscoveryStatusObserverInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DiscoveryStatusObserverInterface ()=default
 
virtual void onDiscoveryCompleted (const std::unordered_map< std::string, std::string > &addOrUpdateReportEndpoints, const std::unordered_map< std::string, std::string > &deleteReportEndpoints)=0
 
virtual void onDiscoveryFailure (avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status)=0
 

Detailed Description

Interface to observe Discovery status from CapabilitiesDelegate.

Constructor & Destructor Documentation

◆ ~DiscoveryStatusObserverInterface()

virtual alexaClientSDK::capabilitiesDelegate::DiscoveryStatusObserverInterface::~DiscoveryStatusObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onDiscoveryCompleted()

virtual void alexaClientSDK::capabilitiesDelegate::DiscoveryStatusObserverInterface::onDiscoveryCompleted ( const std::unordered_map< std::string, std::string > &  addOrUpdateReportEndpoints,
const std::unordered_map< std::string, std::string > &  deleteReportEndpoints 
)
pure virtual

This method will be called when the discovery event has completed successfully.

Note
: This method will be called from PostConnectCapabilitiesPublisher 's execution thread and should return immediately.
: This method will be called by the PostConnectCapabilitiesPublisher to report the success state when ALL of the the discovery events are sent.
Parameters
addOrUpdateReportEndpointsThe map of addOrUpdateReport endpoints sent in the discovery events.
deleteReportEndpointsThe map of deleteReport endpoints sent in the discovery events.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.

◆ onDiscoveryFailure()

virtual void alexaClientSDK::capabilitiesDelegate::DiscoveryStatusObserverInterface::onDiscoveryFailure ( avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status  status)
pure virtual

This method will be called when the discovery event has failed.

Parameters
statusThe MessageRequestObserverInterface::Status indicating the HTTP error encountered.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.


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