Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UserSessionTimeouts

Hierarchy

  • UserSessionTimeouts

Properties

Optional Readonly idle

idle: number

This timeout defines the amount of time in seconds a session will remain active in case there is no activity in the session, closing and invalidating the session upon the defined idle period since the last HTTP request received by the web application.
If you do not need idle session feature, do not set this option.
Defaults to undefined.

Optional Readonly oldSessionAvailabilityAfterRenewal

oldSessionAvailabilityAfterRenewal: number

This timeout defines the amount of time the old session will still be available after it was renewed.
This timeout starts counting from renew session operation, and on elapse will delete the old session.
Usually you will want to keep this timeout as small as possible to give a chance to requests that were issued before renew operation to finish successfully, and then invalidate old session. If {@link UserSessionManagerOptions.timeouts.renewal} option is not set, this option is ignored.
Required when {@link UserSessionManagerOptions.timeouts.renewal} option is set. Recommended value is 5.

Optional Readonly renewal

renewal: number

This timeout defines the amount of time in seconds since session creation after which the session ID is automatically renewed. Renewal happens automatically when user session is read by manager.
Renewal consists in deletion of the old session and creation of a new one.
If you do not need renewal session feature, do not set this option.
Defaults to undefined.