dundas.session.SessionService Class

 

Inheritance Hierarchy

 
Class
   dundas.Component
      dundas.Service
         dundas.session.SessionService
 

Constructors

 
  Name Description
init Initializes the SessionService. Called during construction. Inherited from dundas.Component.
 
 

Properties

 
  Name Description
eventsManager Inherited from dundas.Service.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
site Gets or sets the site that this component is a part of. Inherited from dundas.Component.
uniqueId Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
 
 

Methods

 
  Name Description
bind Subscribe a handler for an event. Inherited from dundas.Service.
createDelegate Helper for creating delegate functions. Inherited from dundas.Component.
createTimeout Creates a timeout. Inherited from dundas.Component.
deleteCurrentSession Deletes the current session.
deleteSessionById Deletes the specified session.
deleteSessionsById Deletes the specified session.
deleteSessionsForAccount Deletes all of the sessions associated with the account ID.
dispatch Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
dispose Inherited from dundas.Component.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getDataDiscoveryToken Gets a data discovery token for the current user session.
getService Gets the requested service. Inherited from dundas.Component.
getSessionById Gets the specified session.
getSessionsByIds Gets the sessions with the specified IDs.
isSessionValid Checks whether the current session is valid or not. However, if there is no current session, a manual ID can be provided.
keepAlive Keeps the current session alive. However, a session ID can be provided to keep that session alive.
onLoaded Called when the service is loaded. Inherited from dundas.Service.
queryNumberOfSessions Gets the number of sessions corresponding to query criteria.
querySessions Gets the sessions corresponding to query criteria.
setSessionCulture Updates the sessions current culture to the one specified. However, a session ID can be provided to update a different session's culture.
setSessionCustomAttributes Sets the custom attributes for the specified session.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.Service.
subscribeOnce Subscribe a one time handler for an event. Inherited from dundas.Service.
switchTenant Switches the tenant of the current session.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Triggers an event. Inherited from dundas.Service.
unbind Unsubscribe an event. Inherited from dundas.Service.