Home
Adapt authoring tool back-end API documentation
v1.0.0-rc.7
Documentation home
Project Website
Technical Discussion Forum
Namespaces
adaptframework
assets
auth
exports.createEmptyStore
exports.initAuthData
authored
content
exports.extractAssetIds
contentplugin
core
exports.stringifyValues
coursetheme
exports.getVariablesString
exports.processCustomStyling
jsonschema
localauth
exports.compare
exports.getRandomHex
exports.validate
mailer
middleware
exports.validateUploadedFiles
mongodb
exports.convertObjectIds
exports.createObjectId
exports.isObjectId
exports.isValidObjectId
exports.parseObjectId
mongodblogger
roles
server
exports.addExistenceProps
exports.cacheRouteConfig
exports.generateRouterMap
exports.getAllRoutes
exports.loadRouteConfig
exports.mapHandler
exports.registerRoutes
spoortracking
tags
users
Classes
AdaptFrameworkBuildOptions
AdaptFrameworkImportOptions
BuildCache
getPath
has
invalidate
populate
restore
AdaptFrameworkBuild
applySchemaDefaults
build
cachePluginData
copyAssets
createIdMap
loadAssetData
loadCourseData
prepareZip
recordBuildAttempt
removeOldBuilds
sortContentItems
transformContentItems
writeContentJson
writeLanguageManifest
getBuildExpiry
run
AdaptFrameworkImport
cleanUp
flattenContentJson
generateSummary
getSortedData
import
importContentObject
importCourseAssets
importCourseData
importCoursePlugins
importTags
loadAssetData
loadContentFile
loadCourseData
loadPluginData
migrateCourseData
patchCustomStyle
patchThemeName
prepare
resolveAssets
restoreUpdatedPlugins
rollback
transformData
unflattenContentJson
run
typeToSchema
AdaptFrameworkModule
buildCourse
checkContentAccess
checkVersionCompatibility
getInstalledPlugins
getLatestVersion
getManifestPlugins
getPluginHash
importCourse
init
initRoutes
installFramework
invalidatePrebuiltCache
loadSchemas
logStatus
migrateCourses
prebuildCache
updateFramework
AbstractApiModule
addRoute
addRoutes
applyRouteConfig
checkAccess
delete
deleteMany
find
findOne
generateApiMetadata
getSchema
getSchemaName
init
insert
mapStatusCode
parseQuery
processRequestMiddleware
queryHandler
replacePlaceholders
requestHandler
sanitise
sanitiseRequestDataMiddleware
serveSchema
setDefaultOptions
setUpPagination
setValues
update
updateMany
validate
validateValues
AbstractAsset
assetRoot
hasThumb
isAudio
isImage
isVideo
path
thumb
name
delete
ensureDir
ensureExists
generateThumb
getFileExtension
move
read
resolvePath
updateFile
write
Assetsmodule
checkDuplicate
createFsWrapper
delete
deleteMany
ensureLibPermissions
find
init
insert
onRequest
performHousekeeping
registerAssetType
serveAssetHandler
setValues
update
LocalAsset
assetRoot
dirname
filename
name
delete
ensureDir
ensureExists
move
read
resolvePath
write
AbstractAuthModule
applyRoutes
authenticate
authenticateHandler
disavowUser
enableHandler
getDefaultRoutes
init
register
registerHandler
secureRoute
setUserEnabled
setValues
unsecureRoute
AuthModule
apiMiddleware
init
initAuthData
initSessions
rootMiddleware
secureRoute
storeAuthHeader
unsecureRoute
AuthToken
secret
decode
find
generate
initRequestData
isSuper
revoke
Authentication
checkHandler
disavowHandler
disavowUser
generateTokenHandler
init
registerPlugin
registerSchema
registerUser
retrieveTokensHandler
init
Permissions
check
checkRoutes
getScopesForRoute
secureRoute
init
AuthoredModule
init
registerModule
registerSchemas
updateAuthor
updateTimestamps
ContentModule
clone
computeAssetIds
delete
deleteCounters
enforceAssetNotInUse
findMaxSeq
generateFriendlyIds
getSchema
getSchemaName
handleClone
handleInsertRecursive
handleTree
init
insert
insertRecursive
registerConfigSchemas
setValues
touchCourse
update
updateEnabledPlugins
updateSortOrder
ContentTree
getAncestors
getById
getByType
getChildren
getComponentNames
getDescendants
getSiblings
ContentPluginModule
backupPluginVersion
delete
find
getMissingPlugins
getMostRecentBackup
getPluginSchemas
getPluginUses
init
initPlugins
insertOrUpdate
installHandler
installPlugin
installPlugins
isPluginSchema
processPluginSchemas
reregisterPluginSchemas
restorePluginFromBackup
serveSchema
setValues
syncPluginData
updateHandler
updatePlugin
usesHandler
AbstractModule
getConfig
init
log
onReady
setReady
AdaptError
setData
toString
App
app
args
config
dependencies
dependencyloader
errors
git
lang
logger
instance
getGitInfo
init
waitForModule
Config
get
getPublicConfig
has
load
processModuleSchema
resolveDirectory
storeEnvSettings
storeSchemaSettings
storeUserSettings
envVarToConfigKey
DataCache
get
prune
DependencyLoader
loadConfigs
loadModule
loadModuleConfig
loadModules
log
logProgress
waitForModule
Errors
Hook
hasObservers
Types
_invokeMiddleware
invoke
onInvoke
tap
untap
Lang
loadPhrases
substituteData
translate
Logger
log
getIdOverrides
getLineOverrides
getModuleOverrides
isLevelEnabled
isLoggingEnabled
CourseThemeModule
applyHandler
init
processFileVariables
removeHandler
setValues
writeCustomLess
writeFile
JsonSchemaModule
addKeyword
addStringFormats
createSchema
deregisterSchema
extendSchema
getSchema
init
logSchemas
registerSchema
registerSchemas
resetSchemaRegistry
LocalAuthModule
authenticate
changePasswordHandler
createPasswordReset
forgotPasswordHandler
handleLockStatus
init
inviteHandler
register
registerSuper
registerSuperHandler
setUserEnabled
setValues
updateUser
validatePasswordHandler
formatRemainingTime
PasswordUtils
compare
createReset
deleteReset
generate
getConfig
getRandomHex
validate
validateReset
AbstractMailTransport
getConfig
send
test
FilesystemTransport
send
test
MailerModule
init
send
testEmailHandler
SmtpTransport
send
test
MiddlewareModule
addTranslationUtils
bodyParserJson
bodyParserUrlEncoded
configRequestHandler
fileUploadParser
init
langRequestHandler
rateLimiter
setDefaultFileOptions
urlUploadParser
MongoDBModule
addSchemaKeyword
connect
delete
deleteMany
find
getCollection
getError
getStats
init
insert
logDuplicateIndexError
parseOptions
replace
setIndex
update
updateMany
MongoDBLoggerModule
init
logToDb
setValues
RolesModule
getScopesForRole
init
initConfigRoles
initDefaultRoles
onUpdateRoles
setValues
shortNamesToIds
Router
addHandlerMiddleware
addMiddleware
addRoute
createChildRouter
flattenRouters
getHandlerMiddleware
init
log
validateRoute
warnOnInited
ServerModule
close
init
listen
start
static
ServerUtils
addErrorHandler
apiNotFoundHandler
debugRequestTime
genericErrorHandler
handleInternalRoutes
methodNotAllowedHandler
rootNotFoundHandler
SpoorTrackingModule
init
insertTrackingId
resetCourseTrackingIds
resetTrackingHandler
TagsModule
autocompleteHandler
delete
init
insert
registerModule
registerSchema
registerSchemas
setValues
transferHandler
UiModule
addUiPlugin
build
init
servePage
UsersModule
find
init
insert
onRequest
processRequestMiddleware
setValues
updateAccess
Externals
Ajv
AjvKeyword
MongoDBCollection
MongoDBCreateIndexesOptions
MongoDBDeleteOptions
MongoDBFindOneAndReplaceOptions
MongoDBFindOneAndUpdateOptions
MongoDBFindOptions
MongoDBInsertOneOptions
MongoDBMongoClient
MongoDBObjectId
MongoDBUpdateOptions
ExpressApp
ExpressRequest
ExpressResponse
ExpressRouter
HttpServer
adapt-authoring-users/index.js
/** * User data functionlity * @namespace users */ export { default } from './lib/UsersModule.js'