namespace sap.ui.fl.write.api.ControlPersonalizationWriteAPI

Visiblity: restricted
Available since: N/A
Module: sap/ui/fl/write/api/ControlPersonalizationWriteAPI
Application Component: CA-UI5-FL

Provides an API for controls to implement personalization.


Nodes Overview

Node Description
sap.ui.fl.write.api.ControlPersonalizationWriteAPI.PersonalizationChange

Object containing attributes of a change, along with the control to which this change should be applied.


Methods Overview

Method Description
sap.ui.fl.write.api.ControlPersonalizationWriteAPI.add

Creates personalization changes, adds them to the flex persistence (not yet saved) and applies them to the control.

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.buildSelectorFromElementIdAndType

Builds the sap.ui.fl.Selector for an element that is not yet available.

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.reset

Deletes changes recorded for the provided selectors. Changes to be deleted can be filtered by specification of change type(s).

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.restore

Reset dirty changes for a given control. This function also triggers a reversion of deleted UI changes.

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.save

Saves unsaved changes to the backend service.

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.add

Creates personalization changes, adds them to the flex persistence (not yet saved) and applies them to the control.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

changes sap.ui.fl.write.api.ControlPersonalizationWriteAPI.PersonalizationChange[]

Array of control changes of type sap.ui.fl.write.api.ControlPersonalizationWriteAPI.PersonalizationChange

ignoreVariantManagement boolean false

If flag is set to true, the changes will not belong to any variant, otherwise it will be detected if the changes are done in the context of variant mangement

useStaticArea boolean false

If flag is set to true then the static area is used to determine the variant management control

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.buildSelectorFromElementIdAndType

Builds the sap.ui.fl.Selector for an element that is not yet available.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

element sap.ui.core.Element

Element instance to retrieve the app component

elementId string

ID of the selector

elementType string

Type of the selector

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.reset

Deletes changes recorded for the provided selectors. Changes to be deleted can be filtered by specification of change type(s).

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selectors sap.ui.fl.Selector[]

Array of selectors, at least one selector is necessary

changeTypes String[]

Types of changes to be deleted

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.restore

Reset dirty changes for a given control. This function also triggers a reversion of deleted UI changes.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.core.Control

Retrieves the associated flex persistence

generator string

Generator of changes

changeTypes string[]

Types of changes

sap.ui.fl.write.api.ControlPersonalizationWriteAPI.save

Saves unsaved changes to the backend service.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

changes String[]

Array of changes to be saved; if not provided, all unsaved changes will be saved