How to automatically show Progress Bar on each retrofit API call?

Question

How to achieve showing a progress bar on each Retrofit 2.0 API call without having to make a progress bar in each activity, showing it and dismissing. Progress bar should show whenever an API is hit and it should dismiss when we get a response on onResponse or onFailure is called.

I tried this :

ProgressDialog mProgressDialog = new ProgressDialog(this);
mProgressDialog.setIndeterminate(true);
mProgressDialog.setMessage("Loading...");
mProgressDialog.show();
retrofitService.login(new SignInRequest(email, password),
                new Callback<SignInResponse>() {
         @Override
         public void onResponse(Call<SignInResponse> call, Response<SignInResponse> response) {

              if (mProgressDialog.isShowing())
                  mProgressDialog.dismiss();
          }

         @Override
         public void onFailure(Call<SignInResponse> call, Throwable t) {
              if (mProgressDialog.isShowing())
                  mProgressDialog.dismiss();
          }
 });

But this code will have to copy pasted everywhere whenever I make an API call. I don;t want duplicate code.

make a base activity to do all this work? – Sourabh Jun 03 '16 at 18:55 — Sourabh, Jun 03 '16 at 18:55
Please provide an example.. – Shubham A. Jun 03 '16 at 19:02 — Shubham A., Jun 03 '16 at 19:02
use base callback or interceptor – ozanurkan Oct 22 '19 at 12:20 — ozanurkan, Oct 22 '19 at 12:20

score 12 · Answer 1 · edited Jul 29 '20 at 08:32

A base class for your callbacks can be handy.

class BaseCallBack implements CallBacks<T>{
  @Override
     public void onResponse(Call<T> call, Response<T> response) {

          if (mProgressDialog.isShowing())
              mProgressDialog.dismiss();
      }

     @Override
     public void onFailure(Call<SignInResponse> call, Throwable t) {
          if (mProgressDialog.isShowing())
              mProgressDialog.dismiss();
      }
}

When you send a request:

retrofitService.login(new SignInRequest(email, password), new MyCallback<SignInResponse>() {
     @Override
     public void onResponse(Call<SignInResponse> call, Response<SignInResponse> response) {
          super.onResponse(call, response);
          //do more on response
      }

     @Override
     public void onFailure(Call<SignInResponse> call, Throwable t) {
          super.onFailure(call, t);
          /* Do more on failure. For example: give a reason why the
           request failed*/ 
      }
 });

Edit 2019 - using the RXjava adapter:

   getUsers()
        .subscribeOn(AndroidSchedulers.io()) //run request in the background and deliver response to the main thread aka UI thread
        .observeOn(AndroidSchedulers.mainThread())
        .doOnSubscribe(() -> showLoading())
        .doOnTerminate(() -> hideLoading())
        .subscribe(data -> {
            //request is successful
        }, error -> {
            //show error
        });

score 7 · Accepted Answer · answered Jun 03 '16 at 19:13

As suggested by @Sourabh, I ended up using a Base activity and calling simple method during each API call. In BaseActivity,

public void showDialog() {

    if(mProgressDialog != null && !mProgressDialog.isShowing())
        mProgressDialog.show();
}

public void hideDialog() {

    if(mProgressDialog != null && mProgressDialog.isShowing())
        mProgressDialog.dismiss();
}

In your child activity, you can directly call showDialog() and hideDialog() to show and dismiss dialog.

score 7 · Answer 3 · answered May 06 '17 at 11:53

Based on the answers of Shubham and peter, I wrote a class like this:

class CustomCallBack<T> implements Callback<T> {

private ProgressDialog mProgressDialog;
Context context;

CustomCallBack(Context context) {
    this.context = context;
    mProgressDialog = new ProgressDialog(context);
    ((Activity) context).getWindow().setFlags(WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE,
            WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE);
    mProgressDialog.setIndeterminate(true);
    mProgressDialog.setMessage("Loading...");
    mProgressDialog.setCanceledOnTouchOutside(false);
    mProgressDialog.show();

}

@Override
public void onResponse(Call<T> call, Response<T> response) {
    if (mProgressDialog.isShowing()) {
        mProgressDialog.dismiss();
        ((Activity) context).getWindow().clearFlags(WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE);
    }

}

@Override
public void onFailure(Call<T> call, Throwable t) {
    if (mProgressDialog.isShowing()) {
        mProgressDialog.dismiss();
        ((Activity) context).getWindow().clearFlags(WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE);
    }

}
}

I hope it will help you.

score 4 · Answer 4 · answered Mar 04 '18 at 08:28

_{Shameless Promotion}

I've created RxLoading library for that, it can do this and much more,

you can just do something like this:

networkCall().compose(RxLoading.<>create(loadingLayout)).subscribe(...);

it consists out of 2 classes, a custom view (loadingLayout) and RxLoading which is a transformer that glue it all together, you can choose to work with both or either of them.

If you want one progress bar to rule them all, you have several options to achieve it depending on the structure of your app:

one Activity multiple fragments -> just put a loadingLayout in the main screen and tell it to hide the fragment layout when loading
multiple activities: create a base activity which all uses and inject a loadingLayout to all of you views
you can also make a special dialog or activity for the progress bar and use an interface for RxLoading to show and hide it.

RxLoading also supports empty and error states (with built-in retry mechanism, so make sure to check this options as well)

you can find out more on the GitHub page.

score 1 · Answer 5 · answered Jun 03 '16 at 19:17

Example from tutorial:

   protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    requestWindowFeature(Window.FEATURE_INDETERMINATE_PROGRESS);
    requestWindowFeature(Window.FEATURE_PROGRESS);
    ArrayAdapter<Question> arrayAdapter =
            new ArrayAdapter<Question>(this,
                    android.R.layout.simple_list_item_1,
                    android.R.id.text1,
                    new ArrayList<Question>());
    setListAdapter(arrayAdapter);
    setProgressBarIndeterminateVisibility(true);
    setProgressBarVisibility(true);
}

Tutorial link:http://www.vogella.com/tutorials/Retrofit/article.html

This approach is deprecated since API 21. Is there any alternative for Rx? — fobo66, Sep 27 '16 at 15:16

How to automatically show Progress Bar on each retrofit API call?

5 Answers5