Liking cljdoc? Tell your friends :D

chromex.app.lock-screen.data

clj

The API that can be used by an app to create and manage data on the Chrome OS lock screen.

The API usability will depend on the user session state:

When the user session is locked, the API usage will only be allowed
from the lock screen context.


When the user session is not locked, the API usage will only be
allowed outside the lock screen context - i.e. from the regular app
context.

Note that apps have reduced access to Chrome apps APIs from the lock screen context.

The API that can be used by an app to create and manage data on the
Chrome OS lock screen.

The API usability will depend on the user session state:

  
    When the user session is locked, the API usage will only be allowed
    from the lock screen context.
  
  
    When the user session is not locked, the API usage will only be
    allowed outside the lock screen context - i.e. from the regular app
    context.
  


Note that apps have reduced access to Chrome apps APIs from the lock screen
context.

* available since Chrome 72
* https://developer.chrome.com/apps/lockScreen.data
raw docstring

api-tableclj

source

createclj/smacro

(create)

Creates a new data item reference - available only in lock screen contexts.

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 [item] where:

|item| - https://developer.chrome.com/apps/lockScreen.data#property-callback-item.

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.

https://developer.chrome.com/apps/lockScreen.data#method-create.

Creates a new data item reference - available only in lock screen contexts.

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 [item] where:

  |item| - https://developer.chrome.com/apps/lockScreen.data#property-callback-item.

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.

https://developer.chrome.com/apps/lockScreen.data#method-create.
sourceraw docstring

create*cljs

(create* config)
source

deleteclj/smacro

(delete id)

Deletes a data item. The data item will not be available through this API anymore. |id| - Identifies the data item to delete.

|id| - https://developer.chrome.com/apps/lockScreen.data#property-delete-id.

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.

https://developer.chrome.com/apps/lockScreen.data#method-delete.

Deletes a data item. The data item will not be available through this API anymore. |id| - Identifies the data item to
delete.

  |id| - https://developer.chrome.com/apps/lockScreen.data#property-delete-id.

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.

https://developer.chrome.com/apps/lockScreen.data#method-delete.
sourceraw docstring

delete*cljs

(delete* config id)
source

gen-callclj

source

gen-wrapclj/smacro

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

get-allclj/smacro

(get-all)

Gets references to all data items available to the app.

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 [items] where:

|items| - https://developer.chrome.com/apps/lockScreen.data#property-callback-items.

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.

https://developer.chrome.com/apps/lockScreen.data#method-getAll.

Gets references to all data items available to the app.

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 [items] where:

  |items| - https://developer.chrome.com/apps/lockScreen.data#property-callback-items.

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.

https://developer.chrome.com/apps/lockScreen.data#method-getAll.
sourceraw docstring

get-all*cljs

(get-all* config)
source

get-contentclj/smacro

(get-content id)

Retrieves content of the data item identified by |id|.

|id| - https://developer.chrome.com/apps/lockScreen.data#property-getContent-id.

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 [data] where:

|data| - https://developer.chrome.com/apps/lockScreen.data#property-callback-data.

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.

https://developer.chrome.com/apps/lockScreen.data#method-getContent.

Retrieves content of the data item identified by |id|.

  |id| - https://developer.chrome.com/apps/lockScreen.data#property-getContent-id.

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 [data] where:

  |data| - https://developer.chrome.com/apps/lockScreen.data#property-callback-data.

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.

https://developer.chrome.com/apps/lockScreen.data#method-getContent.
sourceraw docstring

get-content*cljs

(get-content* config id)
source

on-data-items-available*cljs

(on-data-items-available* config channel & args)
source

set-contentclj/smacro

(set-content id data)

Sets contents of a data item. |id| - Identifies the target data item. |data| - The data item contents to set.

|id| - https://developer.chrome.com/apps/lockScreen.data#property-setContent-id. |data| - https://developer.chrome.com/apps/lockScreen.data#property-setContent-data.

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.

https://developer.chrome.com/apps/lockScreen.data#method-setContent.

Sets contents of a data item. |id| - Identifies the target data item. |data| - The data item contents to set.

  |id| - https://developer.chrome.com/apps/lockScreen.data#property-setContent-id.
  |data| - https://developer.chrome.com/apps/lockScreen.data#property-setContent-data.

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.

https://developer.chrome.com/apps/lockScreen.data#method-setContent.
sourceraw docstring

set-content*cljs

(set-content* config id data)
source

tap-all-eventsclj/smacro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.lock-screen.data namespace.

Taps all valid non-deprecated events in chromex.app.lock-screen.data namespace.
sourceraw docstring

tap-on-data-items-available-eventsclj/smacro

(tap-on-data-items-available-events channel & args)

Dispatched when new data items become available to main, non-lock screen app context - this event is not expected to be dispatched to the app in the lock screen context.

Events will be put on the |channel| with signature [::on-data-items-available [event]] where:

|event| - https://developer.chrome.com/apps/lockScreen.data#property-onDataItemsAvailable-event.

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

https://developer.chrome.com/apps/lockScreen.data#event-onDataItemsAvailable.

Dispatched when new data items become available to main, non-lock screen app context - this event is not expected to be
dispatched to the app in the lock screen context.

Events will be put on the |channel| with signature [::on-data-items-available [event]] where:

  |event| - https://developer.chrome.com/apps/lockScreen.data#property-onDataItemsAvailable-event.

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

https://developer.chrome.com/apps/lockScreen.data#event-onDataItemsAvailable.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close