namespace sap.ui.fl.write.api.ChangesWriteAPI

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

Provides an API for tools like sap.ui.rta to create, apply and revert sap.ui.fl.Change.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.fl.write.api.ChangesWriteAPI.apply

Applies a specific change on the passed control if it is not already applied.

sap.ui.fl.write.api.ChangesWriteAPI.create

Creates a change on the flex persistence.

sap.ui.fl.write.api.ChangesWriteAPI.revert

Reverting a specific change on the passed control if it has already been applied or is in the process of being applied.

sap.ui.fl.write.api.ChangesWriteAPI.apply

Applies a specific change on the passed control if it is not already applied.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

change sap.ui.fl.Change

Change object that should be applied to the passed control

element sap.ui.core.Element

Element instance to which the change should be applied

modifier sap.ui.core.util.reflection.BaseTreeModifier

Modifier used to apply the change; if not provided, sap.ui.core.util.reflection.JsControlTreeModifier is used

appDescriptor object

App descriptor containing the metadata of the current application

sap.ui.fl.write.api.ChangesWriteAPI.create

Creates a change on the flex persistence.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

changeSpecificData object

Property bag holding the change information, see sap.ui.fl.Change#createInitialFileContent The property mPropertyBag.changeSpecificData.packageName is set to $TMP and internally since flex changes are always local when they are created.

selector sap.ui.fl.Selector

Managed object or selector object

sap.ui.fl.write.api.ChangesWriteAPI.revert

Reverting a specific change on the passed control if it has already been applied or is in the process of being applied.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

change sap.ui.fl.Change

Change object that should be reverted from the passed element

element sap.ui.core.Element

Element instance on which the change should be reverted