Templates

The Template namespace provides events and errors related to registering templates in the Aura Widget.

Event Flow

Click to expand

Events

Events broadcast by the widget that you can subscribe to.

`Template.Registered`

Fired when a template is successfully registered.

Property	Type	Description
`id`*	`string`	Unique identifier for the template in your system.

* Required field

`Template.AutoRegistered`

Fired when a template has been successfully auto-registered.

Property	Type	Description
`id`*	`string`	Unique identifier for the template in your system.
`body`*	`TemplateOverride['body']`	The resolved template body generated during auto-registration.

* Required field

Errors

The error events emitted during template registration. Each error event receives the common error properties as payload, in addition to the event-specific properties listed below.

`Template.RegisterFailed`

Fired when registering a template fails.

Property	Type	Description
`id`*	`string`	Unique identifier for the template that failed to register.

* Required field

`Template.AutoRegisterFailed`

Fired when auto-registering a template fails.

Property	Type	Description
`id`*	`string`	Unique identifier for the template that failed to auto-register.

* Required field

`Template.Error`

Fired when a generic template error occurs.

Property	Type	Description
`id`*	`string`	Unique identifier for the template involved in the error.

* Required field