Frontend Play

Table Of Content

Action	Call
User Related Actions
Login User	jsRoutes.controllers.User.login()
Logout User	jsRoutes.controllers.User.logout()
Get Maps of User on Server	jsRoutes.controllers.User.mapListFromDB()
Mindmap Related Actions
Get Information
Get complete Mindmap as Json	jsRoutes.controllers.MindMap.map(String mapId)
Get chunked Mindmap as Json	jsRoutes.controllers.MindMap.map(String mapId, Integer nodeCount)
Get Node with all Children as Json	jsRoutes.controllers.MindMap.getNode(String mapId, String nodeId)
Get Node with some Children as Json	jsRoutes.controllers.MindMap.getNode(String mapId, String nodeId, Integer nodeCount)
Listen for updates on Map	jsRoutes.controllers.MindMap.listenForUpdates(String mapId)
Fetch Updates Since Revision	jsRoutes.controllers.MindMap.fetchUpdatesSinceRevision(String mapId, Integer revision)
Gaining and Releasing locks
Request Lock for a Node	jsRoutes.controllers.MindMap.requestLock(String mapId)
Release Lock for a Node	jsRoutes.controllers.MindMap.releaseLock(String mapId)
Modifying a Mindmap
Create Node in Map	jsRoutes.controllers.MindMap.createNode(String mapId)
Change Node in Map	jsRoutes.controllers.MindMap.changeNode(String mapId)
Move Node in Map	jsRoutes.controllers.MindMap.moveNode(String mapId)
Delete Node in Map	jsRoutes.controllers.MindMap.deleteNode(String mapId)

Detailed Informations

Login

Method	POST
Action	jsRoutes.controllers.User.login()
Form Data	username: String password: String
Requires	Nothing
Returns	303 Redirect

Logout

Method	GET
Action	jsRoutes.controllers.User.logout()
Form Data	---
Requires	Logged in User
Returns	303 Redirect

Map Info From Database

Method	GET
Action	jsRoutes.controllers.User.mapListFromDB()
Form Data	---
Requires	Logged in User
Returns	List with MindMapInfo Objects

Mindmap As Json

Method	GET
Action	jsRoutes.controllers.MindMap.map(String mapId) jsRoutes.controllers.MindMap.map(String mapId, Integer nodeCount)
Params	mapId = Id of the map (currently mmIdOnServer) nodeCount = soft limit of maximum nodes
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	A MindMap Object

Node As Json

Method	GET
Action	jsRoutes.controllers.MindMap.getNode(String mapId,Strin nodeId) jsRoutes.controllers.MindMap.getNode(String mapId,Strin nodeId, Integer nodeCount)
Params	mapId = Id of the map (currently mmIdOnServer) nodeId = Id of node nodeCount = soft limit of maximum nodes
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	A DefaultNode Object

Listen for Updates on Map

Method	GET
Action	jsRoutes.controllers.MindMap.listenForUpdates(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	Status 200 OK = update occured Status 304 Not Modified = When for 30 seconds nothing have changed

Fetch Updates since Revision

Method	GET
Action	jsRoutes.controllers.MindMap.fetchUpdatesSinceRevision(String mapId, Integer revision)
Params	mapId = Id of the map (currently mmIdOnServer) revision = last known revision, to get all updates from there
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	List of MapUpdate Objects

Request Lock

Method	POST
Action	jsRoutes.controllers.MindMap.requestLock(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of Node
Requires	Logged in User Right to Access Map Nobody else has lock on the node
Returns	Status 200 OK = success Status 412 Precondition Failed = failure

Release Lock

Method	POST
Action	jsRoutes.controllers.MindMap.releaseLock(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of Node
Requires	Logged in User Right to Access Map Lock on Node
Returns	Status 200 OK = success Status 412 Precondition Failed = failure

Create Node

Method	POST
Action	jsRoutes.controllers.MindMap.createNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	parentNodeId = Id of parent where the new node gets attached to
Requires	Logged in User Right to Access Map
Returns	A DefaultNode Object, which represents the created node

Remove Node

Method	DELETE
Action	jsRoutes.controllers.MindMap.deleteNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of node to delete
Requires	Logged in User Right to Access Map No Lock on node or child node
Returns	Status 200 OK = success Status 412 Precondition Failed = failure

Change Node

Method	POST
Action	jsRoutes.controllers.MindMap.changeNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of node with changes AttributeValueMapJson = Object with {"attribute": value, "attribute2": value2}
attribute-definitions	folded -> boolean isHtml -> boolean attributes -> ["key1%:%value1","key2%:%value2",...] hGap -> integer shiftY -> integer note -> string icons -> ["icon1","icon2",...] image -> Not yet implemented link -> string (URI) nodeText -> string
Requires	Logged in User Right to Access Map Lock on Node
Returns	List of MapUpdate Objects

Move Node

Method	POST
Action	jsRoutes.controllers.MindMap.moveNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	newParentNodeId = Id of the new parent node nodetoMoveId = Id of node, which is moved newIndex = new position in child list (0 = top)
Requires	Logged in User Right to Access Map
Returns	Status 200 OK = success Status 412 Precondition Failed = failure