SharedObject.onStatus

Availability

Flash Player 6.

Usage

myLocalSharedObject.onStatus = function(infoObject) {
  // your statements here
}

Parameters

infoObject A parameter defined according to the status message.

Returns

Nothing.

Description

Event handler; invoked every time an error, warning, or informational note is posted for a shared object. If you want to respond to this event handler, you must create a function to process the information object generated by the shared object.

The information object has a code property containing a string that describes the result of the onStatus handler, and a level property containing a string that is either "Status" or "Error".

In addition to this onStatus handler, Flash also provides a "super" function called System.onStatus. If onStatus is invoked for a particular object and there is no function assigned to respond to it, Flash processes a function assigned to System.onStatus if it exists.

The following events notify you when certain SharedObject activities occur.

Code property

Level property

Meaning

SharedObject.Flush.Failed

Error

A SharedObject.flush() command that returned "pending" has failed (the user did not allot additional disk space for the shared object when Flash Player displayed the Local Storage Settings dialog box).

SharedObject.Flush.Success

Status

A SharedObject.flush() command that returned "pending" has been successfully completed (the user allotted additional disk space for the shared object).

See also

SharedObject.getLocal(), System.onStatus