Home
Adapt authoring tool back-end API documentation
v1.0.0-rc.4
Documentation home
Project Website
Technical Discussion Forum
Namespaces
adaptframework
assets
auth
authored
browserslist
config
content
contentplugin
core
courseassets
coursetheme
debug
defaultplugins
errors
jsonschema
lang
localauth
logger
mailer
middleware
mongodb
mongodblogger
ratelimiter
roles
server
sessions
spoortracking
tags
users
Classes
AdaptFrameworkBuildOptions
AdaptFrameworkImportOptions
CollaborationModule
USER_STATUS
DebugFrameworkModule
init
DebugLogsModule
init
DebugModule
init
DebugSchemasModule
init
UiModule
addUiPlugin
build
init
servePage
AdaptFrameworkBuild
build
cachePluginData
copyAssets
copySource
createIdMap
createPreview
createZip
ensureDir
loadAssetData
loadCourseData
recordBuildAttempt
removeOldBuilds
sortContentItems
transformContentItems
writeContentJson
getBuildExpiry
run
AdaptFrameworkImport
cleanUp
convertSchemas
extractAssets
getSortedData
import
importContentObject
importCourseAssets
importCourseData
importCoursePlugins
importTags
loadAssetData
loadContentFile
loadCourseData
prepare
transformData
run
typeToSchema
AdaptFrameworkModule
buildCourse
checkContentAccess
getInstalledPlugins
getLatestVersion
getManifestPlugins
importCourse
init
initRoutes
installFramework
loadSchemas
logStatus
updateFramework
AdaptFrameworkUtils
getHandler
getImportContentCounts
getPluginUpdateStatus
getUpdateHandler
handleImportFile
importHandler
inferBuildAction
postHandler
postUpdateHandler
retrieveBuildData
toBoolean
AbstractApiModule
addRoute
addRoutes
checkAccess
delete
deleteMany
find
getSchema
getSchemaName
init
insert
mapStatusCode
parseQuery
processRequestMiddleware
queryHandler
requestHandler
sanitise
sanitiseRequestDataMiddleware
serveSchema
setDefaultOptions
setUpPagination
setValues
update
useDefaultRouteConfig
validate
validateValues
AbstractApiUtils
argsFromReq
generateApiMetadata
httpMethodToAction
httpMethodToDBFunction
stringifyValues
DataCache
get
prune
AbstractAsset
assetRoot
ffmpeg
ffprobe
hasThumb
isAudio
isImage
isVideo
path
thumb
name
delete
ensureDir
ensureExists
generateThumb
getFileExtension
move
read
resolvePath
updateFile
write
Assetsmodule
createFsWrapper
delete
deleteMany
init
insert
onRequest
performHousekeeping
registerAssetType
serveAssetHandler
setValues
update
LocalAsset
assetRoot
dirname
filename
name
delete
ensureDir
ensureExists
generateMetadata
move
read
resolvePath
write
AbstractAuthModule
authenticate
authenticateHandler
disavowUser
enableHandler
init
register
registerHandler
secureRoute
setUserEnabled
setValues
unsecureRoute
AuthModule
apiMiddleware
init
initAuthData
rootMiddleware
secureRoute
unsecureRoute
AuthToken
secret
decode
find
generate
initRequestData
isSuper
revoke
AuthUtils
createEmptyStore
getConfig
initAuthData
log
Authentication
checkHandler
disavowHandler
disavowUser
generateTokenHandler
init
registerPlugin
registerUser
retrieveTokensHandler
init
Permissions
check
checkRoutes
getScopesForRoute
secureRoute
init
AuthoredModule
checkAccess
init
registerModule
updateAuthor
updateTimestamps
BrowserslistModule
init
ConfigModule
envVarToConfigKey
get
getPublicConfig
has
init
initRouter
processModuleSchema
set
storeEnvSettings
storeSchemaSettings
storeUserSettings
ContentModule
clone
delete
getDescendants
getSchema
getSchemaName
handleClone
handleInsertRecursive
init
insert
insertRecursive
setValues
update
updateEnabledPlugins
updateSortOrder
ContentPluginModule
find
getPluginSchemas
getPluginUses
init
initPlugins
insertOrUpdate
installHandler
installPlugin
installPlugins
isPluginSchema
processPluginFiles
processPluginSchemas
serveSchema
setValues
uninstallHandler
uninstallPlugin
updateHandler
updatePlugin
usesHandler
AbstractModule
getConfig
init
log
onReady
setReady
App
app
args
dependencies
dependencyloader
instance
init
setReady
start
waitForModule
DependencyLoader
load
loadConfigs
loadModule
loadModuleConfig
loadModules
logError
waitForModule
Hook
hasObservers
Types
invoke
onInvoke
tap
untap
Utils
metadataFileName
packageFileName
getArgs
isObject
CourseAssetsModule
extractAssetIds
handleContentEvent
init
setValues
CourseThemeModule
applyHandler
getVariablesString
init
processFileVariables
removeHandler
setValues
writeCustomLess
writeFile
DefaultPluginsModule
init
AdaptError
setData
toString
ErrorModule
init
loadErrors
JsonSchema
addExtension
build
getObjectDefaults
getParent
isBuildValid
load
patch
sanitise
validate
JsonSchemaModule
addKeyword
addStringFormats
createSchema
deregisterSchema
extendSchema
getSchema
init
registerSchema
registerSchemas
Keywords
LangModule
addTranslationUtils
getPhrasesForLang
init
loadPhrases
loadPhrasesForDir
loadRoutes
requestHandler
translate
translateError
LocalAuthModule
authenticate
changePasswordHandler
createPasswordReset
forgotPasswordHandler
handleLockStatus
init
inviteHandler
register
registerSuperHandler
setUserEnabled
setValues
updateUser
validatePasswordHandler
formatRemainingTime
PasswordUtils
compare
createReset
deleteReset
generate
getConfig
getRandomHex
validate
validateReset
LoggerModule
getModuleOverrides
init
isLevelEnabled
isLoggingEnabled
log
colourise
getDateStamp
MailerModule
init
send
testConnection
testEmailHandler
MiddlewareModule
bodyParserJson
bodyParserUrlEncoded
fileUploadParser
init
setDefaultFileOptions
urlUploadParser
exports
MongoDBModule
connect
delete
deleteMany
find
getCollection
getError
getStats
init
insert
parseOptions
replace
setIndex
update
ObjectIdUtils
addSchemaKeyword
create
isValid
parse
parseIds
MongoDBLoggerModule
init
logToDb
setValues
RateLimiterModule
init
middleware
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
addExistenceProps
apiNotFoundHandler
cacheRouteConfig
debugRequestTime
generateRouterMap
genericErrorHandler
handleInternalRoutes
mapHandler
rootNotFoundHandler
SessionsModule
clearSession
init
storeAuthHeader
SpoorTrackingModule
init
insertTrackingId
resetCourseTrackingIds
resetTrackingHandler
TagsModule
autocompleteHandler
delete
insert
registerModule
setValues
UsersModule
find
init
insert
onRequest
processRequestMiddleware
setValues
updateAccess
Externals
Ajv
AjvKeyword
Transport
MongoDBCollection
MongoDBCreateIndexesOptions
MongoDBDeleteOptions
MongoDBFindOneAndReplaceOptions
MongoDBFindOneAndUpdateOptions
MongoDBFindOptions
MongoDBInsertOneOptions
MongoDBMongoClient
MongoDBObjectId
ExpressApp
ExpressRequest
ExpressResponse
ExpressRouter
HttpServer
exports
exports
Builder for the web app
Constructor
new exports
()
Source:
at-utils/lib/UiServer.js
,
line 13