2026-02-13 14:01:00 -07:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< link rel = "prev" href = "../ui/" >
< link rel = "next" href = "../util/" >
< link rel = "icon" href = "../../assets/external/postalpoint.app/images/favicon-voxel.png" >
< meta name = "generator" content = "mkdocs-1.6.1, mkdocs-material-9.7.1" >
< title > User - PostalPoint Plugin Development< / title >
< link rel = "stylesheet" href = "../../assets/stylesheets/main.484c7ddc.min.css" >
< link rel = "stylesheet" href = "../../assets/stylesheets/palette.ab4e12ef.min.css" >
< link rel = "stylesheet" href = "../../assets/external/fonts.googleapis.com/css.49ea35f2.css" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< link rel = "stylesheet" href = "../../assets/styles.css" >
< script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
<!-- Matomo -->
< script >
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.netsyms.net/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '57']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
< / script >
<!-- End Matomo Code -->
< script > "undefined" != typeof _ _md _analytics && _ _md _analytics ( ) < / script >
< / head >
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "blue" data-md-color-accent = "indigo" >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#user-object" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
2026-02-13 14:02:44 -07:00
< div data-md-color-scheme = "default" data-md-component = "outdated" hidden >
< / div >
2026-02-13 14:01:00 -07:00
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "https://postalpoint.app" title = "PostalPoint Plugin Development" class = "md-header__button md-logo" aria-label = "PostalPoint Plugin Development" data-md-component = "logo" >
< img src = "../../assets/logo.svg" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
PostalPoint Plugin Development
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
User
< / span >
< / div >
< / div >
< / div >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" tabindex = "0" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "https://postalpoint.app" title = "PostalPoint Plugin Development" class = "md-nav__button md-logo" aria-label = "PostalPoint Plugin Development" data-md-component = "logo" >
< img src = "../../assets/logo.svg" alt = "logo" >
< / a >
PostalPoint Plugin Development
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../.." class = "md-nav__link" >
< span class = "md-ellipsis" >
Overview
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2" >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
< span class = "md-ellipsis" >
Docs
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2" >
< span class = "md-nav__icon md-icon" > < / span >
Docs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../Docs/Address/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Address object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Carrier_Service/" class = "md-nav__link" >
< span class = "md-ellipsis" >
getCarrierName and getServiceName
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Database/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Database Drivers
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Events/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Event Bus
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/FormPS1583/" class = "md-nav__link" >
< span class = "md-ellipsis" >
FormPS1583 object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Parcel/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Parcel/Package Object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Receipt/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Receipt Objects
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/ReceiptPrinter/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Receipt Printer driver functions
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/TrackingBarcode/" class = "md-nav__link" >
< span class = "md-ellipsis" >
TrackingBarcode class
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
< span class = "md-ellipsis" >
Examples
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Examples
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../Examples/01Minimal/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Minimal Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/02Basic/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Basic Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/03Shipping/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Shipping Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/04CardProcessor/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Card Payments
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/05CryptoProcessor/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Cryptocurrency Payments
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" checked >
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
< span class = "md-ellipsis" >
Plugin API
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Plugin API
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../barcode/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Barcode
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../database/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Database
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../fs/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Fs
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../global%20functions/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Global functions
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../graphics/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Graphics
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../i18n/" class = "md-nav__link" >
< span class = "md-ellipsis" >
I18n
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../kiosk/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Kiosk
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../mailboxes/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Mailboxes
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../pos/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Pos
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../print/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Print
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../reports/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Reports
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../settings/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Settings
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../shipping/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Shipping
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../storage/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Storage
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../ui/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Ui
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
< span class = "md-ellipsis" >
User
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
< span class = "md-ellipsis" >
User
< / span >
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#user-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
user : object
< / span >
< / a >
< nav class = "md-nav" aria-label = "user : object" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#useruser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.User
< / span >
< / a >
< nav class = "md-nav" aria-label = "user.User" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#new-userid-name-password-barcode-enabled" class = "md-nav__link" >
< span class = "md-ellipsis" >
new User(id, name, password, barcode, enabled)
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuser-user" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUser() ⇒ User
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuserid-number" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUserID() ⇒ number
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuserbyid-promiseuser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUserByID() ⇒ Promise.< User>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#userlistusersmanagermode-promisearrayuser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.listUsers([managerMode]) ⇒ Promise.< Array.< User> >
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../util/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Util
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#user-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
user : object
< / span >
< / a >
< nav class = "md-nav" aria-label = "user : object" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#useruser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.User
< / span >
< / a >
< nav class = "md-nav" aria-label = "user.User" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#new-userid-name-password-barcode-enabled" class = "md-nav__link" >
< span class = "md-ellipsis" >
new User(id, name, password, barcode, enabled)
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuser-user" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUser() ⇒ User
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuserid-number" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUserID() ⇒ number
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#usergetuserbyid-promiseuser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.getUserByID() ⇒ Promise.< User>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#userlistusersmanagermode-promisearrayuser" class = "md-nav__link" >
< span class = "md-ellipsis" >
user.listUsers([managerMode]) ⇒ Promise.< Array.< User> >
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 > User< / h1 >
< p > < a name = "user" > < / a > < / p >
< h2 id = "user-object" > user : < code > object< / code > < / h2 >
< p > Access data about employees.< / p >
< p > < strong > Kind< / strong > : global namespace < / p >
< ul >
< li > < a href = "#user" > user< / a > : < code > object< / code > < ul >
< li > < a href = "#user.User" > .User< / a > < ul >
< li > < a href = "#new_user.User_new" > new User(id, name, password, barcode, enabled)< / a > < / li >
< / ul >
< / li >
< li > < a href = "#user.getUser" > .getUser()< / a > ⇒ < code > User< / code > < / li >
< li > < a href = "#user.getUserID" > .getUserID()< / a > ⇒ < code > number< / code > < / li >
< li > < a href = "#user.getUserByID" > .getUserByID()< / a > ⇒ < code > Promise.< User> < / code > < / li >
< li > < a href = "#user.listUsers" > .listUsers([managerMode])< / a > ⇒ < code > Promise.< Array.< User> > < / code > < / li >
< / ul >
< / li >
< / ul >
< p > < a name = "user.User" > < / a > < / p >
< h3 id = "useruser" > user.User< / h3 >
< p > < strong > Kind< / strong > : static class of < a href = "#user" > < code > user< / code > < / a > < br / >
< strong > Properties< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > id< / td >
< td > < code > number< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > name< / td >
< td > < code > string< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > pass< / td >
< td > < code > string< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > barcode< / td >
< td > < code > string< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > enabled< / td >
< td > < code > boolean< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > hasPassword()< / td >
< td > < code > function< / code > < / td >
< td > Returns true if the user has a password set, else false.< / td >
< / tr >
< tr >
< td > checkPassword(string)< / td >
< td > < code > function< / code > < / td >
< td > Returns true if the provided password matches the user's password, or if there is no password set.< / td >
< / tr >
< tr >
< td > icon(number)< / td >
< td > < code > function< / code > < / td >
< td > Returns a SVG data URI with a procedurally-generated icon for the user. Size defaults to 50px if not specified.< / td >
< / tr >
< / tbody >
< / table >
< p > < a name = "new_user.User_new" > < / a > < / p >
< h4 id = "new-userid-name-password-barcode-enabled" > new User(id, name, password, barcode, enabled)< / h4 >
< p > A User object.< / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > id< / td >
< td > < code > number< / code > < / td >
< / tr >
< tr >
< td > name< / td >
< td > < code > string< / code > < / td >
< / tr >
< tr >
< td > password< / td >
< td > < code > string< / code > < / td >
< / tr >
< tr >
< td > barcode< / td >
< td > < code > string< / code > < / td >
< / tr >
< tr >
< td > enabled< / td >
< td > < code > boolean< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > < a name = "user.getUser" > < / a > < / p >
< h3 id = "usergetuser-user" > user.getUser() ⇒ < code > User< / code > < / h3 >
< p > Get the user currently logged in.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#user" > < code > user< / code > < / a > < br / >
< a name = "user.getUserID" > < / a > < / p >
< h3 id = "usergetuserid-number" > user.getUserID() ⇒ < code > number< / code > < / h3 >
< p > Get the current user's ID number.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#user" > < code > user< / code > < / a > < br / >
< a name = "user.getUserByID" > < / a > < / p >
< h3 id = "usergetuserbyid-promiseuser" > user.getUserByID() ⇒ < code > Promise.< User> < / code > < / h3 >
< p > Look up the User for an ID number.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#user" > < code > user< / code > < / a > < br / >
< a name = "user.listUsers" > < / a > < / p >
< h3 id = "userlistusersmanagermode-promisearrayuser" > user.listUsers([managerMode]) ⇒ < code > Promise.< Array.< User> > < / code > < / h3 >
< p > Get a list of all users in the system.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#user" > < code > user< / code > < / a > < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Default< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > [managerMode]< / td >
< td > < code > boolean< / code > < / td >
< td > < code > false< / code > < / td >
< td > If false, list only active/enabled users, and if no users, return a default user account (user ID -1). If true, return all users in the database, and don't return a default account if the list is empty (return an empty list instead).< / td >
< / tr >
< / tbody >
< / table >
< / article >
< / div >
< script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
2026-02-13 14:03:31 -07:00
< script id = "__config" type = "application/json" > { "annotate" : null , "base" : "../.." , "features" : [ "content.code.copy" ] , "search" : "../../assets/javascripts/workers/search.2c215733.min.js" , "tags" : null , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } , "version" : { "alias" : true , "provider" : "mike" } } < / script >
2026-02-13 14:01:00 -07:00
< script src = "../../assets/javascripts/bundle.79ae519e.min.js" > < / script >
< script src = "../../assets/external/unpkg.com/mermaid@11/dist/mermaid.min.js" > < / script >
< / body >
< / html >
