@PublicApi
public interface EffectorProcess
Represents an Effector
preview, effect application, or undo
background process started by a user.
Please note that an instance of this class is just a snapshot of
the state of the process at the time when the instance itself was created.
For those attributes that are supposed to change over time, like
status
, calling the corresponding method on the same
instance will not return up-to-date values, you must obtain a new
EffectorProcess
instance instead.
Modifier and Type | Interface and Description |
---|---|
static class |
EffectorProcess.Status
Represents the status of an effector process.
|
Modifier and Type | Method and Description |
---|---|
EffectorPreview |
getEffectorPreview()
Generated effects for preview, not yet applied.
|
Long |
getFinishTime() |
long |
getId() |
long |
getProcessHandleId()
Returns the ID of this process'
ProcessHandle . |
Long |
getRevertedProcessId() |
Long |
getStartTime() |
EffectorProcess.Status |
getStatus() |
String |
getUserKey() |
boolean |
isAcknowledged() |
long getId()
long getProcessHandleId()
ProcessHandle
. The process handle can be used to check the progress
of the process.ProcessHandleManager.getInfo(Long)
@Nullable EffectorPreview getEffectorPreview()
getStatus()
is one of
CALCULATED
,
QUEUED
, or
IN_PROGRESS
.@NotNull EffectorProcess.Status getStatus()
@NotNull String getUserKey()
@Nullable Long getStartTime()
CALCULATING
or
IN_PROGRESS
status@Nullable Long getFinishTime()
@Nullable Long getRevertedProcessId()
boolean isAcknowledged()
EffectorProcessManager.acknowledgeFinished(long)
Copyright © 2024 Tempo Software. All Rights Reserved.