CreateObject method

Overview

Creates a generic object at app level. For more information on generic objects, see Generic object definition.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.

Parameters

Name	Description	Type
qProp	Information about the object This parameter is mandatory.	GenericObjectProperties See GenericObjectProperties.

Name

Description

Type

qProp

Information about the object

This parameter is mandatory.

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

In addition to the parameters specified above, the parameter qProp can get any properties defined in the Generic object definition section.

Outputs

The following is returned in the output:

"result": { "qReturn": { "qType": "GenericObject", "qHandle": <handle of the new object> }, "qInfo": { "qId": "<identifier of the new object>", "qType": "<type of the new object>" } }

Learn more

Create an app object

CreateChild method

Create a story

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