$notify

Synopsis

$notify__[object]

Description

$notify lists details about all notifications on an object. A notification contains a list of events that a method has requested on an object.

If a notification has a value changed event, it indicates that the method will be executed when the value of this object is changed.

If a notification has an instance or de-instance event, it indicates that the method will be executed when the object is created or destroyed.

If a notification has a read or write event, it indicates this method has specified the read or write attributes for this object. If one method reads this object, and another writes this object, the read method is given a dependency on the write object.

For each notification, AVS/Express prints the following information:

function

The pathname of the method from which this notification originated.

context

The pathname of the context argument of that method. This is usually the object that the method is associated with.

template

Notifications are often modified by a template object that indicates which subobjects of the current object are involved in this notification.

on events

This is a list of the names of the events this method requested for this object. The events are:

Event	Description
value changed	The method is executed when the value is changed.
<null event>	This indicates that the notifications are added to subobjects of this object looking for read, write, and notify attributes to start turning on new events.
object-instanced	The method is called when the object is created.
object de-instanced	The method is called when the object is de-instanced.
object deleted	The method is called when the object is destroyed.
sub-object added	The method is called when a new subobject is added.
sub-object deleted	The method is called when a subobject is deleted.
name-changed	The method is called when this object's name is changed.
read	The method has the read attribute marked for this object.
write	The method has the write attribute marked for this object.
needs-inst	This method gets a dependency on any methods that have the object-instanced event set.

with mode

This indicates whether or not there are special modes associated with this notification. Modes are:

Mode name	Description
(immediate)	This notification is delivered right when the event occurs instead of being put on the queue and executed when this operation is complete.
(no sub objects)	This notification is not propagated to subobjects.
(keep refcnt)	(Internal flag) The notifier is deleted when the last notification is removed.

Since the Network Editor uses the notification mechanism to keep track of the objects that it is displaying, you frequently see notifications being delivered to objects that are part of the Network Editor.

Examples

OM(SingleWindowApp) -> UIbutton button;
OM(SingleWindowApp) -> $notify button.label
------ object: Root.Applications.SingleWindowApp.button.label will notify:
function : SingleWindowApp.button.update
with context : SingleWindowApp.button
using template: <null>
on events : value changed
with mode : (keep refcnt)