LiveCycleFaultEvent

Package	lc.foundation.events
Class	public class LiveCycleFaultEvent
Inheritance	LiveCycleFaultEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The LiveCycleFaultEvent event is dispatched when a fault occurs.

For information on using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace 10.0 User Interface .

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		errorMessage : Message The error message.	LiveCycleFaultEvent
		errorParams : Object Additional parameters for the error.	LiveCycleFaultEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		token : lc.foundation.util:Token [read-only] The token that represents the call to the fault.	LiveCycleFaultEvent
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		LiveCycleFaultEvent(errorMessage:Message, errorParams:Object, type:String, bubbles:Boolean, cancelable:Boolean, token:lc.foundation.util:Token) Constructor.	LiveCycleFaultEvent
		clone():Event [override] Creates a copy of a LiveCycleFaultEvent object and sets the value of each property to match that of the original.	LiveCycleFaultEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		AUTHENTICATION_EXPIRED : String = "authenticationExpired" [static] A special value that specifies that the session for a user timeed-out.	LiveCycleFaultEvent
		CONNECTION_LOST : String = "connectionLost" [static] A special value that specifies that the session was disconnected.	LiveCycleFaultEvent
		CONNECTION_NOT_RECOVERED : String = "connectionNotRecovered" [static] A special value that specifies that disconnected session could not be recovered.	LiveCycleFaultEvent
		CONNECTION_RECOVERED : String = "connectionRecovered" [static] A special value that specifies that a previously disconnected session was recovered.	LiveCycleFaultEvent
		CREDENTIALS_REQUIRED : String = "credentialsRequired" [static] A special value that specifies that credentials are required.	LiveCycleFaultEvent
		FAULT : String = "fault" [static] A special value that specifies a fault or error occurred.	LiveCycleFaultEvent
		LOGIN_INCORRECT : String = "loginIncorrect" [static] A special value that specifies incorrect credentials were used to login to Workspace.	LiveCycleFaultEvent

Property Detail

errorMessage

property

public var errorMessage:Message

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The error message.

errorParams

property

public var errorParams:Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Additional parameters for the error.

token

property

token:lc.foundation.util:Token [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The token that represents the call to the fault. The value is useful for asynchronous completion token patterns.

Implementation
public function get token():lc.foundation.util:Token

Constructor Detail

LiveCycleFaultEvent

()

Constructor

public function LiveCycleFaultEvent(errorMessage:Message, errorParams:Object, type:String, bubbles:Boolean, cancelable:Boolean, token:lc.foundation.util:Token)

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Parameters

	`errorMessage:Message` — Specifies the error message.

	`errorParams:Object` — Specifies an object containing any parameters of interest relating to the error.

	`type:String` — Specifies the type of the event.

	`bubbles:Boolean` — Specifies whether the event object participates in the bubbling stage of the event flow. The default value is `false`.

	`cancelable:Boolean` — Specifies whether the event object can be canceled.

	`token:lc.foundation.util:Token` — Specifies request token.

Method Detail

clone

()

method

override public function clone():Event

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Creates a copy of a LiveCycleFaultEvent object and sets the value of each property to match that of the original.

Returns

Event — A copy of the LiveCycleFaultEvent object.

Constant Detail

AUTHENTICATION_EXPIRED

Constant

public static const AUTHENTICATION_EXPIRED:String = "authenticationExpired"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies that the session for a user timeed-out.

CONNECTION_LOST

Constant

public static const CONNECTION_LOST:String = "connectionLost"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies that the session was disconnected.

CONNECTION_NOT_RECOVERED

Constant

public static const CONNECTION_NOT_RECOVERED:String = "connectionNotRecovered"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies that disconnected session could not be recovered.

CONNECTION_RECOVERED

Constant

public static const CONNECTION_RECOVERED:String = "connectionRecovered"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies that a previously disconnected session was recovered.

CREDENTIALS_REQUIRED

Constant

public static const CREDENTIALS_REQUIRED:String = "credentialsRequired"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies that credentials are required.

FAULT

Constant

public static const FAULT:String = "fault"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a fault or error occurred.

LOGIN_INCORRECT

Constant

public static const LOGIN_INCORRECT:String = "loginIncorrect"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies incorrect credentials were used to login to Workspace.

Legal Notices | Online Privacy Policy

LiveCycleFaultEvent - AS3 ADEP Workspace

Classes x

errorMessage

errorParams

token

LiveCycleFaultEvent

clone

AUTHENTICATION_EXPIRED

CONNECTION_LOST

CONNECTION_NOT_RECOVERED

CONNECTION_RECOVERED

CREDENTIALS_REQUIRED

FAULT

LOGIN_INCORRECT