Class: Session

Methods

---

<static> getSession()

Get the Session object for an application

Source:

• rest/Session.js, line 267

---

clearMessages()

Clear messages (and init messages if they didn't exist)

Source:

• rest/Session.js, line 198

---

clearRequest(req)

Clear session request object

Parameters:

Name	Type	Description
req	Request

Source:

• rest/Session.js, line 172

---

clearResponse(req)

Clear session response object

Parameters:

Name	Type	Description
req	Request

Source:

• rest/Session.js, line 118

---

deleteRequest(req, property)

Delete a value from our session request object

Parameters:

Name	Type	Description
req	Request
property	String	property name, can use dot to build a structured JSON

Source:

• rest/Session.js, line 161

Returns:

the deleted entry

Type

any

---

deleteResponse(req, property)

Delete a value from our session response object

Parameters:

Name	Type	Description
req	Request
property	String	property name, can use dot to build a structured JSON

Source:

• rest/Session.js, line 107

Returns:

the deleted entry

Type

any

---

getMessages()

Get message objects

Source:

• rest/Session.js, line 210

---

getRequest(req, property [, deleteEntry])

Get a value from our session request object

Parameters:

Name	Type	Argument	Default	Description
req	Request
property	String			property name, can use dot to build a structured JSON
deleteEntry	Boolean	<optional>	true	if set to true, delete response object

Source:

• rest/Session.js, line 144

---

getResponse(req, property [, deleteEntry])

Get a value from our session response object

Parameters:

Name	Type	Argument	Default	Description
req	Request
property	String			property name, can use dot to build a structured JSON
deleteEntry	Boolean	<optional>	true	if set to true, delete response object

Source:

• rest/Session.js, line 90

---

init()

Middleware to initialize our session logic

Source:

• rest/Session.js, line 45

---

initMessages()

Create the objects to hold flash messages if needed.

Source:

• rest/Session.js, line 181

---

setErrorMessage()

Saves an error message

Source:

• rest/Session.js, line 250

---

setInfoMessage()

Saves an info message

Source:

• rest/Session.js, line 236

---

setMessage()

Set a new message

Source:

• rest/Session.js, line 222

---

setRequest(req, property, value)

Saves 'value' into our session request object

Parameters:

Name	Type	Description
req	Request
property	String	property name, can use dot to build a structured JSON
value	any

Source:

• rest/Session.js, line 131

---

setResponse(req, property, value)

Saves 'value' into our session response object

Parameters:

Name	Type	Description
req	Request
property	String	property name, can use dot to build a structured JSON
value	any

Source:

• rest/Session.js, line 77

---

setSuccessMessage()

Saves a success message

Source:

• rest/Session.js, line 257

---

setWarningMessage()

Saves a warning message

Source:

• rest/Session.js, line 243