{{name}}

{{#if type}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if deprecated}} deprecated {{/if}} {{#if access}} {{access}} {{/if}} {{#if final}} final {{/if}} {{#if static}} static {{/if}}
{{#if overwritten_from}}

Inherited from {{overwritten_from/class}} {{#if foundAt}} but overwritten in {{/if}} {{else}} {{#if extendedFrom}} {{#shouldShowInherit extendedFrom}}

{{@root.i18n.INHERITED_FROM}} {{../extendedFrom}}: {{/shouldShowInherit}} {{else}} {{#providedBy}}

Provided by the {{.}} module.

{{/providedBy}}

{{!-- {{#if foundAt}} --}} {{!-- Defined in --}} {{!-- {{/if}} --}} {{/if}} {{/if}} {{#if foundAt}} `{{{file}}}:{{{line}}}` {{/if}}

{{#if deprecationMessage}}

Deprecated: {{deprecationMessage}}

{{/if}} {{#if since}}

Available since {{since}}

{{/if}}
{{{description}}}
{{#if params}}

Event Payload:

    {{#params}}
  • {{#if optional}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}} {{#if multiple}} Multiple {{/if}}
    {{{description}}}
    {{#if props}}
      {{#props}}
    • {{#if optional}} [{{name}}{{#if optdefault}}={{optdefault}}{{/if}}] {{#crossLink type}}{{/crossLink}} optional {{else}} {{name}} {{#crossLink type}}{{/crossLink}} {{/if}}
      {{{description}}}
      {{#if props}}
        {{#props}}
      • {{name}} {{#crossLink type}}{{/crossLink}}
        {{{description}}}
        • {{/props}}
      {{/if}}
      • {{/props}}
    {{/if}}
    • {{/params}}
{{/if}} {{#example}}

{{../i18n.EXAMPLES}}:

{{{.}}}
{{/example}}