chromex.app.quick-unlock-private — binaryage/chromex 0.6.4

clj

Use the chrome.quickUnlockPrivate API to change whether the lock screen is enabled and which modes are allowed (active) for unlocking a Chrome OS device from the lock screen. The API is also used to set quick unlock credentials. Note: The API is named 'quickUnlock' for historical reasons but it should be used for all lock screen settings. Note: This API can not be used to actually unlock the device.

• available since Chrome 53

api-table clj

check-credential clj/s macro

(check-credential mode credential)

Checks if the given credential can be used for the given unlock mode. Enterprise policy can change credential requirements.

|mode| - The quick unlock mode that is used. |credential| - The given credential.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [check] where:

|check| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

check-credential* cljs

(check-credential* config mode credential)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-active-modes clj/s macro

(get-active-modes)

Returns the quick unlock modes that are currently enabled and usable on the lock screen.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [modes] where:

|modes| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

get-active-modes* cljs

(get-active-modes* config)

get-auth-token clj/s macro

(get-auth-token account-password)

Returns a token that can be used for future operations and the number of seconds until the token expires.

|account-password| - The account password for the logged in user.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [result] where:

|result| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

get-auth-token* cljs

(get-auth-token* config account-password)

get-available-modes clj/s macro

(get-available-modes)

Returns the set of quick unlock modes that are available for the user to use. Some quick unlock modes may be disabled by policy.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [modes] where:

|modes| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

get-available-modes* cljs

(get-available-modes* config)

get-credential-requirements clj/s macro

(get-credential-requirements mode)

Gets the credential requirements for the given unlock mode.

|mode| - The quick unlock mode that is used.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [requirements] where:

|requirements| - ?

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

get-credential-requirements* cljs

(get-credential-requirements* config mode)

on-active-modes-changed* cljs

(on-active-modes-changed* config channel & args)

set-lock-screen-enabled clj/s macro

(set-lock-screen-enabled token enabled)

Sets the lock screen enabled state. NOTE: The lock enabled state is reflected in the settings.enable_screen_lock pref, which can be read but not written using the settings_private API (which also provides policy information). This API must be used to change the pref.

|token| - The token returned by 'getAuthToken'. |enabled| - Whether to enable the lock screen.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

set-lock-screen-enabled* cljs

(set-lock-screen-enabled* config token enabled)

set-modes clj/s macro

(set-modes token modes credentials)

Update the set of quick unlock modes that are currently active/enabled.

|token| - The token returned by 'getAuthToken'. |modes| - The quick unlock modes that should be active. |credentials| - The associated credential for each mode. To keep the credential the same for the associated mode, pass an empty string.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

set-modes* cljs

(set-modes* config token modes credentials)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.quick-unlock-private namespace.

tap-on-active-modes-changed-events clj/s macro

(tap-on-active-modes-changed-events channel & args)

Called after the active set of quick unlock modes has changed.

Events will be put on the |channel| with signature [::on-active-modes-changed [active-modes]] where:

|active-modes| - The set of quick unlock modes which are now active.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.