StatusMessage Object

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

Description

Defines the message associated with a Status object.

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
childStatusMessages Returns the collection of status codes that are children of this status message.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
message The user visible message being used. Setting this message for custom feature errors or warnings is currently ignored.
messageId Gets and sets the ID of the message being used. This is a predefined ID within the Fusion message string table.
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():
statusMessageType Returns the type of message this StatusMessage represents.

Accessed From

StatusMessages.addError, StatusMessages.addWarning, StatusMessages.item

Version

Introduced in version July 2021