namespace sap.ui.fl.write.api.AppVariantWriteAPI

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

Provides an API for tools to create, update, delete app variants.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.fl.write.api.AppVariantWriteAPI.assignCatalogs

Assigns the same catalogs to app variant as of reference application

sap.ui.fl.write.api.AppVariantWriteAPI.deleteAppVariant

Deletes the app variant from the backend

sap.ui.fl.write.api.AppVariantWriteAPI.getManifest

Gets the manifest of an app(variant) from backend

sap.ui.fl.write.api.AppVariantWriteAPI.listAllAppVariants

Lists all the app variants based on the reference application

sap.ui.fl.write.api.AppVariantWriteAPI.saveAs

Saves the app variant to backend.

sap.ui.fl.write.api.AppVariantWriteAPI.unassignCatalogs

Assigns the same catalogs to app varriant as of reference application

sap.ui.fl.write.api.AppVariantWriteAPI.assignCatalogs

Assigns the same catalogs to app variant as of reference application

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

layer sap.ui.fl.Layer

Connectors are now determined based on the layer

assignFromAppId string

Reference application ID

action string

Action name e.g. assignCatalogs

sap.ui.fl.write.api.AppVariantWriteAPI.deleteAppVariant

Deletes the app variant from the backend

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

layer sap.ui.fl.Layer

Connectors are now determined based on the layer - Smart Business must pass the layer

sap.ui.fl.write.api.AppVariantWriteAPI.getManifest

Gets the manifest of an app(variant) from backend

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

layer sap.ui.fl.Layer

Connectors are now determined based on the layer

appVarUrl sap.ui.fl.Layer

Contains full url of app variant manifest

sap.ui.fl.write.api.AppVariantWriteAPI.listAllAppVariants

Lists all the app variants based on the reference application

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

layer sap.ui.fl.Layer

Connectors are now determined based on the layer

sap.ui.fl.write.api.AppVariantWriteAPI.saveAs

Saves the app variant to backend.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

id string

App variant ID

layer sap.ui.fl.Layer

Current working layer

sap.ui.fl.write.api.AppVariantWriteAPI.unassignCatalogs

Assigns the same catalogs to app varriant as of reference application

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

layer sap.ui.fl.Layer

Connectors are now determined based on the layer

action string

Action name e.g. unassignCatalogs