entSession
Syntax
app.entSession;
Access
readonly
Parameters
Return value Session
The Studio Server Session object.
Description
The entSession property gives access to the Studio Server session by returning a Session object. Use this object to log in and out of Studio Server, retrieve session details such as the active server, URL, user, and ticket, and query server data such as publications, issues, and users.
Examples
Check if there is an active session
When activeUrl is empty, there is no active session.
// Check if the session is active.
var sessionObject = app.entSession;
var activeSession = sessionObject.activeUrl !== "";
// When logged in, activeSession is now 'true'.
// When not logged in, activeSession is 'false'.
Read active session details
// Retrieve the current session details.
var session = app.entSession;
var server = session.activeServer;
var url = session.activeUrl;
var user = session.activeUser;
var ticket = session.activeTicket;
alert("Server: " + server + "\nURL: " + url + "\nUser: " + user + "\nTicket: " + ticket);
Supported versions
| Adobe Version | Supported |
|---|---|
| 2023 | ✔ |
| 2024 | ✔ |
| 2025 | ✔ |
| 2026 | ✔ |