Keyguard Manager

Non-Visible component
Category Requires Version
Utilities API 19, Android 4.4 - 4.4.4 KitKat 1

Overview

A non-visible component that authenticates the user using their preferred security option.

Permissions

Events

On Authentication Request

Event to detect a authentication request was called.

Params
is Authenticated Boolean

On Dissmiss Keyguard Request

Event to detect a dissmiss request keyguard was called.

Params
succeeded Boolean
cancelled Boolean

Methods

Request Dismiss Keyguard

If the device is currently locked, requests the Keyguard to be dismissed. Works only for devices with Android 8+

Show Authentication Screen

Create the Confirm Credentials screen. You can customize the title and description. Or we will provide a generic one for you if you leave it empty. Works only for devices with Android 5+

Show When Locked

Specifies whether an Activity should be shown on top of the lock screen whenever the lockscreen is up and the activity is resumed. Normally an activity will be transitioned to the stopped state if it is started while the lockscreen is up, but with this flag set the activity will remain in the resumed state visible on-top of the lock screen.

Params
enabled Boolean

Properties

Description

Text Default: Confirm your screen lock. ➖ Read Write - Designer Blocks

Returns the keyguard manager description text.

is Device Locked

Boolean ➖ Read - Blocks

Returns whether the device is currently locked and requires a PIN, pattern or password to unlock. Works only for devices with Android 5.1+

is Device Secure

Boolean ➖ Read - Blocks

Returns whether the device is secured with a PIN, pattern or password. Works only for devices with Android 6+

is Keyguard Locked

Boolean ➖ Read - Blocks

Return whether the keyguard is currently locked.

is Keyguard Secure

Boolean ➖ Read - Blocks

Return whether the keyguard is secured by a PIN, pattern or password or a SIM card is currently locked.

Title

Text Default: Unlock ➖ Read Write - Designer Blocks

Returns the keyguard manager title text.


Last update: January 27, 2020