Interface ModifiableUserAction
-
public interface ModifiableUserActionThis 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 voidcancel()Cancels thisDTXAction.StringgetActionName()Returns the name of the currently openUserActionvoidreportError(String errorName, int errorCode)Reports an error with a specified name and error code.voidreportError(String errorName, Throwable throwable)Reports an error with a specified name and aThrowable.voidreportEvent(String eventName)Reports an event with a specified name (but without any value).voidreportValue(String valueName, double value)Reports adoublevalue with a specified name.voidreportValue(String valueName, int value)Reports anintvalue with a specified name.voidreportValue(String valueName, long value)Reports alongvalue with a specified name.voidreportValue(String valueName, String value)Reports aStringvalue with a specified name.voidsetActionName(String actionName)Sets the name of the currently openUserAction
-
-
-
Method Detail
-
getActionName
String getActionName()
Returns the name of the currently openUserAction- Returns:
- the name of the
UserAction
-
setActionName
void setActionName(String actionName)
Sets the name of the currently openUserAction- Parameters:
actionName- the new name for theUserAction
-
reportEvent
void reportEvent(String eventName)
Reports an event with a specified name (but without any value).If given
eventNameisnullor 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 anintvalue with a specified name.If given
valueNameisnullor an empty String then no event is reported to the system.- Parameters:
valueName- name of this valuevalue- value itself- See Also:
DTXAction.reportValue(String, int)
-
reportValue
void reportValue(String valueName, long value)
Reports alongvalue with a specified name.If given
valueNameisnullor an empty String then no event is reported to the system.- Parameters:
valueName- name of this valuevalue- value itself- Since:
- 8.197
- See Also:
DTXAction.reportValue(String, long)
-
reportValue
void reportValue(String valueName, double value)
Reports adoublevalue with a specified name.If given
valueNameisnullor an empty String then no event is reported to the system.- Parameters:
valueName- name of this valuevalue- value itself- See Also:
DTXAction.reportValue(String, double)
-
reportValue
void reportValue(String valueName, String value)
Reports aStringvalue with a specified name.If given
valueNameisnullor an empty String then no event is reported to the system.- Parameters:
valueName- name of this valuevalue- value itself Thevaluecan benullor 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
errorNameisnullor an empty String then no event is reported to the system.- Parameters:
errorName- name of this errorerrorCode- numeric error code of this error- See Also:
DTXAction.reportError(String, int)
-
reportError
void reportError(String errorName, Throwable throwable)
Reports an error with a specified name and aThrowable.If given
errorNameisnullor an empty string then no event is reported to the system.- Parameters:
errorName- name of this errorthrowable-Throwablecausing this error- See Also:
DTXAction.reportError(String, Throwable)
-
cancel
void cancel()
Cancels thisDTXAction.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()
-
-