Interface ModifiableUserAction


  • public interface ModifiableUserAction
    This interface defines a set of actions that can be used to interact with currently open user actions
    Since:
    8.189
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel()
      Cancels this action and discards all associated data
      String getActionName()
      Returns the name of the currently open UserAction
      void reportError​(String errorName, int errorCode)
      Reports an error as key-value pair with the time at which it occurred.
      void reportError​(String errorName, Throwable throwable)
      Reports an error as Throwable with the time at which it occurred.
      void reportEvent​(String eventName)
      Reports the time when a specific event occurred.
      void reportValue​(String valueName, double value)
      Reports a key-value pair with the time at which this event occurred.
      void reportValue​(String valueName, int value)
      Reports a key-value pair with the time at which this event occurred.
      void reportValue​(String valueName, long value)
      Reports a key-value pair with the time at which this event occurred.
      void reportValue​(String valueName, String value)
      Reports a key-value pair with the time at which this event occurred.
      void setActionName​(String actionName)
      Sets the name of the currently open UserAction
    • Method Detail

      • getActionName

        String getActionName()
        Returns the name of the currently open UserAction
        Returns:
        the name of the UserAction
      • setActionName

        void setActionName​(String actionName)
        Sets the name of the currently open UserAction
        Parameters:
        actionName - the new name for the UserAction
      • reportEvent

        void reportEvent​(String eventName)
        Reports the time when a specific event occurred. This event can be used to determine when a user passed through a specific part of your application. The reportEvent method is a simple way to track user behavior in your application.
        Parameters:
        eventName - event name
        See Also:
        DTXAction.reportEvent(String)
      • reportValue

        void reportValue​(String valueName,
                         int value)
        Reports a key-value pair with the time at which this event occurred. This event can be used to report important measurement data.
        Parameters:
        valueName - name of the value
        value - an int value from Integer.MIN_VALUE through Integer.MAX_VALUE
        See Also:
        DTXAction.reportValue(String, int)
      • reportValue

        void reportValue​(String valueName,
                         long value)
        Reports a key-value pair with the time at which this event occurred. This event can be used to report important measurement data.
        Parameters:
        valueName - name of the value
        value - a long value from Long.MIN_VALUE through Long.MAX_VALUE
        Since:
        8.197
        See Also:
        DTXAction.reportValue(String, long)
      • reportValue

        void reportValue​(String valueName,
                         double value)
        Reports a key-value pair with the time at which this event occurred. This event can be used to report important measurement data.
        Parameters:
        valueName - data name of the value
        value - a double value
        See Also:
        DTXAction.reportValue(String, double)
      • reportValue

        void reportValue​(String valueName,
                         String value)
        Reports a key-value pair with the time at which this event occurred. This event can be used to report important measurement data.
        Parameters:
        valueName - data name of the value
        value - a String value
        See Also:
        DTXAction.reportValue(String, String)
      • reportError

        void reportError​(String errorName,
                         int errorCode)
        Reports an error as key-value pair with the time at which it occurred. This event can be used to report error codes.
        Parameters:
        errorName - error name
        errorCode - integer error code
        See Also:
        DTXAction.reportError(String, int)
      • reportError

        void reportError​(String errorName,
                         Throwable throwable)
        Reports an error as Throwable with the time at which it occurred. This event can be used to report a handled exception.
        Parameters:
        errorName - error name
        throwable - a caught exception
        See Also:
        DTXAction.reportError(String, Throwable)
      • cancel

        void cancel()
        Cancels this action and discards all associated data
        Since:
        8.241