Alexa Auto SDK  2.3.1
Classes | Public Member Functions | List of all members
com.amazon.aace.propertyManager.PropertyManager Class Referenceabstract

Classes

enum  PropertyState
 

Public Member Functions

final boolean setProperty (String name, String value)
 
void propertyStateChanged (String name, String value, PropertyState state)
 
final String getProperty (String name)
 
void propertyChanged (String name, String newValue)
 

Detailed Description

PropertyManager should be extended to set and retrieve Engine property settings and be notified of property changes.

See also
com.amazon.aace.alexa.AlexaProperties.java
com.amazon.aace.alexa.CoreProperties.java
com.amazon.aace.alexa.NetworkProperties.java
com.amazon.aace.alexa.VehicleProperties.java

Member Function Documentation

◆ setProperty()

final boolean com.amazon.aace.propertyManager.PropertyManager.setProperty ( String  name,
String  value 
)

Sets a property value in the Engine. setProperty() is an asynchronous operation and the Engine will call propertyStateChanged() with the status when it is completed.

Parameters
nameThe name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in com.amazon.aace.alexa.AlexaProperties.java
valueThe property setting
Returns
true if the property value was updated or set to the current setting, else false if an error occured.

◆ propertyStateChanged()

void com.amazon.aace.propertyManager.PropertyManager.propertyStateChanged ( String  name,
String  value,
PropertyState  state 
)

Notifies the platform implementation of the status of a property change after a call to setProperty().

Parameters
nameThe name used by the Engine to identify the property.
valueThe property value.
stateThe state of the property change.

◆ getProperty()

final String com.amazon.aace.propertyManager.PropertyManager.getProperty ( String  name)

Retrieves the setting for the property identified by name from the Engine

Parameters
nameThe name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in com.amazon.aace.alexa.AlexaProperties.java
Returns
The property value as a string, or an empty string if the property value was not found

◆ propertyChanged()

void com.amazon.aace.propertyManager.PropertyManager.propertyChanged ( String  name,
String  newValue 
)

Notifies the platform implementation of a property setting change in the Engine.

Note
This will not be called if the property setting change was initiated by PropertyManager.setProperty()
Parameters
nameThe name used by the Engine to identify the property.
newValueThe new value of the property

Alexa Auto SDK 2.3.1 - Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0