Class: AmxNodeUpdateArguments

Methods

adopt(theRawObject)

Adopt the properties of another object as our own.

Parameters:

Name	Type	Description
theRawObject	Object	the other object

Inherited From:

• adf.mf.api.AdfObject#adopt

clone() → {Object}

Returns a clone of this object. The default implementation is a shallow copy. Subclassers can override this method to implement a deep copy.

Inherited From:

• adf.mf.api.AdfObject#clone

Returns:

a new shallow copy of this object

Type

Object

createCallback(func) → {function}

Creates a function instance that will call back the passed in function with the current "this". This is extremely useful for creating callbacks.

Parameters:

Name	Type	Description
func	function	the function to proxy

Inherited From:

• adf.mf.api.AdfObject#createCallback

Returns:

the proxied function

Type

function

equals(object) → {boolean}

Indicates whether some other adf.mf.api.AdfObject is "equal to" this one. Method is equivalent to java ".equals()" method.

Parameters:

Name	Type	Description
object	Object	the object to compare with

Inherited From:

• adf.mf.api.AdfObject#equals

Returns:

whether the objects are "equal"

Type

boolean

getAffectedAttributes(amxNodeId) → {Object<string, boolean>}

Get an object representing the affected attributes for a given AmxNode ID

Parameters:

Name	Type	Description
amxNodeId	string	the AmxNode ID

Returns:

an object with the changed attributes as keys and "true" as the value.

Type

Object<string, boolean>

getAffectedNodes() → {Array.<adf.mf.api.amx.AmxNode>}

Get an array of affected AmxNodes

Returns:

array of nodes

Type

Array.<adf.mf.api.amx.AmxNode>

getClass(otherInstance) → {Object}

Get the class for an object.

Parameters:

Name	Type	Description
otherInstance	Object	optional other object to use

Inherited From:

• adf.mf.api.AdfObject#getClass

Returns:

the class of or null if the class cannot be found

Type

Object

getCollectionChanges(amxNodeId) → {Object<string, adf.mf.api.amx.AmxCollectionChange>|undefined}

Get the collection changes for a given AmxNode and property

Parameters:

Name	Type	Description
amxNodeId	string	the AmxNode ID

Returns:

an object with the attributes as keys and the collection change objects for the values. May be undefined if there are no changes for a given AmxNode

Type

Object<string, adf.mf.api.amx.AmxCollectionChange> | undefined

getTypeName() → {String}

Returns the type name for this instance

Inherited From:

• adf.mf.api.AdfObject#getTypeName

Returns:

name of the Class

Type

String

setAffectedAttribute(amxNode, attributeName)

Mark an attribute of an AmxNode as affected

Parameters:

Name	Type	Description
amxNode	adf.mf.api.amx.AmxNode	the affected AmxNode
attributeName	string	the name of the affected attribute

setCollectionChanges(amxNodeId, attributeName, collectionChanges)

Set the collection changes for a given AmxNode's attribute

Parameters:

Name	Type	Description
amxNodeId	string	the AMX node ID
attributeName	string	the name of the attribute that the collection had changes
collectionChanges	adf.mf.api.amx.AmxCollectionChange	the changes for the collection

toDebugString() → {String}

Get a debug string representation of this object instance. It is not guaranteed to be unique or of a standard format.

Inherited From:

• adf.mf.api.AdfObject#toDebugString

Returns:

a debug string representation of this object instance

Type

String

toString() → {String}

Get a string representation of this object instance. It is not guaranteed to be unique or interesting.

Inherited From:

• adf.mf.api.AdfObject#toString

Returns:

a string representation of this object instance

Type

String

Non-public Methods

<protected> GetLazyArrayProperty(key, createIfNonexistent, otherInstance) → {Object}

Returns the specified array property. If createIfNonexistent is true and the property doesn't exist, it will be created, and returned.

Parameters:

Name	Type	Description
key	Object	the key for the property
createIfNonexistent	boolean	true if a new empty Array should be created and associated
otherInstance	Array	another object to use instead of this object

Inherited From:

• adf.mf.api.AdfObject#GetLazyArrayProperty

Returns:

the property value associated with the given key

Type

Object

<protected> GetLazyMapProperty(key, createIfNonexistent, otherInstance) → {Object}

Returns the specified Map property value. If createIfNonexistent is true and the property doesn't exist, an empty Object will be created, and returned.

Parameters:

Name	Type	Description
key	Object	the key for the property
createIfNonexistent	boolean	true if a new empty Object should be created and associated
otherInstance	Object	another object to use instead of this object

Inherited From:

• adf.mf.api.AdfObject#GetLazyMapProperty

Returns:

the property value associated with the given key

Type

Object