API Docs for:
Show:

eb_UserContext Class

User Context class.

Methods

eb_UserContext.calculateSessionExpirationDate

() Date

This method is calculate session expiration date based on session expiration in min attribute [eb_Config.sessionExpirationInMin=10] in config file.

Returns:

Date:

Session expiration date.

eb_UserContext.destoryContext

(
  • model
)

This function is responsible for clearing the user context data.

Parameters:

  • model Object

    Instance of eb_UserContext.model.

eb_UserContext.getContextData

(
  • useCache
)
Object

Function to grab context data from where-ever it is being stored or from the server.

Parameters:

  • useCache Boolean

    Boolean value

Returns:

Object:

jQuery promise object which when resolved returns user information data.

eb_UserContext.getUserData

(
  • defer
)
Object

Function for getting user information.

Parameters:

  • defer Any

    Defer object

Returns:

Object:

jQuery object which return user information.

eb_UserContext.getUserInformation

() Object

Method to get user information.

Returns:

Object:

jQuery promise object which when resolved returns user information data.

eb_UserContext.isSessionTimeOut

() Boolean

Function to check whether session is going to time out or not with the eb_config sessionExpirationInMin attribute.

Returns:

Boolean:

Return true or false based on session is time out or not with login date and time stored in session storage.

eb_UserContext.login

(
  • loginParameters
)
Object

Login function.

Parameters:

  • loginParameters Object

    Login credentials.

Returns:

Object:

jQuery promise object which when resolved returns user information object.

eb_UserContext.Logout

(
  • model
)
String

Logout function. Logs the user out of SOA and destroy user context.

Parameters:

  • model Object

    Instance of eb_UserContext.model.

Returns:

String:

jQuery promise object which when resolved returns empty string.

eb_UserContext.model

(
  • data
  • domElement
)

UserContext Model. Any information specific to an individual instance of this model should be stored here.

Parameters:

  • data Object

    User Context Data

  • domElement Object

    User context DOM element.

eb_UserContext.saveContext

(
  • model
)
Boolean

This function is responsible for persisting the user context between page loads via whatever mechanism we choose.

Parameters:

  • model Object

    Instance of eb_UserContext.model.

Returns:

Boolean:

jQuery promise object which when resolved returns boolean value.

eb_UserContext.setUserContextDataInStorage

(
  • fields
  • userData
)

This method is use to set user information in session storage.

Parameters:

  • fields Any

    Fields collection

  • userData Any

    user data return to caller.

Properties

eb_UserContext.CacheUserContextExpirationField

String

This is cache user context expiration field

eb_UserContext.fields

Object

User context model fields collection

eb_UserContext.LoginServicePath

String

Login service URL.

eb_UserContext.LogoutService

String

Logout service URL.

eb_UserContext.ServicePath

String

SOA path. It would be set from configuration file.

eb_UserContext.SitePath

String

Site path. It would be set from configuration file.

eb_UserContext.StoragePrefix

String

This prefix will be attached to all items added to session storage.

eb_UserContext.TemplatePath

String

User Context template path.

eb_UserContext.UserInfoService

String

User Information service URL.