Added survey triggering mechanisms

Surveys can now be triggered on a subset of Settings screens. Surveys can also be modified/created for this subset of screens remotely. Test: RoboTests && JUnitTests Bug: 27823357 Change-Id: I1534af5573bef6f6c65c9c99b6f5a2917c3325b9
2016-12-08 12:44:47 -08:00
parent 4e8b78a201
commit db42a6ce0a
4 changed files with 260 additions and 3 deletions
--- a/src/com/android/settings/survey/SurveyMixin.java
+++ b/src/com/android/settings/survey/SurveyMixin.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.android.settings.survey;
+
+import android.app.Activity;
+import android.content.BroadcastReceiver;
+import com.android.settings.core.InstrumentedPreferenceFragment;
+import com.android.settings.core.lifecycle.LifecycleObserver;
+import com.android.settings.core.lifecycle.events.OnPause;
+import com.android.settings.core.lifecycle.events.OnResume;
+import com.android.settings.overlay.FeatureFactory;
+import com.android.settings.overlay.SurveyFeatureProvider;
+
+/**
+ * attaches extra, survey related work to the onResume method of registered observable classes
+ * in settings. This allows new classes to automatically support settings provided the extend
+ * one of the relevant classes in com.android.settings.lifecycle.
+ */
+public class SurveyMixin implements LifecycleObserver, OnResume, OnPause {
+
+    private String mName;
+    private InstrumentedPreferenceFragment mFragment;
+    private BroadcastReceiver mReceiver;
+
+    /**
+     * A mixin that attempts to perform survey related tasks right before onResume is called
+     * in a Settings PreferenceFragment. This will allow for remote updating and creation of
+     * surveys.
+     * @param fragment The fragment that this mixin will be attached to.
+     * @param fragmentName The simple name of the fragment.
+     */
+    public SurveyMixin(InstrumentedPreferenceFragment fragment, String fragmentName) {
+        mName = fragmentName;
+        mFragment = fragment;
+    }
+
+    @Override
+    public void onResume() {
+        Activity activity = mFragment.getActivity();
+
+        // guard against the activity not existing yet or the feature being disabled
+        if (activity != null) {
+            SurveyFeatureProvider provider =
+                    FeatureFactory.getFactory(activity).getSurveyFeatureProvider(activity);
+            if (provider != null) {
+
+                // Try to download a survey if there is none available, show the survey otherwise
+                String id = provider.getSurveyId(activity, mName);
+                if (provider.getSurveyExpirationDate(activity, id) <= -1) {
+                    // register the receiver to show the survey on completion.
+                    mReceiver = provider.createAndRegisterReceiver(activity);
+                    provider.downloadSurvey(activity, id, "fakeData");
+                } else {
+                    provider.showSurveyIfAvailable(activity, id);
+                }
+            }
+        }
+    }
+
+    @Override
+    public void onPause() {
+        Activity activity = mFragment.getActivity();
+        if (mReceiver != null && activity != null) {
+            SurveyFeatureProvider provider =
+                    FeatureFactory.getFactory(activity).getSurveyFeatureProvider(activity);
+            provider.unregisterReceiver(activity, mReceiver);
+        }
+    }
+}