Status Object Preview

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Application/Status.h>

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Used to communicate the current status of an object or operation. This provides the status and any error messages that might accompany an error or warning.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

Properties

Name Description
isError If true, An error occurred that has prevented the operation from successfully completing. This takes into account all of the child status messages.
isOK If true, the operation was successful without any warnings or errors. This takes into account all of the child status messages.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isWarning If true, the operation has succeeded but with an unusual result. This takes into account all of the child status messages.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
statusMessages the status messages associated with this status. These messages are displayed to the user in the alert dialog. Each status message can have children status messages that will be displayed as a tree structure in the alert dialog.

Accessed From

CustomFeatureEventArgs.computeStatus, DataEventArgs.status

Version

Introduced in version July 2021