From 8792e04ce2510514db0172c59534a7f24635ec7d Mon Sep 17 00:00:00 2001 From: parneet-guraya Date: Tue, 17 Dec 2024 13:26:37 +0530 Subject: [PATCH] add kdoc Signed-off-by: parneet-guraya --- .../contributions/ContributionBoundaryCallback.kt | 11 +++++++++++ .../contributions/ContributionsListContract.java | 1 + .../contributions/ContributionsListPresenter.java | 8 +++++++- .../main/res/layout/fragment_contributions_list.xml | 2 +- 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionBoundaryCallback.kt b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionBoundaryCallback.kt index 7de499b44..b5075a21e 100644 --- a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionBoundaryCallback.kt +++ b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionBoundaryCallback.kt @@ -47,6 +47,12 @@ class ContributionBoundaryCallback fetchContributions() } + /** + * Fetch list from network and save it to local DB. + * + * @param onRefreshFinish callback to invoke when operations finishes + * with either error or success. + */ fun refreshList(onRefreshFinish: () -> Unit = {}){ if (sessionManager.userName != null) { mediaClient.resetUserNameContinuation(sessionManager.userName!!) @@ -56,6 +62,9 @@ class ContributionBoundaryCallback /** * Fetches contributions using the MediaWiki API + * + * @param onRefreshFinish callback to invoke when operations finishes + * with either error or success. */ private fun fetchContributions(onRefreshFinish: () -> Unit = {}) { if (sessionManager.userName != null) { @@ -89,6 +98,8 @@ class ContributionBoundaryCallback /** * Saves the contributions the the local DB + * + * @param onRefreshFinish callback to invoke when successfully saved to DB. */ private fun saveContributionsToDB(contributions: List, onRefreshFinish: () -> Unit) { compositeDisposable.add( diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListContract.java b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListContract.java index c97a03190..0d0a19436 100644 --- a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListContract.java +++ b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListContract.java @@ -20,5 +20,6 @@ public class ContributionsListContract { public interface UserActionListener extends BasePresenter { void refreshList(SwipeRefreshLayout swipeRefreshLayout); + } } diff --git a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListPresenter.java b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListPresenter.java index 89a0c8cdf..100c8be03 100644 --- a/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListPresenter.java +++ b/app/src/main/java/fr/free/nrw/commons/contributions/ContributionsListPresenter.java @@ -96,8 +96,14 @@ public class ContributionsListPresenter implements UserActionListener { contributionBoundaryCallback.dispose(); } + /** + * It is used to refresh list. + * + * @param swipeRefreshLayout used to stop refresh animation when + * refresh finishes. + */ @Override - public void refreshList(SwipeRefreshLayout swipeRefreshLayout) { + public void refreshList(final SwipeRefreshLayout swipeRefreshLayout) { contributionBoundaryCallback.refreshList(() -> { swipeRefreshLayout.setRefreshing(false); return Unit.INSTANCE; diff --git a/app/src/main/res/layout/fragment_contributions_list.xml b/app/src/main/res/layout/fragment_contributions_list.xml index 3ce4156be..41121c92a 100644 --- a/app/src/main/res/layout/fragment_contributions_list.xml +++ b/app/src/main/res/layout/fragment_contributions_list.xml @@ -125,5 +125,5 @@ - +