Skip to content

Instantly share code, notes, and snippets.

@wle8300

wle8300/loopback-2.18.0-documentation-menu.html

Created May 24, 2015 18:05
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save wle8300/9a39df7ac573df549d39 to your computer and use it in GitHub Desktop.
Save wle8300/9a39df7ac573df549d39 to your computer and use it in GitHub Desktop.
Download ZIP
Better markup for the Loopback (v2.18.0) docs website at: http://apidocs.strongloop.com/loopback
Raw
loopback-2.18.0-documentation-menu.html
<ul>
<li>
<a href="#">Loopback</a>
<ul>
<li class="lb-class">
<a href="#var-app-loopback">Class: LoopBackApplication</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#app-connector">app.connector</a>
</li>
<li class="lb-method">
<a href="#app-datasource">app.dataSource</a>
</li>
<li class="lb-method">
<a href="#app-enableauth">app.enableAuth</a>
</li>
<li class="lb-method">
<a href="#app-listen">app.listen</a>
</li>
<li class="lb-method">
<a href="#app-model">app.model</a>
</li>
<li class="lb-method">
<a href="#app-models">app.models</a>
</li>
<li class="lb-method">
<a href="#app-remoteobjects">app.remoteObjects</a>
</li>
<li class="lb-method">
<a href="#app-remotes">app.remotes</a>
</li>
<li class="lb-method">
<a href="#app-middlewarefromconfig">app.middlewareFromConfig</a>
</li>
<li class="lb-method">
<a href="#app-definemiddlewarephases">app.defineMiddlewarePhases</a>
</li>
<li class="lb-method">
<a href="#app-middleware">app.middleware</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#loopback">Class: loopback</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#loopback-autoattach">loopback.autoAttach</a>
</li>
<li class="lb-method">
<a href="#loopback-configuremodel">loopback.configureModel</a>
</li>
<li class="lb-method">
<a href="#loopback-createdatasource">loopback.createDataSource</a>
</li>
<li class="lb-method">
<a href="#loopback-createmodel">loopback.createModel</a>
</li>
<li class="lb-method">
<a href="#loopback-findmodel">loopback.findModel</a>
</li>
<li class="lb-method">
<a href="#loopback-getdefaultdatasourcefortype">loopback.getDefaultDataSourceForType</a>
</li>
<li class="lb-method">
<a href="#loopback-getmodel">loopback.getModel</a>
</li>
<li class="lb-method">
<a href="#loopback-getmodelbytype">loopback.getModelByType</a>
</li>
<li class="lb-method">
<a href="#loopback-memory">loopback.memory</a>
</li>
<li class="lb-method">
<a href="#loopback-remotemethod">loopback.remoteMethod</a>
</li>
<li class="lb-method">
<a href="#loopback-setdefaultdatasourcefortype">loopback.setDefaultDataSourceForType</a>
</li>
<li class="lb-method">
<a href="#loopback-template">loopback.template</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#registry">Class: Registry</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#addacl">addACL</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#registry-prototype-autoattach">registry.autoAttach</a>
</li>
<li class="lb-method">
<a href="#loopback-configuremodel-1">loopback.configureModel</a>
</li>
<li class="lb-method">
<a href="#registry-prototype-createdatasource">registry.createDataSource</a>
</li>
<li class="lb-method">
<a href="#loopback-createmodel-1">loopback.createModel</a>
</li>
<li class="lb-method">
<a href="#loopback-findmodel-1">loopback.findModel</a>
</li>
<li class="lb-method">
<a href="#registry-prototype-getdefaultdatasourcefortype">registry.getDefaultDataSourceForType</a>
</li>
<li class="lb-method">
<a href="#loopback-getmodel-1">loopback.getModel</a>
</li>
<li class="lb-method">
<a href="#loopback-getmodelbytype-1">loopback.getModelByType</a>
</li>
<li class="lb-method">
<a href="#registry-prototype-memory">registry.memory</a>
</li>
<li class="lb-method">
<a href="#loopback-setdefaultdatasourcefortype-1">loopback.setDefaultDataSourceForType</a>
</li>
<li class="lb-method">
<a href="#loopback-getcurrentcontext">loopback.getCurrentContext</a>
</li>
<li class="lb-method">
<a href="#loopback-runincontext">loopback.runInContext</a>
</li>
<li class="lb-method">
<a href="#loopback-createcontext">loopback.createContext</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#accesscontext">Class: AccessContext</a>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#accesscontext-prototype-addprincipal">accessContext.addPrincipal</a>
</li>
<li class="lb-method">
<a href="#accesscontext-prototype-getappid">accessContext.getAppId</a>
</li>
<li class="lb-method">
<a href="#accesscontext-prototype-getuserid">accessContext.getUserId</a>
</li>
<li class="lb-method">
<a href="#accesscontext-prototype-isauthenticated">accessContext.isAuthenticated</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#accessrequest">Class: AccessRequest</a>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#accessrequest-prototype-exactlymatches">accessRequest.exactlyMatches</a>
</li>
<li class="lb-method">
<a href="#accessrequest-prototype-isallowed">accessRequest.isAllowed</a>
</li>
<li class="lb-method">
<a href="#accessrequest-prototype-iswildcard">accessRequest.isWildcard</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#principal">Class: Principal</a>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#principal-prototype-equals">principal.equals</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="#base-models">Base models</a>
<ul>
<li class="lb-class">
<a href="#model">Class: Model</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#model-checkaccess">Model.checkAccess</a>
</li>
<li class="lb-method">
<a href="#model-disableremotemethod">Model.disableRemoteMethod</a>
</li>
<li class="lb-method">
<a href="#model-getapp">Model.getApp</a>
</li>
<li class="lb-method">
<a href="#model-remotemethod">Model.remoteMethod</a>
</li>
<li class="lb-method">
<a href="#model-setup">Model.setup</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#persistedmodel">Class: PersistedModel</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#persistedmodel-bulkupdate">PersistedModel.bulkUpdate</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-changes">PersistedModel.changes</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-checkpoint">PersistedModel.checkpoint</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-count">PersistedModel.count</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-create">PersistedModel.create</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-createupdates">PersistedModel.createUpdates</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-currentcheckpoint">PersistedModel.currentCheckpoint</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-destroyall">PersistedModel.destroyAll</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-destroybyid">PersistedModel.destroyById</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-diff">PersistedModel.diff</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-enablechangetracking">PersistedModel.enableChangeTracking</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-exists">PersistedModel.exists</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-find">PersistedModel.find</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-findbyid">PersistedModel.findById</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-findone">PersistedModel.findOne</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-findorcreate">PersistedModel.findOrCreate</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-getchangemodel">PersistedModel.getChangeModel</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-getidname">PersistedModel.getIdName</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-getsourceid">PersistedModel.getSourceId</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-handlechangeerror">PersistedModel.handleChangeError</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-rectifychange">PersistedModel.rectifyChange</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-replicate">PersistedModel.replicate</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-updateall">PersistedModel.updateAll</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-upsert">PersistedModel.upsert</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#persistedmodel-prototype-destroy">persistedModel.destroy</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-getid">persistedModel.getId</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-getidname">persistedModel.getIdName</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-isnewrecord">persistedModel.isNewRecord</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-reload">persistedModel.reload</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-save">persistedModel.save</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-setid">persistedModel.setId</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-updateattribute">persistedModel.updateAttribute</a>
</li>
<li class="lb-method">
<a href="#persistedmodel-prototype-updateattributes">persistedModel.updateAttributes</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="#middleware">Middleware</a>
<ul>
<li class="lb-class">
<a href="#loopback-context">loopback.context</a>
</li>
<li class="lb-class">
<a href="#loopback-favicon">loopback.favicon</a>
</li>
<li class="lb-class">
<a href="#loopback-rest">loopback.rest</a>
</li>
<li class="lb-class">
<a href="#loopback-static">loopback.static</a>
</li>
<li class="lb-class">
<a href="#loopback-status">loopback.status</a>
</li>
<li class="lb-class">
<a href="#rewriteuserliteral">rewriteUserLiteral</a>
</li>
<li class="lb-class">
<a href="#loopback-token">loopback.token</a>
</li>
<li class="lb-class">
<a href="#loopback-urlnotfound">loopback.urlNotFound</a>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a href="#built-in-models">Built-in models</a>
<ul>
<li class="lb-class">
<a href="#accesstoken">Class: AccessToken</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#accesstoken-createaccesstokenid">AccessToken.createAccessTokenId</a>
</li>
<li class="lb-method">
<a href="#accesstoken-findforrequest">AccessToken.findForRequest</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#accesstoken-prototype-validate">accessToken.validate</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#acl">Class: ACL</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#acl-checkaccessforcontext">ACL.checkAccessForContext</a>
</li>
<li class="lb-method">
<a href="#acl-checkaccessfortoken">ACL.checkAccessForToken</a>
</li>
<li class="lb-method">
<a href="#acl-checkpermission">ACL.checkPermission</a>
</li>
<li class="lb-method">
<a href="#acl-getmatchingscore">ACL.getMatchingScore</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#acl-prototype-score">aCL.score</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#application">Class: Application</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#application-authenticate">Application.authenticate</a>
</li>
<li class="lb-method">
<a href="#application-register">Application.register</a>
</li>
<li class="lb-method">
<a href="#application-resetkeys">Application.resetKeys</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#application-prototype-resetkeys">application.resetKeys</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#change">Class: Change</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#change-bothdeleted">Change.bothDeleted</a>
</li>
<li class="lb-method">
<a href="#change-diff">Change.diff</a>
</li>
<li class="lb-method">
<a href="#change-findorcreatechange">Change.findOrCreateChange</a>
</li>
<li class="lb-method">
<a href="#change-getcheckpointmodel">Change.getCheckpointModel</a>
</li>
<li class="lb-method">
<a href="#change-hash">Change.hash</a>
</li>
<li class="lb-method">
<a href="#change-idformodel">Change.idForModel</a>
</li>
<li class="lb-method">
<a href="#change-rectifyall">Change.rectifyAll</a>
</li>
<li class="lb-method">
<a href="#change-rectifymodelchanges">Change.rectifyModelChanges</a>
</li>
<li class="lb-method">
<a href="#change-revisionforinst">Change.revisionForInst</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#change-prototype-conflictswith">change.conflictsWith</a>
</li>
<li class="lb-method">
<a href="#change-prototype-currentrevision">change.currentRevision</a>
</li>
<li class="lb-method">
<a href="#change-prototype-equals">change.equals</a>
</li>
<li class="lb-method">
<a href="#change-prototype-getmodelctor">change.getModelCtor</a>
</li>
<li class="lb-method">
<a href="#change-prototype-isbasedon">change.isBasedOn</a>
</li>
<li class="lb-method">
<a href="#change-prototype-rectify">change.rectify</a>
</li>
<li class="lb-method">
<a href="#change-prototype-type">change.type</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#change-conflict">Class: Change.Conflict</a>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#conflict-prototype-changes">conflict.changes</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-models">conflict.models</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-resolve">conflict.resolve</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-resolvemanually">conflict.resolveManually</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-resolveusingsource">conflict.resolveUsingSource</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-resolveusingtarget">conflict.resolveUsingTarget</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-swapparties">conflict.swapParties</a>
</li>
<li class="lb-method">
<a href="#conflict-prototype-type">conflict.type</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#email">Class: Email</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#email-send">Email.send</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#email-prototype-send">email.send</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#role-object">Class: Role</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#role-getroles">Role.getRoles</a>
</li>
<li class="lb-method">
<a href="#role-isauthenticated">Role.isAuthenticated</a>
</li>
<li class="lb-method">
<a href="#role-isinrole">Role.isInRole</a>
</li>
<li class="lb-method">
<a href="#role-isowner">Role.isOwner</a>
</li>
<li class="lb-method">
<a href="#role-registerresolver">Role.registerResolver</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#rolemapping">Class: RoleMapping</a>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#rolemapping-prototype-application">roleMapping.application</a>
</li>
<li class="lb-method">
<a href="#rolemapping-prototype-childrole">roleMapping.childRole</a>
</li>
<li class="lb-method">
<a href="#rolemapping-prototype-user">roleMapping.user</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#scope">Class: Scope</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#scope-checkpermission">Scope.checkPermission</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="lb-class">
<a href="#user">Class: User</a>
<ul class="lb-method-type">
<li>
Static Methods
<ul>
<li class="lb-method">
<a href="#user-confirm">User.confirm</a>
</li>
<li class="lb-method">
<a href="#user-generateverificationtoken">User.generateVerificationToken</a>
</li>
<li class="lb-method">
<a href="#user-login">User.login</a>
</li>
<li class="lb-method">
<a href="#user-logout">User.logout</a>
</li>
<li class="lb-method">
<a href="#user-normalizecredentials">User.normalizeCredentials</a>
</li>
<li class="lb-method">
<a href="#user-resetpassword">User.resetPassword</a>
</li>
</ul>
</li>
</ul>
<ul class="lb-method-type">
<li>
Instance Methods
<ul>
<li class="lb-method">
<a href="#user-prototype-createaccesstoken">user.createAccessToken</a>
</li>
<li class="lb-method">
<a href="#user-prototype-haspassword">user.hasPassword</a>
</li>
<li class="lb-method">
<a href="#user-prototype-verify">user.verify</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
@ritch
Copy link

ritch commented May 26, 2015

What is the issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment