StatusMessages Object Preview

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Application/StatusMessages.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

A collection of status messages associated with a Status object. The primary purpose of the messages is to describe the reason for a warning or failure and display the messages in the alert dialog.

Methods

Name Description
addError Adds a new error status message to the list of warning and error messages.
addWarning Adds a new warning status message to the list of warning and error messages.
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().
item Returns the specified status message using an index into the collection.

Properties

Name Description
count Returns the number of status messages in this collection.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
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():

Accessed From

Status.statusMessages, StatusMessage.childStatusMessages

Version

Introduced in version July 2021