Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Documentation
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
2
Issues
2
List
Board
Labels
Milestones
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
snac
Documentation
Commits
4e8d69bd
Commit
4e8d69bd
authored
Mar 31, 2016
by
Tom Laudeman
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
draft method list for the API
parent
90be9b4a
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
9 deletions
+9
-9
DBUser API.md
Requirements/DBUser API.md
+9
-9
No files found.
Requirements/DBUser API.md
View file @
4e8d69bd
...
@@ -193,56 +193,56 @@ success.
...
@@ -193,56 +193,56 @@ success.
---
---
saveUser(snac
\d
ata
\U
ser $user)
`saveUser(snac\data\User $user)`
Update a user record. Verify that read-only fields match, overwrite everthing else with values from the User
Update a user record. Verify that read-only fields match, overwrite everthing else with values from the User
object. Return true for success.
object. Return true for success.
---
---
readUser($userID or $email)
`readUser($userID or $email)`
Return a User object for the user id or email. Return false on failure.
Return a User object for the user id or email. Return false on failure.
---
---
disableUser(snac
\d
ata
\U
ser $user)
`disableUser(snac\data\User $user)`
Disable log in to this account. Update table appuser.active to false. Return true on success.
Disable log in to this account. Update table appuser.active to false. Return true on success.
---
---
addUserRole(snac
\d
ata
\U
ser $user, $newRole)
`addUserRole(snac\data\User $user, $newRole)`
Add a role to the User via table appuser_role_link. Return true on success.
Add a role to the User via table appuser_role_link. Return true on success.
---
---
listRoles()
`listRoles()`
List all system roles. The simpliest form would be an associative list with keys: id, label, description.
List all system roles. The simpliest form would be an associative list with keys: id, label, description.
---
---
createRole($label, $description)
`createRole($label, $description)`
Create a new role with $label and $description. Return true on success.
Create a new role with $label and $description. Return true on success.
---
---
checkPassword(snac
\d
ata
\U
ser $user, $passwd)
`checkPassword(snac\data\User $user, $passwd)`
Check $passwd matches the password stored for snac
\d
ata
\U
ser. Return true on success.
Check $passwd matches the password stored for snac
\d
ata
\U
ser. Return true on success.
---
---
addSession(snac
\d
ata
\U
ser $user, $accessToken, $expire)
`addSession(snac\data\User $user, $accessToken, $expire)`
Add a new session token $accessToken with expiration time $expire for $user. Update if $accessToken exists.
Add a new session token $accessToken with expiration time $expire for $user. Update if $accessToken exists.
---
---
checkSessionActive(snac
\d
ata
\U
ser $user, $accessToken)
`checkSessionActive(snac\data\User $user, $accessToken)`
Check that a session is active (not expired) for $user and $accessToken. Time is assumed to be "now". Return
Check that a session is active (not expired) for $user and $accessToken. Time is assumed to be "now". Return
true for success (session is active now).
true for success (session is active now).
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment