AjaxSessionPing Class Reference

Inherits er::ajax::AjaxDynamicElement.

Collaboration diagram for AjaxSessionPing:

[legend]

List of all members.

Classes
class	Action
Public Member Functions
	AjaxSessionPing (String name, NSDictionary associations, WOElement children)
void	appendToResponse (WOResponse response, WOContext context)
NSDictionary	createAjaxOptions (WOComponent component)
WOActionResults	handleRequest (WORequest request, WOContext context)
Protected Member Functions
void	addRequiredWebResources (WOResponse response, WOContext context)

---

Detailed Description

Simple component to ping the session in the background. It can do two things. The first is to execute JavaScript if the session is no longer valid. The default action is to close the window that the ping came from. The second thing it can do is to keep the session alive. This can be useful if you want the session to not time out on particular pages. It should be used with caution as it can prevent scheduled restarts if the user leaves the browser window open.

frequency the period between pings of the application (optional, default 60 seconds) keepSessionAlive true if session should be checked out to reset timeout when the application is pinged (optional, default false) parameters optional URL parameter string appended when application is pinged (optional, no default) onFailure function to execute if the session has expired or other HTTP error code returned from ping (optional, default "function(response) { window.close();}") asynchronous true if the ping should be made asynchronously (optional, default true) evalScripts true if the ping results may contain JavaScript that should be evaluated (optional, default false) method the HTTP request method to use for the ping (optional, default "get")

Author:

chill

---

Constructor & Destructor Documentation

AjaxSessionPing	(	String	name,
		NSDictionary	associations,
		WOElement	children
	)

---

Member Function Documentation

void addRequiredWebResources	(	WOResponse	response,
		WOContext	context
	)			[protected, virtual]

Uses Prototype and Wonder

Implements AjaxDynamicElement.

void appendToResponse	(	WOResponse	response,
		WOContext	context
	)

Appends script to start Ajax.ActivePeriodicalUpdater to the response.

Reimplemented from AjaxDynamicElement.

NSDictionary createAjaxOptions

(

WOComponent

component

)

Gathers the bindings into an AjaxOptions dictionary.

Parameters:

component

the component to evaluate the bindings in

Returns:

the bindings in the form of an AjaxOptions dictionary

WOActionResults handleRequest	(	WORequest	request,
		WOContext	context
	)			[virtual]

Unused.

Implements AjaxDynamicElement.

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxSessionPing.java