AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime Struct Reference

#include <AlertObserverInterface.h>

Public Member Functions

 OriginalTime (int hour=ORIGINAL_TIME_FIELD_MIN, int minute=ORIGINAL_TIME_FIELD_MIN, int second=ORIGINAL_TIME_FIELD_MIN, int millisecond=ORIGINAL_TIME_FIELD_MIN)
 
bool operator== (const OriginalTime &rhs) const
 

Public Attributes

int hour
 Hours in [0-23]. More...
 
int minute
 Minutes in [0-59]. More...
 
int second
 Seconds in [0-59]. More...
 
int millisecond
 Milliseconds in [0-999]. More...
 

Detailed Description

Struct that represents the local time in current timezone when the alert was originally set. If the timezone is updated after the alert was set, the value of OriginalTime remains unchanged. Users have to check if all alerts match the desired times after a timezone change. Also, snoozing or deferring an alert will not modify the value of this struct. This struct is supposed to be read only by the alert observers and can be used for display purpose on a screen-based device, e.g. displaying the original time on a ringing screen for an alarm. For example, when a user says "Alexa, set an alarm at 5PM"(PST timezone), the originalTime string included in SetAlert directive would be "17:00:00.000" and the corresponding scheduledTime in ISO 8601 format is "2021-08-08T01:00:00+0000"(UTC timezone). When the alert is triggered and snoozed for 9 minutes, the scheduledTime would be updated to "2021-08-08T01:09:00+0000" (UTC timezone) and the originalTime remains unchanged as "17:00:00.000". The OriginalTime should not be used to infer the date of the alert. The "scheduledTime" in AlertInfo should be used for this purpose. The original time is an optional field in SetAlert directive and currently used for ALARM and REMINDER types.

Constructor & Destructor Documentation

◆ OriginalTime()

alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::OriginalTime ( int  hour = ORIGINAL_TIME_FIELD_MIN,
int  minute = ORIGINAL_TIME_FIELD_MIN,
int  second = ORIGINAL_TIME_FIELD_MIN,
int  millisecond = ORIGINAL_TIME_FIELD_MIN 
)
inline

Constructor. All fields will be set to ORIGINAL_TIME_FIELD_MIN if an invalid value is provided.

Parameters
hourHour within [ORIGINAL_TIME_FIELD_MIN, ORIGINAL_TIME_HOUR_MAX]
minuteMinute within [ORIGINAL_TIME_FIELD_MIN, ORIGINAL_TIME_MINUTE_MAX]
secondSecond within [ORIGINAL_TIME_FIELD_MIN, ORIGINAL_TIME_SECOND_MAX]
millisecondMillisecond within [ORIGINAL_TIME_FIELD_MIN, ORIGINAL_TIME_MILLISECOND_MAX]

Member Function Documentation

◆ operator==()

bool alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::operator== ( const OriginalTime rhs) const
inline

Operator overload to compare two OriginalTime objects.

Parameters
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

Member Data Documentation

◆ hour

int alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::hour

Hours in [0-23].

◆ millisecond

int alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::millisecond

Milliseconds in [0-999].

◆ minute

int alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::minute

Minutes in [0-59].

◆ second

int alexaClientSDK::acsdkAlertsInterfaces::AlertObserverInterface::OriginalTime::second

Seconds in [0-59].


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

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