Class: ObjectTypeDef
A definition of a custom object defined in a Module.
Extends​
BaseClient
Constructors​
Constructor​
new ObjectTypeDef(
ctx?,_id?,_description?,_name?,_sourceModuleName?):ObjectTypeDef
Constructor is used for internal usage only, do not create object from it.
Parameters​
ctx?​
Context
_id?​
_description?​
string
_name?​
string
_sourceModuleName?​
string
Returns​
ObjectTypeDef
Overrides​
BaseClient.constructor
Methods​
constructor_()​
constructor_():
Function_
The function used to construct new instances of this object, if any
Returns​
description()​
description():
Promise<string>
The doc string for the object, if any.
Returns​
Promise<string>
fields()​
fields():
Promise<FieldTypeDef[]>
Static fields defined on this object, if any.
Returns​
Promise<FieldTypeDef[]>
functions()​
functions():
Promise<Function_[]>
Functions defined on this object, if any.
Returns​
Promise<Function_[]>
id()​
id():
Promise<ObjectTypeDefID>
A unique identifier for this ObjectTypeDef.
Returns​
Promise<ObjectTypeDefID>
name()​
name():
Promise<string>
The name of the object.
Returns​
Promise<string>
sourceMap()​
sourceMap():
SourceMap
The location of this object declaration.
Returns​
sourceModuleName()​
sourceModuleName():
Promise<string>
If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.
Returns​
Promise<string>