Package com.thingworx.resources.sessioninfo

Class SessionInfo

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.sessioninfo.SessionInfo

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class SessionInfo
extends Resource

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
SessionInfo()

Method Summary

Modifier and Type	Method	Description
InfoTable	GetActiveUsers(Double maxItems)	Service Category: UserInfo Service Description: Get the currently logged in users.
String	GetCurrentUser()	Service Category: UserInfo Service Description: Get the currently logged in user.
InfoTable	GetCurrentUserExtensionProperties()	Service Category: UserInfo Service Description: Get the properties for the currently logged in user.
InfoTable	GetCurrentUserGroups()	Service Category: UserInfo Service Description: Get the groups for the currently logged in user.
String	GetCurrentUserHomeMashup()	Service Category: UserInfo Service Description: Get the currently logged in user's home mashup.
String	GetCurrentUserLanguage()	Service Category: UserInfo Service Description: Get the currently logged in user's preferred language.
InfoTable	GetCurrentUserOrganizationalUnits()	Service Category: UserInfo Service Description: Get the organizational units for the currently logged in user.
InfoTable	GetCurrentUserOrganizations()	Service Category: UserInfo Service Description: Get the organizations for the currently logged in user.
InfoTable	GetDesignTimeCollectionPermissions()	Service Category: Permissions Service Description: Get the design time permissions for the current user.
InfoTable	GetGlobalSessionValues()	Service Category: SessionInfo Service Description: Get global session values.
void	SetGlobalSessionBooleanValue(String name, Boolean value)	Service Category: SessionInfo Service Description: Set value for specified boolean global session property.
void	SetGlobalSessionDateTimeValue(String name, org.joda.time.DateTime value)	Service Category: SessionInfo Service Description: Set value for specified datetime global session property.
void	SetGlobalSessionInfoTableValue(String name, InfoTable value)	Service Category: SessionInfo Service Description: Set value for specified InfoTable global session property.
void	SetGlobalSessionJSONValue(String name, org.json.JSONObject value)	Service Category: SessionInfo Service Description: Set value for specified JSON global session property.
void	SetGlobalSessionLocationValue(String name, Location value)	Service Category: SessionInfo Service Description: Set value for specified location global session property.
void	SetGlobalSessionNumberValue(String name, Double value)	Service Category: SessionInfo Service Description: Set value for specified number global session property.
void	SetGlobalSessionStringValue(String name, String value)	Service Category: SessionInfo Service Description: Set value for specified string global session property.
void	SetGlobalSessionXMLValue(String name, Document value)	Service Category: SessionInfo Service Description: Set value for specified XML global session property.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

SessionInfo

public SessionInfo()

Method Details

GetCurrentUser

@ThingworxExtensionApiMethod(since={6,6})
public String GetCurrentUser()
                      throws Exception

Service Category:

UserInfo

Service Description:

Get the currently logged in user.

Returns:

result Currently logged in user - STRING

Throws:

Exception - If an error occurs

GetCurrentUserHomeMashup

@ThingworxExtensionApiMethod(since={6,6})
public String GetCurrentUserHomeMashup()
                                throws Exception

Service Category:

UserInfo

Service Description:

Get the currently logged in user's home mashup.

Returns:

result Home mashup for the currently logged in user - MASHUPNAME

Throws:

Exception - If an error occurs

GetCurrentUserLanguage

@ThingworxExtensionApiMethod(since={6,6})
public String GetCurrentUserLanguage()
                              throws Exception

Service Category:

UserInfo

Service Description:

Get the currently logged in user's preferred language.

Returns:

Language Preferred language - STRING

Throws:

Exception - If an error occurs

GetActiveUsers

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetActiveUsers(Double maxItems)
                         throws Exception

Service Category:

UserInfo

Service Description:

Get the currently logged in users.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result The currently logged in users - INFOTABLE - Aspects {dataShape:UserStatus}

Throws:

Exception - If an error occurs

GetCurrentUserExtensionProperties

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCurrentUserExtensionProperties()
                                            throws Exception

Service Category:

UserInfo

Service Description:

Get the properties for the currently logged in user.

Returns:

result Currently logged in user properties - INFOTABLE

Throws:

Exception - If an error occurs

GetCurrentUserGroups

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCurrentUserGroups()
                               throws Exception

Service Category:

UserInfo

Service Description:

Get the groups for the currently logged in user.

Returns:

result Groups for the currently logged in user - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - If an error occurs

GetCurrentUserOrganizations

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCurrentUserOrganizations()
                                      throws Exception

Service Category:

UserInfo

Service Description:

Get the organizations for the currently logged in user.

Returns:

result Organizations for the currently logged in user - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - If an error occurs

GetCurrentUserOrganizationalUnits

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCurrentUserOrganizationalUnits()
                                            throws Exception

Service Category:

UserInfo

Service Description:

Get the organizational units for the currently logged in user.

Returns:

result Organizations for the currently logged in user - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - If an error occurs

GetGlobalSessionValues

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGlobalSessionValues()
                                 throws Exception

Service Category:

SessionInfo

Service Description:

Get global session values.

Returns:

result Parameter value - INFOTABLE

Throws:

Exception - If an error occurs

GetDesignTimeCollectionPermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDesignTimeCollectionPermissions()
                                             throws Exception

Service Category:

Permissions

Service Description:

Get the design time permissions for the current user.

Returns:

result Design time permissions for the current user - INFOTABLE - Aspects {dataShape:DesignTimePermissions}

Throws:

Exception - If an error occurs

SetGlobalSessionStringValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionStringValue(String name,
 String value)
                                 throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified string global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - STRING

Throws:

Exception - If an error occurs

SetGlobalSessionBooleanValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionBooleanValue(String name,
 Boolean value)
                                  throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified boolean global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - BOOLEAN

Throws:

Exception - If an error occurs

SetGlobalSessionLocationValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionLocationValue(String name,
 Location value)
                                   throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified location global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - LOCATION

Throws:

Exception - If an error occurs

SetGlobalSessionDateTimeValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionDateTimeValue(String name,
 org.joda.time.DateTime value)
                                   throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified datetime global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - DATETIME

Throws:

Exception - If an error occurs

SetGlobalSessionNumberValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionNumberValue(String name,
 Double value)
                                 throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified number global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - NUMBER

Throws:

Exception - If an error occurs

SetGlobalSessionJSONValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionJSONValue(String name,
 org.json.JSONObject value)
                               throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified JSON global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - JSON

Throws:

Exception - If an error occurs

SetGlobalSessionXMLValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionXMLValue(String name,
 Document value)
                              throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified XML global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - XML

Throws:

Exception - If an error occurs

SetGlobalSessionInfoTableValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetGlobalSessionInfoTableValue(String name,
 InfoTable value)
                                    throws Exception

Service Category:

SessionInfo

Service Description:

Set value for specified InfoTable global session property.

Parameters:

name - Parameter name - STRING

value - Parameter value - INFOTABLE

Throws:

Exception - If an error occurs