Bug 1888908 - Rename current onEngagement to onLegacyEngagement r=mak
Differential Revision: https://phabricator.services.mozilla.com/D206251
This commit is contained in:
@@ -2475,7 +2475,7 @@ export class UrlbarProvider {
|
||||
* @param {UrlbarController} _controller
|
||||
* The associated controller.
|
||||
*/
|
||||
onEngagement(_state, _queryContext, _details, _controller) {}
|
||||
onLegacyEngagement(_state, _queryContext, _details, _controller) {}
|
||||
|
||||
/**
|
||||
* Called before a result from the provider is selected. See `onSelection`
|
||||
@@ -2493,8 +2493,8 @@ export class UrlbarProvider {
|
||||
* Called when a result from the provider is selected. "Selected" refers to
|
||||
* the user highlighing the result with the arrow keys/Tab, before it is
|
||||
* picked. onSelection is also called when a user clicks a result. In the
|
||||
* event of a click, onSelection is called just before onEngagement. Note that
|
||||
* this is called when heuristic results are pre-selected.
|
||||
* event of a click, onSelection is called just before onLegacyEngagement.
|
||||
* Note that this is called when heuristic results are pre-selected.
|
||||
*
|
||||
* @param {UrlbarResult} _result
|
||||
* The result that was selected.
|
||||
@@ -2577,8 +2577,8 @@ export class UrlbarProvider {
|
||||
/**
|
||||
* Gets the list of commands that should be shown in the result menu for a
|
||||
* given result from the provider. All commands returned by this method should
|
||||
* be handled by implementing `onEngagement()` with the possible exception of
|
||||
* commands automatically handled by the urlbar, like "help".
|
||||
* be handled by implementing `onLegacyEngagement()` with the possible
|
||||
* exception of commands automatically handled by the urlbar, like "help".
|
||||
*
|
||||
* @param {UrlbarResult} _result
|
||||
* The menu will be shown for this result.
|
||||
@@ -2590,8 +2590,8 @@ export class UrlbarProvider {
|
||||
* {string} name
|
||||
* The name of the command. Must be specified unless `children` is
|
||||
* present. When a command is picked, its name will be passed as
|
||||
* `details.selType` to `onEngagement()`. The special name "separator"
|
||||
* will create a menu separator.
|
||||
* `details.selType` to `onLegacyEngagement()`. The special name
|
||||
* "separator" will create a menu separator.
|
||||
* {object} l10n
|
||||
* An l10n object for the command's label: `{ id, args }`
|
||||
* Must be specified unless `name` is "separator".
|
||||
|
||||
Reference in New Issue
Block a user