| Package | impression.events |
| Class | public class RemediationRequestEvent |
| Inheritance | RemediationRequestEvent  StoryboardEvent flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| message : String [read-only]
The remediation message to display. | RemediationRequestEvent | ||
| remediationCount : Number
The number of times remediation requests have occurred for the storyboard. | RemediationRequestEvent | ||
| remediationData : * [read-only]
Additional remediation data. | RemediationRequestEvent | ||
 | sb : Storyboard [read-only]
The Storyboard object assigned to the target. | StoryboardEvent | |
| Method | Defined By | ||
|---|---|---|---|
RemediationRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, message:String, remediationData:* = null, remediationCount:Number = 0)
Creates a new instance of a RemediationRequestEvent object. | RemediationRequestEvent | ||
clone():Event [override]
Duplicates an instance of the event object. | RemediationRequestEvent | ||
toString():String [override]
Returns a string containing all the properties of the RemediationRequestEvent object. | RemediationRequestEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| COMPLETE : String = complete [static]
The StoryboardEvent.COMPLETE constant defines the value of the
type property of a complete event object. | StoryboardEvent | |
| CONTENT_LOAD_BEGIN : String = contentLoadBegin [static]
The StoryboardEvent.CONTENT_LOAD_BEGIN constant defines the value of the
type property of a content load begin event object. | StoryboardEvent | |
| CONTENT_LOAD_END : String = contentLoadEnd [static]
The StoryboardEvent.CONTENT_LOAD_END constant defines the value of the
type property of a content load end event object. | StoryboardEvent | |
| INITIALIZE : String = initialize [static]
The StoryboardEvent.INITIALIZE constant defines the value of the
type property of a initialize event object. | StoryboardEvent | |
| LOAD_COMPLETE : String = loadComplete [static]
The StoryboardEvent.LOAD_COMPLETE constant defines the value of the
type property of a load event object. | StoryboardEvent | |
| LOAD_START : String = loadStart [static]
The StoryboardEvent.LOAD_START constant defines the value of the
type property of an load start event object. | StoryboardEvent | |
| REMEDIATION_REQUEST : String = remediationRequest [static]
The RemediationRequestEvent.REMEDIATION_REQUEST constant defines the value of the
type property of a remediation request event object. | RemediationRequestEvent | ||
| UNLOAD : String = unload [static]
The StoryboardEvent.UNLOAD constant defines the value of the
type property of an unload event object. | StoryboardEvent | |
| message | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesmessage:String [read-only] The remediation message to display.
public function get message():String| remediationCount | property |
remediationCount:NumberThe number of times remediation requests have occurred for the storyboard.
When dispatching a RemediationRequestEvent event, the SimulationPlayer increments value of the current storyboard's
RemediationCount persisted property and passes that value to the object constructor. When execution returns
to the player, the value of this object's remediationCount property is used to set the value of the
storyboard's RemediationCount persisted property.
public function get remediationCount():Number public function set remediationCount(value:Number):void| remediationData | property |
remediationData:* [read-only] Additional remediation data. This data is project-defined and is copied from the RulesEngineRemediationRequest event object by the SimulationPlayer and added to this event.
public function get remediationData():*See also
| RemediationRequestEvent | () | Constructor |
public function RemediationRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, message:String, remediationData:* = null, remediationCount:Number = 0)Creates a new instance of a RemediationRequestEvent object.
Parameterstype:String — The type of the event. Event listeners can access this information through the inherited type property.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
sb:Storyboard (default = null)sb property.
| |
message:String — The remediation message to display. Event listeners can access this information through the message property.
| |
remediationData:* (default = null)remediationData property.
| |
remediationCount:Number (default = 0)remediationCount property.
|
| clone | () | method |
override public function clone():EventDuplicates an instance of the event object.
Returns a new RemediationRequestEvent object that is a copy of the original instance of the RemediationRequestEvent object.
You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch
an event--that is, when you call dispatchEvent(event) from a handler that is handling event.
Event — A new RemediationRequestEvent object that is identical to the original.
|
| toString | () | method |
override public function toString():StringReturns a string containing all the properties of the RemediationRequestEvent object. The string is in the following format:
[RemediationRequestEvent type=value bubbles=value cancelable=value eventPhase=value sb=value message=value remediationData=value remediationCount=value]
String — A string containing all the properties of the RemediationRequestEvent object.
|
| REMEDIATION_REQUEST | Constant |
public static const REMEDIATION_REQUEST:String = remediationRequestThe RemediationRequestEvent.REMEDIATION_REQUEST constant defines the value of the type property of a remediation request event object. This event has the following properties:
| Property | Value |
|---|---|
| bubbles | false |
| cancelable | false; there is no default behavior to cancel. |
| currentTarget | The object that is actively processing the Event object with an event listener. |
| target | The object that raised the event. |
| sb | The Storyboard object assigned to the target. |
| message | The remediation message to display. |
| remediationData | Additional remediation data. |
| remediationCount | The number of times remediation requests have occurred for the storyboard. |