Abstract Class sap.ui.core.ComponentModule: sap/ui/core/Component

Returns user specific data object

Returns the event bus of this component.

Returns the manifest defined in the metadata of the component. If not specified, the return value is null.

Returns the configuration of a manifest section or the value for a specific path. If no section or key is specified, the return value is null.

Example: { "sap.ui5": { "dependencies": { "libs": { "sap.m": {} }, "components": { "my.component.a": {} } } });

The configuration above can be accessed in the following ways:

• By section/namespace: oComponent.getManifestEntry("sap.ui5")
• By path: oComponent.getManifestEntry("/sap.ui5/dependencies/libs")

By section/namespace returns the configuration for the specified manifest section and by path allows to specify a concrete path to a dedicated entry inside the manifest. The path syntax always starts with a slash (/).

Returns the manifest object.

Returns the metadata for the specific class of the current instance.

Returns a service interface for the Service declared in the descriptor for components (manifest.json). The declaration needs to be done in the sap.ui5/services section as follows:

{
  [...]
  "sap.ui5": {
    "services": {
      "myLocalServiceAlias": {
        "factoryName": "my.ServiceFactory",
        ["optional": true]
      }
    }
  }
  [...]
}

The service declaration is used to define a mapping between the local alias for the service that can be used in the Component and the name of the service factory which will be used to create a service instance.

The getService function will look up the service factory and will create a new instance by using the service factory function createInstance The optional property defines that the service is not mandatory and the usage will not depend on the availability of this service. When requesting an optional service the getService function will reject but there will be no error logged in the console.

When creating a new instance of the service the Component context will be passed as oServiceContext as follows:

{
  "scopeObject": this,     // the Component instance
  "scopeType": "component" // the stereotype of the scopeObject
}

The service will be created only once per Component and reused in future calls to the getService function.

This function will return a Promise which provides the service interface when resolved. If the factoryName could not be found in the Service Factory Registry or the service declaration in the descriptor for components (manifest.json) is missing the Promise will reject.

This is an example of how the getService function can be used:

oComponent.getService("myLocalServiceAlias").then(function(oService) {
  oService.doSomething();
}).catch(function(oError) {
  jQuery.sap.log.error(oError);
});

The hook which gets called when the static configuration of the component has been changed by some configuration extension.

The window before unload hook. Override this method in your Component class implementation, to handle cleanup before the real unload or to prompt a question to the user, if the component should be exited.

The window error hook. Override this method in your Component class implementation to listen to unhandled errors.

The window unload hook. Override this method in your Component class implementation, to handle cleanup of the component once the window will be unloaded (e.g. closed).

Calls the function fn once and marks all ManagedObjects created during that call as "owned" by this Component.

Nested calls of this method are supported (e.g. inside a newly created, nested component). The currently active owner Component will be remembered before executing fn and restored afterwards.