chromex.ext.users-private

Liking cljdoc? Tell your friends :D

Mostly clj/s.
Exceptions indicated.

add-user
add-user*^cljs
api-table^clj
gen-call^clj
gen-wrap
get-current-user
get-current-user*^cljs
get-login-status
get-login-status*^cljs
get-users
get-users*^cljs
is-user-in-list
is-user-in-list*^cljs
is-user-list-managed
is-user-list-managed*^cljs
remove-user
remove-user*^cljs
tap-all-events

clj

Use the chrome.usersPrivate API to manage users.

available since Chrome master

Use the chrome.usersPrivate API to manage users.

* available since Chrome master

raw docstring

add-user^clj/smacro

(add-user email)

Adds a new user with the given email to the user list. The callback is called with true if the user was added succesfully, or with false if not (e.g. because the user was already present, or the current user isn't the owner).

|email| - ?

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

|success| - ?

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.

Adds a new user with the given email to the user list. The callback is called with true if the user was added succesfully,
or with false if not (e.g. because the user was already present, or the current user isn't the owner).

  |email| - ?

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

  |success| - ?

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.

source raw docstring

add-user*^cljs

(add-user* config email)

source

api-table^clj

source

gen-call^clj

source

gen-wrap^clj/smacro

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

source

get-current-user^clj/smacro

(get-current-user)

Returns the current 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 [user] where:

|user| - ?

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.

Returns the current 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 [user] where:

  |user| - ?

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.

source raw docstring

get-current-user*^cljs

(get-current-user* config)

source

(get-login-status)

Get login status.

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

|status| - ?

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 login status.

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

  |status| - ?

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.

source raw docstring

(get-login-status* config)

source

get-users^clj/smacro

(get-users)

Gets a list of known users.

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

|users| - ?

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.

Gets a list of known users.

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

  |users| - ?

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.

source raw docstring

get-users*^cljs

(get-users* config)

source

is-user-in-list^clj/smacro

(is-user-in-list email)

Checks to see if the user is already present in the user list.

|email| - ?

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

|found| - ?

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.

Checks to see if the user is already present in the user list.

  |email| - ?

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

  |found| - ?

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.

source raw docstring

is-user-in-list*^cljs

(is-user-in-list* config email)

source

is-user-list-managed^clj/smacro

(is-user-list-managed)

Whether the user list is managed by enterprise.

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

|managed| - ?

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.

Whether the user list is managed by enterprise.

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

  |managed| - ?

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.

source raw docstring

is-user-list-managed*^cljs

(is-user-list-managed* config)

source

remove-user^clj/smacro

(remove-user email)

Removes the user with the given email from the user list. The callback is called with true if the user was removed succesfully, or with false if not (e.g. because the user was not already present, or the current user isn't the owner).

|email| - ?

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

|success| - ?

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.

Removes the user with the given email from the user list. The callback is called with true if the user was removed
succesfully, or with false if not (e.g. because the user was not already present, or the current user isn't the owner).

  |email| - ?

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

  |success| - ?

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.

source raw docstring

remove-user*^cljs

(remove-user* config email)

source

tap-all-events^clj/smacro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.users-private namespace.

Taps all valid non-deprecated events in chromex.ext.users-private namespace.

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close