Description:
This object contains messages generated by the system which may require a response from the user.
Parents: ActiveEventManager
| Attribute | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Common Writable Attributes | Active, Name | ||||||||||||||||
| AllowDefaultResponse |
Show if default response is allowed for active event. Type: bool Default: TRUE Possible Values:
|
||||||||||||||||
| RequestReady |
Event is prepared for presentation to the user. Type: bool Default: FALSE Possible Values:
|
||||||||||||||||
| Response |
User's response. Type: enum Default: NONE Possible Values:
|
||||||||||||||||
| ResponseReady |
User has responded. Type: bool Default: FALSE Possible Values:
|
||||||||||||||||
| SetAsDefaultResponse |
If user responds yes when asked "Do not prompt me about this again. (Yes/No)" then this will be true. Future events of this type will be processed using the same response that the user gave to this event. Type: bool Default: FALSE Possible Values:
|
| Read-Only Attribute | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Category |
Show category for active event. For example, validation. Type: string Default: "" (empty string) |
||||||||||||||||
| DefaultRequestResponse |
Default response for the message from the user. Type: enum Default: NONE Possible Values:
|
||||||||||||||||
| Level |
Show event level for active event. Type: enum Default: WARN Possible Values:
|
||||||||||||||||
| Message |
A message that contains information or a question for the user. Type: string Default: "" (empty string) |
||||||||||||||||
| MsgContext |
Show message context for active event. Type: string Default: "" (empty string) |
||||||||||||||||
| Request |
Type of request. Valid values are the logical OR of YES|NO or IGNORE|RETRY\CANCEL. Type: enum Default: NONE Possible Values:
|