1.1.0 • Published 9 years ago

jquery-sessiontimeout v1.1.0

Weekly downloads
132
License
MIT
Repository
github
Last release
9 years ago

sessionTimeout

Build Status

Description

After a set amount of time, a dialog is shown to the user with the option to either log out now, or stay connected. If log out now is selected, the page is redirected to a logout URL. If stay connected is selected, a keep-alive URL is requested through AJAX. If no options is selected after another set amount of time, the page is automatically redirected to a timeout URL.

Usage

  1. Include jQuery
  2. Include jQuery UI (for dialog)
  3. Include jquery.sessionTimeout.js
  4. Call $.sessionTimeout(); after document ready

Options

message Text shown to user in dialog after warning period. Default: 'Your session is about to expire.'

keepAliveUrl URL to call through AJAX to keep session alive. This resource should do something innocuous that would keep the session alive, which will depend on your server-side platform. Default: '/keep-alive'

keepAliveAjaxRequestType How should we make the call to the keep-alive url? (GET/POST/PUT) Default: 'POST'

redirUrl URL to take browser to if no action is take after warning period. Default: '/timed-out'

logoutUrl URL to take browser to if user clicks "Log Out Now". Default: '/log-out'

warnAfter Time in milliseconds after page is opened until warning dialog is opened. Default: 900000 (15 minutes)

redirAfter Time in milliseconds after page is opened until browser is redirected to redirUrl. Default: 1200000 (20 minutes)

Links