Notification

• context : ContextInterface

  readonlyinherited

  module:ui/notification/notification~Notification#context

  The context or editor instance.

  See source (with github icon)

Static properties

• isContextPlugin : true

  readonlyinheritedstatic

  module:ui/notification/notification~Notification.isContextPlugin
  See source (with github icon)

• isOfficialPlugin : true

  readonlystatic

  module:ui/notification/notification~Notification.isOfficialPlugin
  See source (with github icon)

• isPremiumPlugin : boolean

  readonlyinheritedstatic

  module:ui/notification/notification~Notification.isPremiumPlugin
  See source (with github icon)

• pluginName : 'Notification'

  readonlystatic

  module:ui/notification/notification~Notification.pluginName
  See source (with github icon)

• constructor( context )

  inherited

  module:ui/notification/notification~Notification#constructor

  Creates a new plugin instance.

  See source (with github icon)

  Parameters

  context : Editor | Context

• bind( bindProperties ) → ObservableMultiBindChain

  inherited

  module:ui/notification/notification~Notification#bind:MANY_BIND

  Binds observable properties to other objects implementing the Observable interface.

  Read more in the dedicated guide covering the topic of property bindings with some additional examples.

  Consider two objects: a button and an associated command (both Observable).

  A simple property binding could be as follows:

  button.bind( 'isEnabled' ).to( command, 'isEnabled' );
  

  Copy code

  or even shorter:

  button.bind( 'isEnabled' ).to( command );
  

  Copy code

  which works in the following way:

  • button.isEnabled instantly equals command.isEnabled,
  • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

  Note: To release the binding, use unbind.

  You can also "rename" the property in the binding by specifying the new name in the to() chain:

  button.bind( 'isEnabled' ).to( command, 'isWorking' );
  

  Copy code

  It is possible to bind more than one property at a time to shorten the code:

  button.bind( 'isEnabled', 'value' ).to( command );
  

  Copy code

  which corresponds to:

  button.bind( 'isEnabled' ).to( command );
  button.bind( 'value' ).to( command );
  

  Copy code

  The binding can include more than one observable, combining multiple data sources in a custom callback:

  button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
  	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
  

  Copy code

  Using a custom callback allows processing the value before passing it to the target property:

  button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
  

  Copy code

  It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

  button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
  	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
  

  Copy code

  See source (with github icon)

  Parameters

  bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'context' | 'init' | 'showSuccess' | 'showInfo' | 'showWarning'>

  Observable properties that will be bound to other observable(s).

  Returns

  ObservableMultiBindChain

  The bind chain with the to() and toMany() methods.

• bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, Notification[ K1 ], K2, Notification[ K2 ]>

  inherited

  module:ui/notification/notification~Notification#bind:DUAL_BIND

  Binds observable properties to other objects implementing the Observable interface.

  Read more in the dedicated guide covering the topic of property bindings with some additional examples.

  Consider two objects: a button and an associated command (both Observable).

  A simple property binding could be as follows:

  button.bind( 'isEnabled' ).to( command, 'isEnabled' );
  

  Copy code

  or even shorter:

  button.bind( 'isEnabled' ).to( command );
  

  Copy code

  which works in the following way:

  • button.isEnabled instantly equals command.isEnabled,
  • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

  Note: To release the binding, use unbind.

  You can also "rename" the property in the binding by specifying the new name in the to() chain:

  button.bind( 'isEnabled' ).to( command, 'isWorking' );
  

  Copy code

  It is possible to bind more than one property at a time to shorten the code:

  button.bind( 'isEnabled', 'value' ).to( command );
  

  Copy code

  which corresponds to:

  button.bind( 'isEnabled' ).to( command );
  button.bind( 'value' ).to( command );
  

  Copy code

  The binding can include more than one observable, combining multiple data sources in a custom callback:

  button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
  	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
  

  Copy code

  Using a custom callback allows processing the value before passing it to the target property:

  button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
  

  Copy code

  It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

  button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
  	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
  

  Copy code

  See source (with github icon)

  Type parameters

  K1

  K2

  Parameters

  bindProperty1 : K1

  Observable property that will be bound to other observable(s).

  bindProperty2 : K2

  Observable property that will be bound to other observable(s).

  Returns

  ObservableDualBindChain<K1, Notification[ K1 ], K2, Notification[ K2 ]>

  The bind chain with the to() and toMany() methods.

• bind( bindProperty ) → ObservableSingleBindChain<K, Notification[ K ]>

  inherited

  module:ui/notification/notification~Notification#bind:SINGLE_BIND

  Binds observable properties to other objects implementing the Observable interface.

  Read more in the dedicated guide covering the topic of property bindings with some additional examples.

  Consider two objects: a button and an associated command (both Observable).

  A simple property binding could be as follows:

  button.bind( 'isEnabled' ).to( command, 'isEnabled' );
  

  Copy code

  or even shorter:

  button.bind( 'isEnabled' ).to( command );
  

  Copy code

  which works in the following way:

  • button.isEnabled instantly equals command.isEnabled,
  • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

  Note: To release the binding, use unbind.

  You can also "rename" the property in the binding by specifying the new name in the to() chain:

  button.bind( 'isEnabled' ).to( command, 'isWorking' );
  

  Copy code

  It is possible to bind more than one property at a time to shorten the code:

  button.bind( 'isEnabled', 'value' ).to( command );
  

  Copy code

  which corresponds to:

  button.bind( 'isEnabled' ).to( command );
  button.bind( 'value' ).to( command );
  

  Copy code

  The binding can include more than one observable, combining multiple data sources in a custom callback:

  button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
  	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
  

  Copy code

  Using a custom callback allows processing the value before passing it to the target property:

  button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
  

  Copy code

  It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

  button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
  	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
  

  Copy code

  See source (with github icon)

  Type parameters

  K

  Parameters

  bindProperty : K

  Observable property that will be bound to other observable(s).

  Returns

  ObservableSingleBindChain<K, Notification[ K ]>

  The bind chain with the to() and toMany() methods.

• decorate( methodName ) → void

  inherited

  module:ui/notification/notification~Notification#decorate

  Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

  Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

  Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

  For example, to cancel the method execution the event can be stopped:

  class Foo extends ObservableMixin() {
  	constructor() {
  		super();
  		this.decorate( 'method' );
  	}
  
  	method() {
  		console.log( 'called!' );
  	}
  }
  
  const foo = new Foo();
  foo.on( 'method', ( evt ) => {
  	evt.stop();
  }, { priority: 'high' } );
  
  foo.method(); // Nothing is logged.
  

  Copy code

  Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

  It is also possible to change the returned value:

  foo.on( 'method', ( evt ) => {
  	evt.return = 'Foo!';
  } );
  
  foo.method(); // -> 'Foo'
  

  Copy code

  Finally, it is possible to access and modify the arguments the method is called with:

  method( a, b ) {
  	console.log( `${ a }, ${ b }`  );
  }
  
  // ...
  
  foo.on( 'method', ( evt, args ) => {
  	args[ 0 ] = 3;
  
  	console.log( args[ 1 ] ); // -> 2
  }, { priority: 'high' } );
  
  foo.method( 1, 2 ); // -> '3, 2'
  

  Copy code

  See source (with github icon)

  Parameters

  methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'context' | 'init' | 'showSuccess' | 'showInfo' | 'showWarning'

  Name of the method to decorate.

  Returns

  void

• delegate( events ) → EmitterMixinDelegateChain

  inherited

  module:ui/notification/notification~Notification#delegate

  Delegates selected events to another Emitter. For instance:

  emitterA.delegate( 'eventX' ).to( emitterB );
  emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
  

  Copy code

  then eventX is delegated (fired by) emitterB and emitterC along with data:

  emitterA.fire( 'eventX', data );
  

  Copy code

  and eventY is delegated (fired by) emitterC along with data:

  emitterA.fire( 'eventY', data );
  

  Copy code

  See source (with github icon)

  Parameters

  events : Array<string>

  Event names that will be delegated to another emitter.

  Returns

  EmitterMixinDelegateChain

• destroy() → void

  inherited

  module:ui/notification/notification~Notification#destroy

  Destroys the plugin.

  Note: This method is optional. A plugin instance does not need to have it defined.

  See source (with github icon)

  Returns

  void

• fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

  inherited

  module:ui/notification/notification~Notification#fire

  Fires an event, executing all callbacks registered for it.

  The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

  See source (with github icon)

  Type parameters

  TEvent : extends BaseEvent

  The type describing the event. See BaseEvent.

  Parameters

  eventOrInfo : GetNameOrEventInfo<TEvent>

  The name of the event or EventInfo object if event is delegated.

  args : TEvent[ 'args' ]

  Additional arguments to be passed to the callbacks.

  Returns

  GetEventInfo<TEvent>[ 'return' ]

  By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

• init() → void

  module:ui/notification/notification~Notification#init
  See source (with github icon)

  Returns

  void

• listenTo( emitter, event, callback, [ options ] ) → void

  inherited

  module:ui/notification/notification~Notification#listenTo:BASE_EMITTER

  Registers a callback function to be executed when an event is fired in a specific (emitter) object.

  Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

  // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
  myEmitter.on( 'myGroup', genericCallback );
  myEmitter.on( 'myGroup:myEvent', specificCallback );
  
  // genericCallback is fired.
  myEmitter.fire( 'myGroup' );
  // both genericCallback and specificCallback are fired.
  myEmitter.fire( 'myGroup:myEvent' );
  // genericCallback is fired even though there are no callbacks for "foo".
  myEmitter.fire( 'myGroup:foo' );
  

  Copy code

  An event callback can stop the event and set the return value of the fire method.

  See source (with github icon)

  Type parameters

  TEvent : extends BaseEvent

  The type describing the event. See BaseEvent.

  Parameters

  emitter : Emitter

  The object that fires the event.

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• off( event, callback ) → void

  inherited

  module:ui/notification/notification~Notification#off

  Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

  See source (with github icon)

  Parameters

  event : string

  The name of the event.

  callback : Function

  The function to stop being called.

  Returns

  void

• on( event, callback, [ options ] ) → void

  inherited

  module:ui/notification/notification~Notification#on

  Registers a callback function to be executed when an event is fired.

  Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

  See source (with github icon)

  Type parameters

  TEvent : extends BaseEvent

  The type descibing the event. See BaseEvent.

  Parameters

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• once( event, callback, [ options ] ) → void

  inherited

  module:ui/notification/notification~Notification#once

  Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

  See source (with github icon)

  Type parameters

  TEvent : extends BaseEvent

  The type descibing the event. See BaseEvent.

  Parameters

  event : TEvent[ 'name' ]

  The name of the event.

  callback : GetCallback<TEvent>

  The function to be called on event.

  [ options ] : GetCallbackOptions<TEvent>

  Additional options.

  Returns

  void

• set( values ) → void

  inherited

  module:ui/notification/notification~Notification#set:OBJECT

  Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

  It accepts a single object literal containing key/value pairs with properties to be set.

  This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

  In TypeScript, those properties should be declared in class using declare keyword. In example:

  public declare myProp1: number;
  public declare myProp2: string;
  
  constructor() {
  	this.set( {
  		'myProp1: 2,
  		'myProp2: 'foo'
  	} );
  }
  

  Copy code

  See source (with github icon)

  Parameters

  values : object

  An object with name=>value pairs.

  Returns

  void

• set( name, value ) → void

  inherited

  module:ui/notification/notification~Notification#set:KEY_VALUE

  Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

  This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

  In TypeScript, those properties should be declared in class using declare keyword. In example:

  public declare myProp: number;
  
  constructor() {
  	this.set( 'myProp', 2 );
  }
  

  Copy code

  See source (with github icon)

  Type parameters

  K

  Parameters

  name : K

  The property's name.

  value : Notification[ K ]

  The property's value.

  Returns

  void

• showInfo( message, data = { [data.namespace], [data.title] } ) → void

  module:ui/notification/notification~Notification#showInfo

  Shows an information notification.

  By default, it fires the show:info event with the given data. The event namespace can be extended using the data.namespace option. For example:

  showInfo( 'Editor is offline.', {
  	namespace: 'editor:status'
  } );
  

  Copy code

  will fire the show:info:editor:status event.

  You can provide the title of the notification:

  showInfo( 'Editor is offline.', {
  	title: 'Network information'
  } );
  

  Copy code

  See source (with github icon)

  Parameters

  message : string

  The content of the notification.

  data : object

  Additional data.

  Properties

  [ data.namespace ] : string

  Additional event namespace.

  [ data.title ] : string

  The title of the notification.

  Defaults to {}

  Returns

  void

• showSuccess( message, data = { [data.namespace], [data.title] } ) → void

  module:ui/notification/notification~Notification#showSuccess

  Shows a success notification.

  By default, it fires the show:success event with the given data. The event namespace can be extended using the data.namespace option. For example:

  showSuccess( 'Image is uploaded.', {
  	namespace: 'upload:image'
  } );
  

  Copy code

  will fire the show:success:upload:image event.

  You can provide the title of the notification:

  showSuccess( 'Image is uploaded.', {
  	title: 'Image upload success'
  } );
  

  Copy code

  See source (with github icon)

  Parameters

  message : string

  The content of the notification.

  data : object

  Additional data.

  Properties

  [ data.namespace ] : string

  Additional event namespace.

  [ data.title ] : string

  The title of the notification.

  Defaults to {}

  Returns

  void

• showWarning( message, data = { [data.namespace], [data.title] } ) → void

  module:ui/notification/notification~Notification#showWarning

  Shows a warning notification.

  By default, it fires the show:warning event with the given data. The event namespace can be extended using the data.namespace option. For example:

  showWarning( 'Image upload error.', {
  	namespace: 'upload:image'
  } );
  

  Copy code

  will fire the show:warning:upload:image event.

  You can provide the title of the notification:

  showWarning( 'Image upload error.', {
  	title: 'Upload failed'
  } );
  

  Copy code

  Note that each unhandled and not stopped warning notification will be displayed as a system alert. The plugin responsible for displaying warnings should stop() the event to prevent displaying it as an alert:

  notifications.on( 'show:warning', ( evt, data ) => {
  	// Do something with the data.
  
  	// Stop this event to prevent displaying it as an alert.
  	evt.stop();
  } );
  

  Copy code

  You can attach many listeners to the same event and stop() this event in a listener with a low priority:

  notifications.on( 'show:warning', ( evt, data ) => {
  	// Show the warning in the UI, but do not stop it.
  } );
  
  notifications.on( 'show:warning', ( evt, data ) => {
  	// Log the warning to some error tracker.
  
  	// Stop this event to prevent displaying it as an alert.
  	evt.stop();
  }, { priority: 'low' } );
  

  Copy code

  See source (with github icon)

  Parameters

  message : string

  The content of the notification.

  data : object

  Additional data.

  Properties

  [ data.namespace ] : string

  Additional event namespace.

  [ data.title ] : string

  The title of the notification.

  Defaults to {}

  Returns

  void

• stopDelegating( [ event ], [ emitter ] ) → void

  inherited

  module:ui/notification/notification~Notification#stopDelegating

  Stops delegating events. It can be used at different levels:

  • To stop delegating all events.
  • To stop delegating a specific event to all emitters.
  • To stop delegating a specific event to a specific emitter.

  See source (with github icon)

  Parameters

  [ event ] : string

  The name of the event to stop delegating. If omitted, stops it all delegations.

  [ emitter ] : Emitter

  (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

  Returns

  void

• stopListening( [ emitter ], [ event ], [ callback ] ) → void

  inherited

  module:ui/notification/notification~Notification#stopListening:BASE_STOP

  Stops listening for events. It can be used at different levels:

  • To stop listening to a specific callback.
  • To stop listening to a specific event.
  • To stop listening to all events fired by a specific object.
  • To stop listening to all events fired by all objects.

  See source (with github icon)

  Parameters

  [ emitter ] : Emitter

  The object to stop listening to. If omitted, stops it for all objects.

  [ event ] : string

  (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

  [ callback ] : Function

  (Requires the event) The function to be removed from the call list for the given event.

  Returns

  void

• unbind( unbindProperties ) → void

  inherited

  module:ui/notification/notification~Notification#unbind

  Removes the binding created with bind.

  // Removes the binding for the 'a' property.
  A.unbind( 'a' );
  
  // Removes bindings for all properties.
  A.unbind();
  

  Copy code

  See source (with github icon)

  Parameters

  unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'context' | 'init' | 'showSuccess' | 'showInfo' | 'showWarning'>

  Observable properties to be unbound. All the bindings will be released if no properties are provided.

  Returns

  void

• _showNotification( data = { data.message, [data.namespace], [data.title], data.type } ) → void

  private

  module:ui/notification/notification~Notification#_showNotification

  Fires the show event with the specified type, namespace and message.

  See source (with github icon)

  Parameters

  data : object

  The message data.

  Properties

  data.message : string

  The content of the notification.

  [ data.namespace ] : string

  Additional event namespace.

  [ data.title ] : string

  The title of the notification.

  data.type : NotificationEventType

  The type of the message.

  Returns

  void

• change:{property}( eventInfo, name, value, oldValue )

  inherited

  module:ui/notification/notification~Notification#event:change:{property}

  Fired when a property changed value.

  observable.set( 'prop', 1 );
  
  observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
  	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
  } );
  
  observable.prop = 2; // -> 'prop has changed from 1 to 2'
  

  Copy code

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  name : string

  The property name.

  value : TValue

  The new property value.

  oldValue : TValue

  The previous property value.

• set:{property}( eventInfo, name, value, oldValue )

  inherited

  module:ui/notification/notification~Notification#event:set:{property}

  Fired when a property value is going to be set but is not set yet (before the change event is fired).

  You can control the final value of the property by using the event's return property.

  observable.set( 'prop', 1 );
  
  observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
  	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
  	console.log( `Current property value is ${ observable[ propertyName ] }` );
  
  	// Let's override the value.
  	evt.return = 3;
  } );
  
  observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
  	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
  } );
  
  observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                       // -> 'Current property value is 1'
                       // -> 'Value has changed from 1 to 3'
  

  Copy code

  Note: The event is fired even when the new value is the same as the old value.

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  name : string

  The property name.

  value : TValue

  The new property value.

  oldValue : TValue

  The previous property value.

• show( eventInfo, data )

  module:ui/notification/notification~Notification#event:show

  Fired when one of the showSuccess(), showInfo(), showWarning() methods is called.

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  data : NotificationShowEventData

  The notification data.

• show:info( eventInfo, data )

  module:ui/notification/notification~Notification#event:show:info

  Fired when the showInfo() method is called.

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  data : NotificationShowEventData<NotificationType>

  The notification data.

• show:success( eventInfo, data )

  module:ui/notification/notification~Notification#event:show:success

  Fired when the showSuccess() method is called.

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  data : NotificationShowEventData<NotificationType>

  The notification data.

• show:warning( eventInfo, data )

  module:ui/notification/notification~Notification#event:show:warning

  Fired when the showWarning() method is called.

  When this event is not handled or stopped by event.stop(), the data.message of this event will be automatically displayed as a system alert.

  See source (with github icon)

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  data : NotificationShowEventData<NotificationType>

  The notification data.