Jakarta > Tapestry
Jakarta
 

Timeout

Displays a message to the user when a certain amount of time remains to the expiration of the session.

Parameters

Name Type Direction Required Default Description
warningTime int in no 300 The number of seconds before session expiration when a warning message will appear.
autoProlongTime int in no 900 The number of seconds before session expiration when the session will be automatically prolonged upon user activity.
warningMessage String in no The connection was inactive for more than {0} minutes. Your session will expire at {1}.\\n Please click OK to continue your work or CANCEL to close the session. The warning message that will appear when the session is about to exipre. Here {0} is replaced by the number of minutes that remain until expiration and {1} is replaced with the time when the expiration will occur.
expirationMessage String in no Your session has expired. Please log in again. The message that will appear when the session exipres and the user needs to log in again.
disableWarning boolean in no false Do not display a warning message after 'warningTime' seconds.
disableAutoProlong boolean in no false Disable the automatic prolonging of a session after 'autoProlongTime' seconds upon user activity.
expirationFunction String in no null The JavaScript function that will be invoked when the session expires.

Body: removed

Informal parameters: forbidden

Reserved parameters: none

Examples

<html>
  <head>
    <title>Timeout Example</title>
  </head>
  <body>
    <span jwcid="@contrib:Timeout" warningTime="100"/>
  </body>
</html>