Skip navigation links
Thingworx Platform API
9.0.0
com.thingworx.resources.sessioninfo

Class SessionInfo

    • Constructor Detail

      • SessionInfo

        public SessionInfo()
    • Method Detail

      • GetCurrentUser

        @ThingworxExtensionApiMethod(since={6,6})
        public java.lang.String GetCurrentUser()
                                                                                  throws java.lang.Exception
        Service Category:
        UserInfo
        Service Description:
        Get the currently logged in user.
        Returns:
        result Currently logged in user - STRING
        Throws:
        java.lang.Exception - If an error occurs
      • GetCurrentUserHomeMashup

        @ThingworxExtensionApiMethod(since={6,6})
        public java.lang.String GetCurrentUserHomeMashup()
                                                                                            throws java.lang.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:
        java.lang.Exception - If an error occurs
      • GetCurrentUserLanguage

        @ThingworxExtensionApiMethod(since={6,6})
        public java.lang.String GetCurrentUserLanguage()
                                                                                          throws java.lang.Exception
        Service Category:
        UserInfo
        Service Description:
        Get the currently logged in user's preferred language.
        Returns:
        Language Preferred language - STRING
        Throws:
        java.lang.Exception - If an error occurs
      • GetActiveUsers

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetActiveUsers(java.lang.Double maxItems)
                                                                           throws java.lang.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:
        java.lang.Exception - If an error occurs
      • GetCurrentUserExtensionProperties

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetCurrentUserExtensionProperties()
                                                                                              throws java.lang.Exception
        Service Category:
        UserInfo
        Service Description:
        Get the properties for the currently logged in user.
        Returns:
        result Currently logged in user properties - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetCurrentUserGroups

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetCurrentUserGroups()
                                                                                 throws java.lang.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:
        java.lang.Exception - If an error occurs
      • GetCurrentUserOrganizations

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetCurrentUserOrganizations()
                                                                                        throws java.lang.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:
        java.lang.Exception - If an error occurs
      • GetCurrentUserOrganizationalUnits

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetCurrentUserOrganizationalUnits()
                                                                                              throws java.lang.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:
        java.lang.Exception - If an error occurs
      • GetGlobalSessionValues

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetGlobalSessionValues()
                                                                                   throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Get global session values.
        Returns:
        result Parameter value - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs
      • GetDesignTimeCollectionPermissions

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetDesignTimeCollectionPermissions()
                                                                                               throws java.lang.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:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionStringValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionStringValue(java.lang.String name,
                                                                                          java.lang.String value)
                                                                                   throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified string global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - STRING
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionBooleanValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionBooleanValue(java.lang.String name,
                                                                                           java.lang.Boolean value)
                                                                                    throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified boolean global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - BOOLEAN
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionLocationValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionLocationValue(java.lang.String name,
                                                                                            Location value)
                                                                                     throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified location global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - LOCATION
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionDateTimeValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionDateTimeValue(java.lang.String name,
                                                                                            org.joda.time.DateTime value)
                                                                                     throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified datetime global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - DATETIME
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionNumberValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionNumberValue(java.lang.String name,
                                                                                          java.lang.Double value)
                                                                                   throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified number global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - NUMBER
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionJSONValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionJSONValue(java.lang.String name,
                                                                                        org.json.JSONObject value)
                                                                                 throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified JSON global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - JSON
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionXMLValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionXMLValue(java.lang.String name,
                                                                                       org.w3c.dom.Document value)
                                                                                throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified XML global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - XML
        Throws:
        java.lang.Exception - If an error occurs
      • SetGlobalSessionInfoTableValue

        @ThingworxExtensionApiMethod(since={6,6})
        public void SetGlobalSessionInfoTableValue(java.lang.String name,
                                                                                             InfoTable value)
                                                                                      throws java.lang.Exception
        Service Category:
        SessionInfo
        Service Description:
        Set value for specified InfoTable global session property.
        Parameters:
        name - Parameter name - STRING
        value - Parameter value - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs