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 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 an event with a specified name (but without any value).

        If given eventName is null or an empty String then no event is reported to the system.

        Parameters:
        eventName - name of the event
        See Also:
        DTXAction.reportEvent(String)
      • reportValue

        void reportValue​(String valueName,
                         int value)
        Reports an int value with a specified name.

        If given valueName is null or an empty String then no event is reported to the system.

        Parameters:
        valueName - name of this value
        value - value itself
        See Also:
        DTXAction.reportValue(String, int)
      • reportValue

        void reportValue​(String valueName,
                         long value)
        Reports a long value with a specified name.

        If given valueName is null or an empty String then no event is reported to the system.

        Parameters:
        valueName - name of this value
        value - value itself
        Since:
        8.197
        See Also:
        DTXAction.reportValue(String, long)
      • reportValue

        void reportValue​(String valueName,
                         double value)
        Reports a double value with a specified name.

        If given valueName is null or an empty String then no event is reported to the system.

        Parameters:
        valueName - name of this value
        value - value itself
        See Also:
        DTXAction.reportValue(String, double)
      • reportValue

        void reportValue​(String valueName,
                         String value)
        Reports a String value with a specified name.

        If given valueName is null or an empty String then no event is reported to the system.

        Parameters:
        valueName - name of this value
        value - value itself The value can be null or an empty String.
        See Also:
        DTXAction.reportValue(String, String)
      • reportError

        void reportError​(String errorName,
                         int errorCode)
        Reports an error with a specified name and error code.

        If given errorName is null or an empty String then no event is reported to the system.

        Parameters:
        errorName - name of this error
        errorCode - numeric error code of this error
        See Also:
        DTXAction.reportError(String, int)
      • cancel

        void cancel()
        Cancels this DTXAction.

        Canceling an action is similar to leaving an action, except that the data and all unfinished child objects are discarded instead of being sent.

        Since:
        8.241
        See Also:
        DTXAction.cancel()