src/core/smart-session-context/SessionContext.ts
Represents the user's current session context.
constructor(http: SmartHttpService, sessionContextUrl: string, initialContext: any)
|
||||||||||||
|
Parameters :
|
| contextChanged |
Type : EventEmitter<SessionContextChange>
|
Default value : new EventEmitter<
SessionContextChange
>()
|
|
Fires when the session context has changed. |
| GetCharacterContextProperty | ||||||
GetCharacterContextProperty(propertyName: string)
|
||||||
|
Gets a Character property from the eContextProperties table
Parameters :
Returns :
Promise<string>
|
| GetContextPropertyNames |
GetContextPropertyNames()
|
|
Returns :
Promise<string[]>
Promise<string[]> |
| GetDateContextProperty | ||||||
GetDateContextProperty(propertyName: string)
|
||||||
|
Gets a Date property from the eContextProperties table
Parameters :
Returns :
Promise<string>
|
| GetDateTimeContextProperty | ||||||
GetDateTimeContextProperty(propertyName: string)
|
||||||
|
Gets a DateTime property from the eContextProperties table
Parameters :
Returns :
Promise<string>
|
| GetDecimalContextProperty | ||||||
GetDecimalContextProperty(propertyName: string)
|
||||||
|
Gets a Decimal property from the eContextProperties table
Parameters :
Returns :
Promise<number>
|
| GetInt64ContextProperty | ||||||
GetInt64ContextProperty(propertyName: string)
|
||||||
|
Gets an Int64 property from the eContextProperties table
Parameters :
Returns :
Promise<number>
|
| GetIntegerContextProperty | ||||||
GetIntegerContextProperty(propertyName: string)
|
||||||
|
Gets an Integer property from the eContextProperties table
Parameters :
Returns :
Promise<number>
|
| GetLogicalContextProperty | ||||||
GetLogicalContextProperty(propertyName: string)
|
||||||
|
Gets a Logical property from the eContextProperties table
Parameters :
Returns :
Promise<boolean>
|
| GetLongcharContextProperty | ||||||
GetLongcharContextProperty(propertyName: string)
|
||||||
|
Gets a Longchar property from the eContextProperties table
Parameters :
Returns :
Promise<string>
|
| GetRawContextProperty | ||||||
GetRawContextProperty(propertyName: string)
|
||||||
|
Gets a Raw property from the eContextProperties table
Parameters :
Returns :
Promise<string>
|
| RefreshCache |
RefreshCache()
|
|
Refreshes the current session context
Returns :
void
|
| RemoveContextValue | ||||||
RemoveContextValue(propertyName: string)
|
||||||
|
Removes all values from the context properties table where the property name matches the given property name pattern (MATCHES)
Parameters :
Returns :
Promise<void>
|
| SetCharacterContextProperty |
SetCharacterContextProperty(propertyName: string, value: string)
|
|
Sets a Character property in the eContextProperties table
Returns :
Promise<void>
|
| SetDateContextProperty |
SetDateContextProperty(propertyName: string, value: string)
|
|
Set's a Date property in the eContextProperties table
Returns :
Promise<void>
|
| SetDateTimeContextProperty |
SetDateTimeContextProperty(propertyName: string, value: string)
|
|
Sets a DateTime property in the eContextProperties table
Returns :
Promise<void>
|
| SetDecimalContextProperty |
SetDecimalContextProperty(propertyName: string, value: number)
|
|
Sets a Decimal property in the eContextProperties table
Returns :
Promise<void>
|
| SetInt64ContextProperty |
SetInt64ContextProperty(propertyName: string, value: number)
|
|
Sets an Int64 property in the eContextProperties table
Returns :
Promise<void>
|
| SetIntegerContextProperty |
SetIntegerContextProperty(propertyName: string, value: number)
|
|
Sets an Integer property in the eContextProperties table
Returns :
Promise<void>
|
| SetLogicalContextProperty |
SetLogicalContextProperty(propertyName: string, value: boolean)
|
|
Sets a Logical property in the eContextProperties table
Returns :
Promise<void>
|
| SetLongcharContextProperty |
SetLongcharContextProperty(propertyName: string, value: string)
|
|
Sets a Longchar property in the eContextProperties table
Returns :
Promise<void>
|
| SetMultipleProperties | ||||||
SetMultipleProperties(updateObject: SessionUpdateObject)
|
||||||
|
Sets multiple properties to the session context and persists them to the backend. Useful for updating multiple properties while making a single request to the backend.
Parameters :
Returns :
void
|
| SetRawContextProperty |
SetRawContextProperty(propertyName: string, value: string)
|
|
Sets a Raw property in the eContextProperties table
Returns :
Promise<void>
|
| UserName |
getUserName()
|
|
Provides access to eSessionContext.UserName
Returns :
string
|
| UserKey |
getUserKey()
|
|
Provides access to eSessionContext.UserKey
Returns :
string
|
| UserFullName |
getUserFullName()
|
|
Provides access to eSessionContext.UserFullName
Returns :
string
|
| UserEmail |
getUserEmail()
|
|
Provides access to eSessionContext.UserEmail
Returns :
string
|
| UserGroupNames |
getUserGroupNames()
|
|
Provides access to eSessionContext.UserGroupNames
Returns :
string
|
| UserGroupKeys |
getUserGroupKeys()
|
|
Provides access to eSessionContext.UserGroupKeys
Returns :
string
|
| ClientPrincipal |
getClientPrincipal()
|
|
Provides access to eSessionContext.ClientPrincipal
Returns :
string
|
| ClientProVersion |
getClientProVersion()
|
|
Provides access to eSessionContext.ClientProVersion
Returns :
string
|
| ClientType |
getClientType()
|
|
Provides access to eSessionContext.ClientType
Returns :
string
|
| LoginCompanyName |
getLoginCompanyName()
|
|
Provides access to eSessionContext.LoginCompanyName
Returns :
string
|
| LoginCompanyKey |
getLoginCompanyKey()
|
|
Provides access to eSessionContext.LoginCompanyKey
Returns :
string
|
| LoginCompanyShortName |
getLoginCompanyShortName()
|
|
Provides access to eSessionContext.LoginCompanyShortName
Returns :
string
|
| LoginCompanyReferenceChar |
getLoginCompanyReferenceChar()
|
|
Provides access to eSessionContext.LoginCompanyReferenceChar
Returns :
string
|
| LoginCompanyReferenceDecimal |
getLoginCompanyReferenceDecimal()
|
|
Provides access to eSessionContext.LoginCompanyReferenceDecimal
Returns :
number
|
| LoginCompanyReferenceInteger |
getLoginCompanyReferenceInteger()
|
|
Provides access to eSessionContext.LoginCompanyReferenceInteger
Returns :
number
|
| LanguageDisplayName | ||||||
getLanguageDisplayName()
|
||||||
|
Provides access to eSessionContext.LanguageDisplayName
Returns :
string
|
||||||
setLanguageDisplayName(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| LanguageIsoCode | ||||||
getLanguageIsoCode()
|
||||||
|
Provides access to eSessionContext.LanguageIsoCode
Returns :
string
|
||||||
setLanguageIsoCode(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| LanguageKey | ||||||
getLanguageKey()
|
||||||
|
Provides access to eSessionContext.LanguageKey
Returns :
string
|
||||||
setLanguageKey(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| AppServerProVersion |
getAppServerProVersion()
|
|
Provides access to eSessionContext.AppServerProVersion
Returns :
string
|
| AppServerType |
getAppServerType()
|
|
Provides access to eSessionContext.AppServerType
Returns :
string
|
| ServerDebugMode | ||||||
getServerDebugMode()
|
||||||
|
Provides access to eSessionContext.ServerDebugMode
Returns :
boolean
|
||||||
setServerDebugMode(value: boolean)
|
||||||
|
Parameters :
Returns :
void
|
| ServerCustomLogEntries | ||||||
getServerCustomLogEntries()
|
||||||
|
Provides access to eSessionContext.ServerCustomLogEntries
Returns :
string
|
||||||
setServerCustomLogEntries(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| ServerLogEntryTypes | ||||||
getServerLogEntryTypes()
|
||||||
|
Provides access to eSessionContext.ServerLogEntryTypes
Returns :
string
|
||||||
setServerLogEntryTypes(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| RestrictedTokens |
getRestrictedTokens()
|
|
Provides access to eSessionContext.RestrictedTokens
Returns :
string
|