diff options
author | Ram Periathiruvadi | 2018-07-12 12:01:54 -0500 |
---|---|---|
committer | Android (Google) Code Review | 2018-07-12 12:01:54 -0500 |
commit | cdce23cde42412a0629e75a3a1deaf9fc0204d5b (patch) | |
tree | 17ccc643ea70fd8e58d68cc71fb40791b4d1a0de | |
parent | 94b37d8d1055518f987b2d7097cbbe12de212808 (diff) | |
parent | 79029910e311700e0e13ca57fb1cb52adb88b094 (diff) | |
download | platform-packages-services-car-cdce23cde42412a0629e75a3a1deaf9fc0204d5b.tar.gz platform-packages-services-car-cdce23cde42412a0629e75a3a1deaf9fc0204d5b.tar.xz platform-packages-services-car-cdce23cde42412a0629e75a3a1deaf9fc0204d5b.zip |
Merge "Cleanup javadoc for CarUxRestrictions." into pi-dev
-rw-r--r-- | car-lib/src/android/car/drivingstate/CarUxRestrictions.java | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/car-lib/src/android/car/drivingstate/CarUxRestrictions.java b/car-lib/src/android/car/drivingstate/CarUxRestrictions.java index c6c22bc3..87dfa3aa 100644 --- a/car-lib/src/android/car/drivingstate/CarUxRestrictions.java +++ b/car-lib/src/android/car/drivingstate/CarUxRestrictions.java | |||
@@ -24,30 +24,32 @@ import java.lang.annotation.Retention; | |||
24 | import java.lang.annotation.RetentionPolicy; | 24 | import java.lang.annotation.RetentionPolicy; |
25 | 25 | ||
26 | /** | 26 | /** |
27 | * Car UX Restrictions event. This contains information on the set of UX restrictions | 27 | * Car UX Restrictions event. This contains information on the set of UX restrictions that is in |
28 | * that is in place due to the car's driving state. | 28 | * place due to the car's driving state. |
29 | * <p> | 29 | * <p> |
30 | * The restriction information is organized as follows: | 30 | * The restriction information is organized as follows: |
31 | * <ul> | 31 | * <ul> |
32 | * <li> When there are no restrictions in place, for example when the car is parked, | 32 | * <li> When there are no restrictions in place, for example when the car is parked, |
33 | * <ul> | 33 | * <ul> |
34 | * <li> {@link #mRequiresDistractionOptimization} is set to false. Apps can display activities | 34 | * <li> {@link #isRequiresDistractionOptimization()} returns false. Apps can display activities |
35 | * that are not distraction optimized. | 35 | * that are not distraction optimized. |
36 | * <li> {@link #mActiveRestrictions} should contain UX_RESTRICTIONS_UNRESTRICTED. Apps don't | 36 | * <li> When {@link #isRequiresDistractionOptimization()} returns false, apps don't have to call |
37 | * have to check for this since {@code mRequiresDistractionOptimization} is false. | 37 | * {@link #getActiveRestrictions()}, since there is no distraction optimization required. |
38 | * </ul> | 38 | * </ul> |
39 | * <li> When the driving state changes, causing the UX restrictions to come in effect, | 39 | * <li> When the driving state changes, causing the UX restrictions to come in effect, |
40 | * <ul> | 40 | * <ul> |
41 | * <li> {@code mRequiresDistractionOptimization} is set to true. Apps can only display | 41 | * <li> {@link #isRequiresDistractionOptimization()} returns true. Apps can only display activities |
42 | * activities that are distraction optimized. Distraction optimized activities follow the base | 42 | * that are distraction optimized. Distraction optimized activities must follow the base design |
43 | * design guidelines that provide a distraction free driving user experience. | 43 | * guidelines to ensure a distraction free driving experience for the user. |
44 | * <li> In addition, apps will have to check for the content of mActiveRestrictions. | 44 | * <li> When {@link #isRequiresDistractionOptimization()} returns true, apps must call |
45 | * {@code mActiveRestrictions} will have additional granular information on the set of UX | 45 | * {@link #getActiveRestrictions()}, to get the currently active UX restrictions to adhere to. |
46 | * restrictions that are in place for the current driving state. The content of | 46 | * {@link #getActiveRestrictions()} provides additional information on the set of UX |
47 | * {@code mActiveRestrictions}, for the same driving state of the vehicle, could vary depending | 47 | * restrictions that are in place for the current driving state. |
48 | * on the car maker and the market. For example, when the car is idling, the set of active | 48 | * <p> |
49 | * UX restrictions contained in the {@code mActiveRestrictions} will depend on the car maker | 49 | * The UX restrictions returned by {@link #getActiveRestrictions()}, for the same driving state of |
50 | * and the safety standards of the market that the vehicle is deployed in. | 50 | * the vehicle, could vary depending on the OEM and the market. For example, when the car is |
51 | * idling, the set of active UX restrictions will depend on the car maker and the safety standards | ||
52 | * of the market that the vehicle is deployed in. | ||
51 | * </ul> | 53 | * </ul> |
52 | * </ul> | 54 | * </ul> |
53 | * <p> | 55 | * <p> |