English
getDescribe
About 135 wordsLess than 1 minute
2025-09-22
This method synchronously returns the metadata of the current detail object, taken from the describe field returned by the detail page interface.

Parameters
None
Return Value
Only some fields are listed below.
| Field | Description | Type |
|---|---|---|
| api_name | Object apiName | String |
| display_name | Object name | String |
| fields | All fields of the object | Object |
| Other fields | — | — |
Code Example
Inside the plugin:
module.exports = function (context, pluginService, pluginParam) {
return {
apply() {
return [
{
event: 'detail.render.before',
functional: function (pluginExecResult, options) {
console.log('custom plugin: detail.render.before exec')
// Get the metadata of the current detail object
console.log(context.getDescribe())
}
}
]
}
}
}Notes
Do not modify any property in the object metadata, as it may lead to unexpected results.
context.getDescribe().testkey = '' // forbidden let describe = context.getDescribe() describe.testkey = '' // forbidden describe.fields.testkey = '' // forbidden
