user.logout.warning Client Message

Ben Tiedt — Fri, 08 Mar 2024 17:50:58 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:50:58

user.logout.warning Client Message

[[messaging JavaScript API Module|Client-side message]] raised when a user's session is nearing expiration. Raised once per second after the warning threshold is crossed before logout is reached. The warning threshold defaults to 45 seconds but is adjustable via the [[authentication JavaScript API Module|authentication]] client API.

Usage

messaging.subscribe('user.logout.warning', function(data) {
    // handle the event
});

Data

remainingSeconds: remaining seconds until logout
renewable: boolean value of whether or not authentication is configured to support renewing via the [[authentication JavaScript API Module|authentication]] client API