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

#include <AlertsCapabilityAgentInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void addObserver (std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)=0
 
virtual void removeObserver (std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)=0
 
virtual void removeAllAlerts ()=0
 
virtual void onLocalStop ()=0
 
virtual ~AlertsCapabilityAgentInterface ()=default
 

Detailed Description

An interface for Alerts Capability Agent actions that the application may need to access.

Constructor & Destructor Documentation

◆ ~AlertsCapabilityAgentInterface()

virtual alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface::~AlertsCapabilityAgentInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addObserver()

virtual void alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface::addObserver ( std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface observer)
pure virtual

Adds an observer to be notified of alert status changes.

Parameters
observerThe observer to add.

Implemented in alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent.

◆ onLocalStop()

virtual void alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface::onLocalStop ( )
pure virtual

This function provides a way for application code to request this object stop any active alert as the result of a user action, such as pressing a physical 'stop' button on the device.

Implemented in alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent.

◆ removeAllAlerts()

virtual void alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface::removeAllAlerts ( )
pure virtual

A function that allows an application to clear all alerts from storage. This may be useful for a scenario where a user logs out of a device, and another user will log in. As the first user logs out, their pending alerts should not go off.

Implemented in alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent.

◆ removeObserver()

virtual void alexaClientSDK::acsdkAlertsInterfaces::AlertsCapabilityAgentInterface::removeObserver ( std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface observer)
pure virtual

Removes an observer from being notified of alert status changes.

Parameters
observerThe observer to remove.

Implemented in alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent.


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