Class: LokiJSHatAdapter

Extends

• HatAdapter

Methods

---

addGroup(group, callback)

Add a group object to the group collection

Parameters:

Name	Type	Description
group	object	The group object
callback	function

Overrides:

• HatAdapter#addGroup

Source:

• adapters/lokijs-hat-adapter.js, line 186

---

addGroups(groups, callback)

Add a groups from array to the group collection

Parameters:

Name	Type	Description
groups	Array	The group object
callback	function

Overrides:

• HatAdapter#addGroups

Source:

• adapters/lokijs-hat-adapter.js, line 196

---

addPermission(permission, callback)

Add a permission object to the permission collection

Parameters:

Name	Type	Description
permission	object	The permission object
callback	function

Overrides:

• HatAdapter#addPermission

Source:

• adapters/lokijs-hat-adapter.js, line 215

---

addPermissions(permissions, callback)

Add a permission from array to the permission collection

Parameters:

Name	Type	Description
permissions	Array	The permission object
callback	function

Source:

• adapters/lokijs-hat-adapter.js, line 225

---

addUser(user, callback)

Add a user object to the user collection

Parameters:

Name	Type	Description
user	object	The user object
callback	function

Source:

• adapters/lokijs-hat-adapter.js, line 176

---

<abstract> findGroup()

Find group

Inherited From:

• HatAdapter#findGroup

Overrides:

• HatAdapter#findGroup

Source:

• adapters/hat-adapter.js, line 141

---

findGroupsByUser()

Find user groups

Inherited From:

• HatAdapter#findGroupsByUser

Overrides:

• HatAdapter#findGroupsByUser

Source:

• adapters/hat-adapter.js, line 116

---

<abstract> findPermission()

Find permission

Inherited From:

• HatAdapter#findPermission

Overrides:

• HatAdapter#findPermission

Source:

• adapters/hat-adapter.js, line 149

---

findPermissionsByUser(user, callback)

Given a user, it tries to fetch it's permissions

Parameters:

Name	Type	Description
user	object	Instance of a user object
callback	function

Overrides:

• HatAdapter#findPermissionsByUser

Source:

• adapters/lokijs-hat-adapter.js, line 347

---

findUser()

Find user

Inherited From:

• HatAdapter#findUser

Overrides:

• HatAdapter#findUser

Source:

• adapters/hat-adapter.js, line 133

---

initialize()

Initialize adapter

Inherited From:

• HatAdapter#initialize

Overrides:

• HatAdapter#initialize

Source:

• adapters/hat-adapter.js, line 28

---

removeGroup(group, callback)

Remove a group from the group collection

Parameters:

Name	Type	Description
group
callback

Overrides:

• HatAdapter#removeGroup

Source:

• adapters/lokijs-hat-adapter.js, line 262

Returns:

Type

*

---

removePermission(permission, callback)

Remove a permission from the permission collection

Parameters:

Name	Type	Description
permission
callback

Overrides:

• HatAdapter#removePermission

Source:

• adapters/lokijs-hat-adapter.js, line 277

Returns:

Type

*

---

removeUser(user, callback)

Remove a user from the user collection

Parameters:

Name	Type	Description
user
callback

Overrides:

• HatAdapter#removeUser

Source:

• adapters/lokijs-hat-adapter.js, line 247

Returns:

Type

*

---

upsertGroup()

Update or insert group (if not exists)

Inherited From:

• HatAdapter#upsertGroup

Overrides:

• HatAdapter#upsertGroup

Source:

• adapters/hat-adapter.js, line 100

---

upsertPermission()

Update or insert permission (if not exists)

Inherited From:

• HatAdapter#upsertPermission

Overrides:

• HatAdapter#upsertPermission

Source:

• adapters/hat-adapter.js, line 108

---

upsertUser()

Update or insert user (if not exists)

Inherited From:

• HatAdapter#upsertUser

Overrides:

• HatAdapter#upsertUser

Source:

• adapters/hat-adapter.js, line 92

---

validateUserWithAllPermissions(user, permissions, callback)

Validate a user against all given permissions
When one of the given permissions is missing for the given user,
given user is not valid.

Parameters:

Name	Type	Description
user	object	User to validate
permissions	Array.<Number>	Array with unsigned integers with permissions (positions starting at 1)
callback	function

Overrides:

• HatAdapter#validateUserWithAllPermissions

Source:

• adapters/lokijs-hat-adapter.js, line 387

---

validateUserWithAnyPermissions(user, permissions, callback)

Validate a user against any given permissions
When one of the given permissions is found for the given user,
the outcome is valid.

Parameters:

Name	Type	Description
user	object	User to validate
permissions	Array.<Number>	Array with unsigned integers with permissions (positions starting at 1)
callback	function

Overrides:

• HatAdapter#validateUserWithAnyPermissions

Source:

• adapters/lokijs-hat-adapter.js, line 413