Packagecom.lightstreamer.as_client.events
Classpublic class SubscriptionErrorEvent
InheritanceSubscriptionErrorEvent Inheritance TableEvent Inheritance flash.events.Event

Dispatched whenever the Server notifies an error which prevents the subscription request performed by the related table from being accomplished; as a consequence, the table will receive no data. By setting a custom handler, it is possible to perform recovery actions.

Note that, in order to perform a new subscription attempt, both LSClient.unsubscribeTable() and LSClient.subscribeTable() should be issued again, even if no changes to the table attributes have been applied.

See also

com.lightstreamer.as_client.LSClient.subscribeTable()
com.lightstreamer.as_client.LSClient.unsubscribeTable()

Public Properties
 PropertyDefined By
  errorCode : int
[read-only] The error code returned by the Server. A positive error code is issued by the Server after checking the request against the constraints imposed by the Metadata Adapter or by its own configuration.
SubscriptionErrorEvent
  errorMessage : String
[read-only] An error detail message, sent by Lightstreamer Server or by the Metadata Adapter.
SubscriptionErrorEvent
  item : *
[read-only] Only effective when the related table behaves in "MultiMetapush logic".
SubscriptionErrorEvent
  key : String
[read-only] Only effective when the related table behaves in "MultiMetapush logic".
SubscriptionErrorEvent
 Inheritedtable : Table
[read-only] The table which this event is related to.
TableEvent
Public Constants
 ConstantDefined By
  SUBSCRIPTION_ERROR : String = subscriptionError
[static] Define the value of the type property of a SubscriptionError event object.
SubscriptionErrorEvent
Property Detail
errorCodeproperty
errorCode:int  [read-only]

The error code returned by the Server.

A positive error code is issued by the Server after checking the request against the constraints imposed by the Metadata Adapter or by its own configuration. See the text protocol documentation for a reference of the error codes that can be issued in response to a subscription request.

A zero or negative error code is issued directly by the Metadata Adapter, because of capability restrictions that may apply to the specific user.


Implementation
    public function get errorCode():int
errorMessageproperty 
errorMessage:String  [read-only]

An error detail message, sent by Lightstreamer Server or by the Metadata Adapter.


Implementation
    public function get errorMessage():String
itemproperty 
item:*  [read-only]

Only effective when the related table behaves in "MultiMetapush logic". In this case, if the control error pertains to a second-level item, then this property is not null and contains the first-level item (which must be in COMMAND mode) to which the second level item is related.

Otherwise, no item is specified, because a subscription error always pertains to the whole table.


Implementation
    public function get item():*
keyproperty 
key:String  [read-only]

Only effective when the related table behaves in "MultiMetapush logic". In this case, if the control error pertains to a second-level item, then this property is not null and contains the key on the first-level item (which must be in COMMAND mode) to which the second level item is related.

Note that the item property still refers to the first-level item.


Implementation
    public function get key():String
Constant Detail
SUBSCRIPTION_ERRORConstant
public static const SUBSCRIPTION_ERROR:String = subscriptionError

Define the value of the type property of a SubscriptionError event object.




Lightstreamer Flex client 2.2.1 API