How Can I count the number of screen unlocks by a user in Android?

Question

I am currently working on an Android App which informs the number of screen unlocks he/she has done over a day. This example can be seen on stock android devices with API Level P or higher in the feature named Digital Wellbeing. I would like to know how does it work.

Answer 1

You can use Event stats to get unlock count. Try the following code snippet

  void getdailyUsageStatistics(long start_time, long end_time){
    int unlockcount=0;
    
    UsageEvents.Event currentEvent;
    
    UsageStatsManager mUsageStatsManager = (UsageStatsManager)
            getApplicationContext().getSystemService(Context.USAGE_STATS_SERVICE);

    if (mUsageStatsManager != null) {
 
        UsageEvents usageEvents = mUsageStatsManager.queryEvents(start_time, end_time);


        while (usageEvents.hasNextEvent()) {
            currentEvent = new UsageEvents.Event();
            usageEvents.getNextEvent(currentEvent);


            if (currentEvent.getEventType() == UsageEvents.Event.KEYGUARD_HIDDEN)
            {
              ++unlockcount;
            }
        }

    } else {
        Toast.makeText(getApplicationContext(), "Sorry...", Toast.LENGTH_SHORT).show();
    }
    Log.e("UNLOCK COUNT",unlockcount+" ");
}

Answer 2

You can add reciever like this in your Activity :

private LockScreenStateReceiver mLockScreenStateReceiver;
int count = 0;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    mLockScreenStateReceiver = new LockScreenStateReceiver();
    IntentFilter filter = new IntentFilter(Intent.ACTION_SCREEN_OFF);
    filter.addAction(Intent.ACTION_USER_PRESENT);

    registerReceiver(mLockScreenStateReceiver, filter);
}

public class LockScreenStateReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        if (intent.getAction().equals(Intent.ACTION_SCREEN_OFF)) {
            // screen is turn off
            //("Screen locked");
        } else {
            //Handle resuming events if user is present/screen is unlocked
            count++;
            textView.setText(""+count);
            //("Screen unlocked");
        }
    }
}

@Override
public void onDestroy() {
    unregisterReceiver(mLockScreenStateReceiver);
    super.onDestroy();
}