Class sap.collaboration.components.fiori.notification.ComponentModule: sap/collaboration/components/fiori/notification/Component

Notification Component

A Notification Component is a ui5 component that displays a SAP Jam member's latest notifications.

This component refreshes itself when the number of seconds specified in the refreshInterval parameter elapses. When refreshing, the backend is called to obtain the latest notifications.

Deprecated API:Since version 1.26.0. There is no replacement for this control. The Fiori Launchpad now provides its own implementation for this control. This control was never meant to be used directly by third parties.


Since: version 1.18.
Constructor Summary
new sap.collaboration.components.fiori.notification.Component(oDataServiceUrl?, numberOfNotifications?, transitionInterval?, refreshInterval?, notificationsTargetUrl)Constructor for the notification component

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Method Summary
sap.collaboration.components.fiori.notification.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.collaboration.components.fiori.notification.Component with name sClassName and enriches it with the information contained in oClassInfo.
sap.collaboration.components.fiori.notification.Component.getMetadata()Returns a metadata object for class sap.collaboration.components.fiori.notification.Component.
getNotificationsTargetUrl()Gets current value of property notificationsTargetUrl.
getNumberOfNotifications()Gets current value of property numberOfNotifications.
getODataServiceUrl()Gets current value of property oDataServiceUrl.
getRefreshInterval()Gets current value of property refreshInterval.
getTransitionInterval()Gets current value of property transitionInterval.
setNotificationsTargetUrl(sNotificationsTargetUrl)Sets a new value for property notificationsTargetUrl.
setNumberOfNotifications(iNumberOfNotifications)Sets a new value for property numberOfNotifications.
setODataServiceUrl(sODataServiceUrl)Sets a new value for property oDataServiceUrl.
setRefreshInterval(iRefreshInterval)Sets a new value for property refreshInterval.
setTransitionInterval(iTransitionInterval)Sets a new value for property transitionInterval.
Constructor Detail
new sap.collaboration.components.fiori.notification.Component(oDataServiceUrl?, numberOfNotifications?, transitionInterval?, refreshInterval?, notificationsTargetUrl)
Constructor for the notification component

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Parameters:
{sap.ui.core.URI}oDataServiceUrl? The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
{sap.ui.core.int}numberOfNotifications? This is the maximum number of notifications to be displayed. The default value is 10.
{sap.ui.core.int}transitionInterval? This is the amount of time in seconds a notification is displayed before the next notification is displayed. The default value is 10.
{sap.ui.core.int}refreshInterval? This is the amount of time in seconds before calling the backend to update the notifications. The default value is 300.
{sap.ui.core.URI}notificationsTargetUrl When a user clicks on the component, a new browser tab will open at this URL.
Deprecated:
Since version 1.26.0. There is no replacement for this control. The Fiori Launchpad now provides its own implementation for this control. This control was never meant to be used directly by third parties.
Method Detail
sap.collaboration.components.fiori.notification.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.collaboration.components.fiori.notification.Component with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in Object.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.collaboration.components.fiori.notification.Component.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.collaboration.components.fiori.notification.Component.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getNotificationsTargetUrl(): sap.ui.core.URI
Gets current value of property notificationsTargetUrl.
Returns:
{sap.ui.core.URI} Value of property notificationsTargetUrl
getNumberOfNotifications(): int
Gets current value of property numberOfNotifications.

Default value is 10.

Returns:
{int} Value of property numberOfNotifications
getODataServiceUrl(): sap.ui.core.URI
Gets current value of property oDataServiceUrl.

Default value is /sap/opu/odata/sap/SM_INTEGRATION_SRV.

Returns:
{sap.ui.core.URI} Value of property oDataServiceUrl
getRefreshInterval(): int
Gets current value of property refreshInterval.

Default value is 300.

Returns:
{int} Value of property refreshInterval
getTransitionInterval(): int
Gets current value of property transitionInterval.

Default value is 10.

Returns:
{int} Value of property transitionInterval
setNotificationsTargetUrl(sNotificationsTargetUrl): sap.collaboration.components.fiori.notification.Component
Sets a new value for property notificationsTargetUrl.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{sap.ui.core.URI}sNotificationsTargetUrl New value for property notificationsTargetUrl
Returns:
{sap.collaboration.components.fiori.notification.Component} Reference to this in order to allow method chaining
setNumberOfNotifications(iNumberOfNotifications): sap.collaboration.components.fiori.notification.Component
Sets a new value for property numberOfNotifications.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 10.

Parameters:
{int}iNumberOfNotifications New value for property numberOfNotifications
Returns:
{sap.collaboration.components.fiori.notification.Component} Reference to this in order to allow method chaining
setODataServiceUrl(sODataServiceUrl): sap.collaboration.components.fiori.notification.Component
Sets a new value for property oDataServiceUrl.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is /sap/opu/odata/sap/SM_INTEGRATION_SRV.

Parameters:
{sap.ui.core.URI}sODataServiceUrl New value for property oDataServiceUrl
Returns:
{sap.collaboration.components.fiori.notification.Component} Reference to this in order to allow method chaining
setRefreshInterval(iRefreshInterval): sap.collaboration.components.fiori.notification.Component
Sets a new value for property refreshInterval.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 300.

Parameters:
{int}iRefreshInterval New value for property refreshInterval
Returns:
{sap.collaboration.components.fiori.notification.Component} Reference to this in order to allow method chaining
setTransitionInterval(iTransitionInterval): sap.collaboration.components.fiori.notification.Component
Sets a new value for property transitionInterval.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 10.

Parameters:
{int}iTransitionInterval New value for property transitionInterval
Returns:
{sap.collaboration.components.fiori.notification.Component} Reference to this in order to allow method chaining