Package org.bedework.jsforj.model.values
Interface JSAlert
-
- All Superinterfaces:
JSValue
- All Known Implementing Classes:
JSAlertImpl
public interface JSAlert extends JSValue
User: mike Date: 10/25/19 Time: 12:46
-
-
Field Summary
Fields Modifier and Type Field Description static StringalertActionDisplayThe alert should be displayed as appropriate for the current device and user context.static StringalertActionEmailThe alert should trigger an email sent out to the user, notifying about the alert.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JSUTCDateTimegetAcknowledged()StringgetAction()JSRelationsgetRelatedTo(boolean create)JSTriggergetTrigger()JSAbsoluteTriggermakeAbsoluteTrigger()JSOffsetTriggermakeOffsetTrigger()voidsetAcknowledged(JSUTCDateTime val)voidsetAction(String val)voidsetTrigger(JSTrigger val)-
Methods inherited from interface org.bedework.jsforj.model.values.JSValue
clear, copy, getBooleanProperty, getBooleanValue, getChanged, getNode, getObjectType, getOverrideGenerated, getOwner, getParentProperty, getProperties, getProperty, getProperty, getPropertyValue, getStringProperty, getStringValue, getType, getUnsignedIntegerProperty, getValue, hasChanges, hasProperty, isString, makeProperty, markOverrideGenerated, newProperty, preWrite, removeProperty, setProperty, setProperty, setProperty, setProperty, setProperty, writeValue, writeValueAsString, writeValueAsStringFormatted
-
-
-
-
Field Detail
-
alertActionDisplay
static final String alertActionDisplay
The alert should be displayed as appropriate for the current device and user context.- See Also:
- Constant Field Values
-
alertActionEmail
static final String alertActionEmail
The alert should trigger an email sent out to the user, notifying about the alert. This action is typically only appropriate for server implementations.- See Also:
- Constant Field Values
-
-
Method Detail
-
setTrigger
void setTrigger(JSTrigger val)
-
getTrigger
JSTrigger getTrigger()
-
makeAbsoluteTrigger
JSAbsoluteTrigger makeAbsoluteTrigger()
- Returns:
- an absolute trigger. Will be set in alert.
-
makeOffsetTrigger
JSOffsetTrigger makeOffsetTrigger()
- Returns:
- an offset trigger. Will be set in alert.
-
setAction
void setAction(String val)
-
getAction
String getAction()
-
setAcknowledged
void setAcknowledged(JSUTCDateTime val)
-
getAcknowledged
JSUTCDateTime getAcknowledged()
-
getRelatedTo
JSRelations getRelatedTo(boolean create)
- Parameters:
create- true if we create property if it doesn't exist- Returns:
- relations object
-
-