coapiUtilities
coapiUtilities
coapiUtilities
Metadata
createCopy()
Returns a duplicated struct with any extended array properties changed to point to the new struct.
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
objectid |
uuid |
Yes |
[runtime expression] |
|
|
typename |
string |
No |
|
|
|
createRefObjectID()
Ensures objectid is unique and creates a refObject reference record.
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
objectid |
String |
Yes |
|
|
The objectID to check |
typename |
string |
Yes |
[runtime expression] |
|
|
dsn |
string |
No |
[runtime expression] |
|
|
dbtype |
string |
No |
[runtime expression] |
|
|
dbowner |
string |
No |
[runtime expression] |
|
|
findType()
Determine the typename for an objectID.
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
objectid |
String |
Yes |
|
|
|
dsn |
string |
No |
[runtime expression] |
|
|
dbowner |
string |
No |
[runtime expression] |
|
|
getContentObject()
Allows you to fetch a content object with only the objectID
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
objectid |
UUID |
Yes |
|
|
The object for which object is to be found |
typename |
string |
No |
|
|
The typename of the objectid. Pass in to avoid having to lookup the type. |
getRelatedContent()
Returns a query containing all the objects related to the objectid passed in.
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
objectid |
uuID |
Yes |
|
|
The object for which related objects are to be found |
typename |
string |
No |
|
|
The typename of the objectid. Pass in to avoid having to lookup the type. |
filter |
string |
No |
|
|
The typename of related objects to find. Empty for ALL typenames. |
arrayType |
string |
No |
|
|
The typename containing the property that defines the relationship we are looking for |
arrayProperty |
string |
No |
|
|
The property that defines the relationship we are looking for |
init()
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
None |
loadPlugin()
Loads a plugin; makes plugin active for application
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
None |
typeInRefObjects()
Returns true/false as to whether the type is to add a reference in the refObjects table
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
typename |
String |
Yes |
|
|
The name of the type to check |
unloadPlugin()
Unloads a plugin; makes plugin inactive for application
Arguments
Name |
Type |
Required |
Default |
Options |
Description |
plugin |
string |
Yes |
|
|
Name of the plugin to remove. |