AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::SystemTimeZoneInterface Class Referenceabstract

#include <SystemTimeZoneInterface.h>

Public Member Functions

virtual bool setTimezone (const std::string &timeZone)=0
 
virtual ~SystemTimeZoneInterface ()=default
 

Detailed Description

This interface is used by the device to set the system time zone.

The setTimeZone function is responsible for validating and applying the new timezone value. The timezone value should be in the Olson format defined here.

The setTimezone function will be for AVS triggered changes as well as local changes.

Constructor & Destructor Documentation

◆ ~SystemTimeZoneInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::SystemTimeZoneInterface::~SystemTimeZoneInterface ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ setTimezone()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::SystemTimeZoneInterface::setTimezone ( const std::string &  timeZone)
pure virtual

Set the system time zone to the given timeZone value.

Parameters
timeZoneThe new time zone to be used by the system.
Returns
true if it succeeds to set the new timezone; false otherwise.

The documentation for this class 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