Edit

ISPEventObserver interface

  • Reference
Package:
@microsoft/sp-core-library

Used with the SPEvent system, this interface is implemented by components that can subscribe to events.

Extends
IDisposable

Remarks

ISPEventObserver is an abstraction of the key features that a component must have in order to subscribe to a SharePoint Framework event: It must have instanceId and componentId information for diagnostics reporting, and it must have a way to notify the event system when the component is disposed, so that its handlers can be automatically removed. Other objects may implement this contract, as long as they meet these requirements.

Properties

componentId

The component identifier, from the component's manifest.
instanceId

The instance identifier for the component.

Property Details

componentId

The component identifier, from the component's manifest.

readonly componentId: string;

Property Value

string

Remarks

This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception

instanceId

The instance identifier for the component.

readonly instanceId: string;

Property Value

string

Remarks

This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception