jenkins-bot has submitted this change and it was merged.
Change subject: Hygiene: add some documentation to OnboardingActivity
......................................................................
Hygiene: add some documentation to OnboardingActivity
OnboardingActivity was a bit sparse, documentation-wise. This patch adds some
documentation to the class so that it's more accessible and understandable
what's happening.
Change-Id: I95f0f1e7443334ba85109e540a18cd55e39aa363
---
M wikipedia/src/main/java/org/wikipedia/onboarding/OnboardingActivity.java
1 file changed, 14 insertions(+), 2 deletions(-)
Approvals:
Dbrant: Looks good to me, approved
jenkins-bot: Verified
diff --git
a/wikipedia/src/main/java/org/wikipedia/onboarding/OnboardingActivity.java
b/wikipedia/src/main/java/org/wikipedia/onboarding/OnboardingActivity.java
index 04105e2..9a338ca 100644
--- a/wikipedia/src/main/java/org/wikipedia/onboarding/OnboardingActivity.java
+++ b/wikipedia/src/main/java/org/wikipedia/onboarding/OnboardingActivity.java
@@ -72,7 +72,7 @@
@Override
public void onClick(View view) {
funnel.logLogin();
- startLoginActivity(false);
+ startLoginActivity(false); // just take the user the login form
}
});
@@ -80,11 +80,15 @@
@Override
public void onClick(View view) {
funnel.logSkip();
- done();
+ done(); // take the user directly out of the funnel
}
});
}
+ /**
+ * Starts LoginActivity.
+ * @param createAccount true if the account creation form should be shown
first, false otherwise
+ */
private void startLoginActivity(boolean createAccount) {
Intent intent = new Intent(this, LoginActivity.class);
intent.putExtra(LoginActivity.LOGIN_REQUEST_SOURCE,
LoginFunnel.SOURCE_ONBOARDING);
@@ -93,11 +97,17 @@
done();
}
+ /**
+ * Prepares the activity for finishing and ensuring onboarding is not
shown again.
+ */
private void done() {
markAllAboard();
finish();
}
+ /**
+ * Adds a key to the SharedPreferences of the app to ensure that
onboarding never shows again.
+ */
private void markAllAboard() {
SharedPreferences prefs =
PreferenceManager.getDefaultSharedPreferences(this);
prefs.edit().putBoolean(PrefKeys.getOnboard(), true).apply();
@@ -106,6 +116,8 @@
@Override
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
+ // Put item in bundle so start events are not fired purely because of
activity recreation
+ // This makes the event logging data more closely match user intent
and behaviour
outState.putBoolean("onboardingShowing", true);
}
}
--
To view, visit https://gerrit.wikimedia.org/r/207032
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I95f0f1e7443334ba85109e540a18cd55e39aa363
Gerrit-PatchSet: 1
Gerrit-Project: apps/android/wikipedia
Gerrit-Branch: master
Gerrit-Owner: Deskana <dga...@wikimedia.org>
Gerrit-Reviewer: BearND <bsitzm...@wikimedia.org>
Gerrit-Reviewer: Brion VIBBER <br...@wikimedia.org>
Gerrit-Reviewer: Dbrant <dbr...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
