DestroyChild method

Overview

Removes a child object.

It is possible to update the properties of the child's parent at the same time that the child is removed. Both operations are performed by the same call.

Removing a linked object, invalidate the linking object.

Parameters

Name	Description	Type
qid	Identifier of the child to remove. This parameter is mandatory.	String
qPropForThis	This parameter is optional. Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.	Null or GenericObjectProperties See GenericObjectProperties

Name

Description

Type

qid

Identifier of the child to remove.

This parameter is mandatory.

String

qPropForThis

This parameter is optional.

Identifier of the parent's object and property to update.

Should be set to update the properties of the parent's object at the same time the child is created.

Null or GenericObjectProperties

See GenericObjectProperties

Name	Description	Type
qInfo	Identifier and type of the object. This parameter is mandatory.	NxInfo
qExtendsId	Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). This parameter is mandatory. If you do not want to link your object, set this parameter to an empty string.	String
qMetaDef	Definition of the dynamic properties.	Dynamic properties

Name

Description

Type

qInfo

Identifier and type of the object.

This parameter is mandatory.

NxInfo

qExtendsId

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to).

This parameter is mandatory.

If you do not want to link your object, set this parameter to an empty string.

String

qMetaDef

Definition of the dynamic properties.

Dynamic properties

Name	Description	Type
qId	Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. This parameter is optional. If an identifier is not set, the engine automatically sets one.	String
qType	Type of the object. This parameter is mandatory.	String

Name

Description

Type

qId

Identifier of the object.

If the chosen identifier is already in use, the engine automatically sets another one.

This parameter is optional. If an identifier is not set, the engine automatically sets one.

String

qType

Type of the object.

This parameter is mandatory.

String

Outputs

The following is returned in the output:

"result": { "qSuccess": <true or false>

}

The operation is successful if qSuccess is set to true.

Learn more

Remove a child object

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here