Lib code v1.0

AdaptOutput (OutputPlugin subclass)

publish (function)
importsource (function)
export (function)

App

options (Object)
moduleReady (Function)
waitForModule (Function)
on Function)
emit (Function)
preloadConstants (Object)
ERRORS (Object)
head (Function)
post (Function)
get (Function)
put (Function)
patch (Function)
delete (Function)
use (Function)
_preloadModules (Array)
preloadModule (Function)
modulePreloadEventHandler (Function)
preload (Function)
clientErrorHandler (Function)
createServer (Function)
startServer (Function)
restartServer (Function)
run (Function)
mailer (Class) instance
polyglot (Class) instance
getServerURL (Function)
ModulePreloader (Class instance)
assetmanager (Class instance)

AssetManager

preload (Function)
preloadHandle (Function)
hasPermission (Function)
createAsset (Function)
retrieveAsset (Function)
updateAsset (Function)
destroyAsset (Function)
trashAsset (Function)
restoreAsset (Function)
postAsset (Function)
putAsset (Function)
queryAssets (Function)
getAsset (Function)
serveAsset (Function)
assetThumb (Function)
serveSharedAsset (Function)
deleteAsset (Function)
trashAssetByID (Function)
restoreAssetByID (Function)

Auth

errors (Object)
AuthPlugin (Class instance)
hashPassword (Function)
validatePassword (Function)
createToken (Function)
session (Function)
initialize (Function)
preload (Function)
getAuthPlugin (Function)
getAvailableAuthPluginsSync (Function)
loadAuthPlugins (Function)

AuthPlugin

init (Function)
authenticate (Function)
getLoginHtml (Function)
disavow (Function)
internalRegisterUser (Function)
resetPassword (Function)
internalUpdatePassword (Function)
generateResetToken (Function)
internalGenerateResetToken (Function)
isTenantEnabled (Function)

BowerManager

extractPackageInfo (function)
installPlugin (function)
installLatestCompatibleVersion (function)
importPackage (function)

Configuration

serverRoot (string)
tempDir (string)
configFile (string)
conf (object)
mconf (object)
load (function)
setConfig (function)
getConfig (function)
getAllClientSideConfigs (function)
setModuleConfig (function)
getModuleConfig (function)
preload (function)

ContentManager

_contentTypes (object)
_contentHooks (object)
_contentSchemas (object)
addContentHook (function)
processContentHooks (function)
loadContentPlugins (function)
getContentPlugin (function)
setupRoutes (function)
addContentSchema (function)
onDatabaseCreated (function)
create (function)
retrieve (function)
update (function)
destroy (function)

ContentPlugin

getModelName (function) getChildType (function)
getSchemaPath (function)
onDatabaseCreated (function)
hasPermission (function)
create (function)
retrieve (function)
update (function)
destroy (function)
iterateSiblings (function)
destroyChildren (function)

Database (class)

connect (function)
disconnect (function)
isStale (function)
isValidIdentifier (function)
loadSchemas (function)
addModel (function)
addSchema (function)
getModel (function)
getModelNames (function)
buildPopulator (function)
buildQuery (function)
create (function)
retrieve (function)
retrieveOne (function)
update (function)
destroy (function)
importSchema (function)
exportResults (function)

Database (module)

addDatabaseHook (function)
getDatabase (function)
checkConnection (function)
resolveSchemaPath (function)
getAvailableDrivers (function)
getAvailableDriversSync (function)
Database (class)
preload (function)

FileStorage

getFileContents (function)
putFileContents (function)
createReadStream (function)
createWriteStream (function)
deleteFile (function)
copyAsset (function)
moveFile (function)
processFileUpload (function)
createDirectory (function)
removeDirectory (function)
getDirectoryListing (function)
getFileStats (function)

FrameworkHelper

cloneFramework (function)
installFramework (function)

Helpers

schemaToObject (function)
grantSuperPermissions (function)
hasCoursePermission (function)
isValidEmail (function)
replaceAll (function)
slugify (function)
cloneObject (function)

InstallHelpers

DEFAULT_SERVER_REPO (string)
DEFAULT_FRAMEWORK_REPO (string)
exit (function)
showSpinner (function)
hideSpinner (function)
getInput (function)
inputHelpers (function)
checkNodeVersion (function)
checkAllDependencies (function)
checkPrimaryDependencies (function)
checkSecondaryDependencies (function)
getInstalledServerVersion (function)
getLatestServerVersion (function)
getInstalledFrameworkVersion (function)
getLatestFrameworkVersion (function)
getInstalledVersions (function)
getLatestVersions (function)
getUpdateData (function)
getMigrationConfig (function)
syncMigrations (function)
installFramework (function)
updateFramework (function)
cloneRepo (function)
updateFrameworkPlugins (function)
updateAuthoring (function)
buildAuthoring (function)

LocalAuth (Auth subclass)

init (function)
verifyUser (function)
authenticate (function)
disavow (function)
internalRegisterUser (function)
resetPassword (function)
internalResetPassword (function)
generateResetToken (function)
internalGenerateResetToken (function)

LocalFS (FileStorage subclass)

dataRoot (string)
resolvePath (function)
getRelativePath (function)
getFileContents (function)
putFileContents (function)
createWriteStream (function)
createReadStream (function)
deleteFile (function)
moveFile (function)
processFileUpload (function)
createDirectory (function)
removeDirectory (function)
getDirectoryListing (function)
getFileStats (function)
copyAsset (function)
createThumbnail (function)
inspectFile (function)

Logger

logger (class instance)
add (function)
level (function)
clear (function)
log (function)
query (function)
on (function)
once (function)
init (function)

Mailer

testConnection (function)
send (function)

Mongoose (Database subclass)

connect (function)
disconnect (function)
isStale (function)
isValidIdentifier (function)
loadSchemas (function)
buildPopulator (function)
buildQuery (function)
create (function)
retrieve (function)
retrieveOne (function)
update (function)
destroy (function)
addSchema (function)
importSchema (function)
exportResults (function)
getModel (function)
getModelNames (function)

OutputManager

_outputTypes (Object)
getOutputPlugin (function)
setupRoutes (function)
preview (function)
publish (function)

OutputPlugin

getCourseJSON (function)
sanitizeCourseJSON (function)
generateIncludesForCourse (function)
generateIncludesForConfig (function)
addPluginWithDependencies (function)
getUpdatedIncludePlugins (function)
writeCourseJSON (function)
buildFlagExists (function)
clearBuildFlag (function)
applyTheme (function)
writeThemeVariables (function)
writeCustomStyle (function)
writeCourseAssets (function)
applyMenu (function)
preview (function)
publish (function)
export (function)
escapeQuotes (function)

Permissions

ignoreRoute (function)
shouldIgnore (function)
getValidEffects (function)
getActionType (function)
buildResourceString (function)
createPolicy (function)
updatePolicy (function)
getPolicy (function)
getPolicies (function)
addStatement (function)
hasPermission (function)
getUserPolicyStatements (function)
clearPolicies (function)
policyChecker (function)
getUserPermissions (function)

PluginManager

getPluginTypes (function)
getInstalledPlugins (function)
getPlugins (function)
getPlugin (function)
isUpgradeRequired (function)
installPlugin (function)
uninstallPlugin (function)
isInstalled (function)
testPluginState (function)
dependenciesInstalled (function)

Rest

app (object)
init (function)
processRouteQueue (function)
put (function)
patch (function)
get (function)
post (function)
delete (function)

RoleManager

RoleNames (object)
errors (object)
createRole (function)
retrieveRoles (function)
retrieveRole (function)
updateRole (function)
destroyRole (function)
assignRole (function)
assignRoleByName (function)
assignDefaultRoles (function)
unassignRole (function)
installDefaultRoles (function)
syncDefaultRoles (function)
init (function)

Router

options (object)
init (function)

TenantManager

errors (object)
preload (function)
preloadHandle (function)
createTenantFilesystem (function)
createTenant (function)
retrieveTenants (function)
retrieveTenant (function)
updateTenant (function)
destroyTenant (function)
deleteTenant (function)
deleteTenantFilesystem (function)
getDatabaseConfig (function)

UserManager

errors (object)
hasPermission (function)
createNewUser (function)
findOrCreateUser (function)
createUser (function)
retrieveUsers (function)
retrieveUser (function)
updateUser (function)
setUserActive (function)
handleUserCoursesOnDelete (function)
deleteUser (function)
getCurrentUser (function)
setSessionVariable (function)
getSessionVariable (function)
serializeUser (function)
deserializeUser (function)
createUserPasswordReset (function)
retrieveUserPasswordReset (function)
deleteUserPasswordReset (function)
resetUserPassword (function)
logAccess (function)
xHoursAgo (function)
getUserRoles (function)
init (function)