AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkNotifications::NotificationIndicator Struct Reference

#include <NotificationIndicator.h>

Collaboration diagram for alexaClientSDK::acsdkNotifications::NotificationIndicator:
Collaboration graph


struct  Asset

Public Member Functions

 NotificationIndicator ()
 NotificationIndicator (bool persistVisualIndicator, bool playAudioIndicator, const std::string &assetId, const std::string &url)

Public Attributes

bool persistVisualIndicator
bool playAudioIndicator
struct alexaClientSDK::acsdkNotifications::NotificationIndicator::Asset asset

Detailed Description

A struct representation of a NotificationIndicator.

There is one instance of this class created per SetIndicator directive.

Constructor & Destructor Documentation

◆ NotificationIndicator() [1/2]

alexaClientSDK::acsdkNotifications::NotificationIndicator::NotificationIndicator ( )

Default constructor

◆ NotificationIndicator() [2/2]

alexaClientSDK::acsdkNotifications::NotificationIndicator::NotificationIndicator ( bool  persistVisualIndicator,
bool  playAudioIndicator,
const std::string &  assetId,
const std::string &  url 


persistVisualIndicatorA flag indicating whether the visual indicator on the device should stay lit.
playAudioIndicatorA flag indicating whether audio should be played.
assetIdThe id of the audio asset to be played.
urlThe url of the audio asset to be played.

Member Data Documentation

◆ asset

struct alexaClientSDK::acsdkNotifications::NotificationIndicator::Asset alexaClientSDK::acsdkNotifications::NotificationIndicator::asset

◆ persistVisualIndicator

bool alexaClientSDK::acsdkNotifications::NotificationIndicator::persistVisualIndicator

Flag specifying if the device must display a persistent visual indicator when processing this NotificationIndicator.

◆ playAudioIndicator

bool alexaClientSDK::acsdkNotifications::NotificationIndicator::playAudioIndicator

Flag specifying if the device must play audio when processing this NotificationIndicator.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0