public class

UserManagerCompat

extends java.lang.Object

 java.lang.Object

↳androidx.core.os.UserManagerCompat

Gradle dependencies

compile group: 'androidx.core', name: 'core', version: '1.15.0-alpha02'

  • groupId: androidx.core
  • artifactId: core
  • version: 1.15.0-alpha02

Artifact androidx.core:core:1.15.0-alpha02 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.core:core com.android.support:support-compat

Androidx class mapping:

androidx.core.os.UserManagerCompat android.support.v4.os.UserManagerCompat

Overview

Helper for accessing features in in a backwards compatible fashion.

Summary

Methods
public static booleanisUserUnlocked(Context context)

Return whether the calling user is running in an "unlocked" state.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public static boolean isUserUnlocked(Context context)

Return whether the calling user is running in an "unlocked" state. A user is unlocked only after they've entered their credentials (such as a lock pattern or PIN), and credential-encrypted private app data storage is available.

Source

/*
 * Copyright (C) 2015 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 androidx.core.os;

import android.content.Context;
import android.os.Build;
import android.os.UserManager;

import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;

/**
 * Helper for accessing features in {@link android.os.UserManager} in a backwards compatible
 * fashion.
 */
public class UserManagerCompat {

    private UserManagerCompat() {
    }

    /**
     * Return whether the calling user is running in an "unlocked" state. A user
     * is unlocked only after they've entered their credentials (such as a lock
     * pattern or PIN), and credential-encrypted private app data storage is
     * available.
     */
    public static boolean isUserUnlocked(@NonNull Context context) {
        if (Build.VERSION.SDK_INT >= 24) {
            return Api24Impl.isUserUnlocked(context);
        } else {
            return true;
        }
    }

    @RequiresApi(24)
    static class Api24Impl {
        private Api24Impl() {
            // This class is not instantiable.
        }

        static boolean isUserUnlocked(Context context) {
            return context.getSystemService(UserManager.class).isUserUnlocked();
        }
    }
}