@sap/open.fe 1.94.0

package/packages/sap.fe.core/test/sap/fe/core/designtime/api.json

@@ -0,0 +1 @@
+{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.94.0","library":"sap.fe.core","symbols":[{"kind":"namespace","name":"sap.fe","basename":"fe","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","static":true,"visibility":"public","description":"Root namespace for all the libraries related to SAP Fiori elements."},{"kind":"namespace","name":"sap.fe.core","basename":"core","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"","static":true,"visibility":"public","description":"Library providing the core functionality of the runtime for SAP Fiori elements for OData V4."},{"kind":"class","name":"sap.fe.core.AppComponent","basename":"AppComponent","resource":"sap/fe/core/AppComponent.js","module":"sap/fe/core/AppComponent","export":"","static":true,"visibility":"public","extends":"sap.ui.core.UIComponent","implements":["sap.ui.core.IAsyncContentCreation"],"description":"Main class for components used for an application in SAP Fiori elements.\n\nApplication developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.\n\nWhen you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>","ui5-metadata":{"stereotype":"component","designtime":"sap/fe/core/designtime/AppComponent.designtime"},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.core.AppComponent with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}."},{"name":"getAppStateHandler","visibility":"restricted","returnValue":{"type":"oObject","description":"A reference to the AppStateHandler"},"description":"Get a reference to the AppStateHandler."},{"name":"getRootContainer","visibility":"restricted","returnValue":{"type":"oObject","description":"A reference to NavContainer control or the FCL control"},"description":"Get the NavContainer control or the FCL control."},{"name":"getRootViewController","visibility":"restricted","returnValue":{"type":"oObject","description":"A reference to the FCL Controller"},"description":"Get a reference to the nav/FCL Controller."},{"name":"getRouterProxy","visibility":"restricted","returnValue":{"type":"oObject","description":"A Reference to the RouterProxy"},"description":"Get a reference to the RouterProxy."}]},{"kind":"class","name":"sap.fe.core.BaseController","basename":"BaseController","resource":"sap/fe/core/BaseController.js","module":"sap/fe/core/BaseController","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.Controller","description":"Internal base controller class for SAP Fiori elements application.\n\nIf you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.core.BaseController with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.core.mvc.Controller.extend}."},{"name":"getAppComponent","visibility":"public","since":"1.91.0","returnValue":{"type":"sap.fe.core.AppComponent","description":"The app component or, if not found, null"},"description":"Returns the current app component."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.core.BaseController."}]},{"kind":"namespace","name":"sap.fe.core.controllerextensions","basename":"controllerextensions","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"controllerextensions","static":true,"visibility":"public","description":"Collection of controller extensions used internally in SAP Fiori elements exposing a method that you can override to allow more flexibility."},{"kind":"class","name":"sap.fe.core.controllerextensions.EditFlow","basename":"EditFlow","resource":"sap/fe/core/controllerextensions/EditFlow.js","module":"sap/fe/core/controllerextensions/EditFlow","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"A controller extension offering hooks into the edit flow of the application","experimental":{"since":"1.90.0"},"ui5-metadata":{"stereotype":"object"},"methods":[{"name":"applyDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once the changes have been saved"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the document"}],"description":"Submit the current set of changes and navigate back.","experimental":{"since":"1.90.0"}},{"name":"cancelDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once editable document has been discarded"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the editable document"},{"name":"mParameters","type":"Object<string,any>","optional":true,"parameterProperties":{"control":{"name":"control","type":"object","optional":false,"description":"This is the control used to open the Discard popover. It is mandatory."}},"description":"Can contain the following attributes:"}],"description":"Discard the editable document.","experimental":{"since":"1.90.0"}},{"name":"createDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once the object has been created"},"parameters":[{"name":"vListBinding","type":"sap.ui.model.odata.v4.ODataListBinding|string","optional":false,"description":"ODataListBinding object or the binding path for a temporary list binding"}],"description":"Creates a new document.","experimental":{"since":"1.90.0"}},{"name":"deleteDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once document has been deleted"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the document"},{"name":"mParameters","type":"Object<string,any>","optional":true,"parameterProperties":{"title":{"name":"title","type":"string","optional":false,"description":"Title of the object being deleted"},"description":{"name":"description","type":"string","optional":false,"description":"Description of the object being deleted"}},"description":"Optional, can contain the following attributes:"}],"description":"Deletes the document.","experimental":{"since":"1.90.0"}},{"name":"editDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once the editable document is available"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the active document"}],"description":"Creates a draft document for an existing active document.","experimental":{"since":"1.90.0"}},{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.core.controllerextensions.EditFlow with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.core.controllerextensions.EditFlow."},{"name":"invokeAction","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise"},"parameters":[{"name":"sActionName","type":"string","optional":false,"description":"The name of the action to be called"},{"name":"mParameters","type":"Object<string,any>","optional":true,"parameterProperties":{"contexts":{"name":"contexts","type":"sap.ui.model.odata.v4.Context","optional":true,"description":"For a bound action, a context or an array with contexts for which the action shall be called must be provided"},"model":{"name":"model","type":"sap.ui.model.odata.v4.ODataModel","optional":true,"description":"For an unbound action, an instance of an OData V4 model must be provided"},"requiresNavigation":{"name":"requiresNavigation","type":"boolean","optional":true,"description":"Boolean value indicating whether navigation is required after the action has been executed. Navigation takes place to the context returned by the action."},"label":{"name":"label","type":"string","optional":true,"description":"A human-readable label for the action. This is needed in case the action has a parameter and a parameter dialog is shown to the user."}},"description":"Contains the following attributes:"}],"description":"Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and show the updated data upon navigation.","experimental":{"since":"1.90.0"}},{"name":"onBeforeSave","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"A promise to be returned by the overridden method. If resolved, the save action is triggered. If rejected, the save action is not triggered and the user stays in edit mode."},"description":"This function can be used to intercept the save action. You can execute custom coding in this function. The framework waits for the returned promise to be resolved before continuing the save action. If you reject the promise the save action is stopped and the user stays in edit mode.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.","experimental":{"since":"1.90.0"}},{"name":"saveDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once save is complete"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the editable document"}],"description":"Saves a new document after checking it.","experimental":{"since":"1.90.0"}},{"name":"securedExecution","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"A promise that is rejected if the execution is prohibited and resolved by the promise returned by the fnFunction."},"parameters":[{"name":"fnFunction","type":"function","optional":false,"description":"The function to be executed. Should return a promise that is settled after completion of the execution. If nothing is returned, immediate completion is assumed."},{"name":"mParameters","type":"Object<string,any>","optional":true,"parameterProperties":{"busy":{"name":"busy","type":"object","optional":true,"parameterProperties":{"set":{"name":"set","type":"boolean","optional":true,"defaultValue":true,"description":"Triggers a busy indicator when the function is executed."},"check":{"name":"check","type":"boolean","optional":true,"defaultValue":true,"description":"Executes function only if application isn't busy."}},"description":"Defines the busy indicator"},"updatesDocument":{"name":"updatesDocument","type":"boolean","optional":true,"description":"This operation updates the current document without using the bound model and context. As a result, the draft status is updated if a draft document exists, and the user has to confirm the cancellation of the editing process."}},"description":"Definitions of the preconditions to be checked before execution"}],"description":"Secured execution of the given function. Ensures that the function is only executed when certain conditions are fulfilled.","experimental":{"since":"1.90.0"}},{"name":"syncTask","module":"sap/fe/core/controllerextensions/InternalEditFlow","visibility":"restricted","returnValue":{"type":"Promise","description":"Promise resolves once the task is completed"},"parameters":[{"name":"vTask","type":"Promise|function","optional":true,"description":"Optional, a promise or function to be executed synchronously"}],"description":"Performs a task in sync with other tasks created via this function. Returns the promise chain of the task.","resource":"sap/fe/core/controllerextensions/InternalEditFlow.js"},{"name":"updateDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"Promise resolves once draft status has been updated"},"parameters":[{"name":"oContext","type":"object","optional":false,"description":"Context of the updated field"},{"name":"oPromise","type":"object","optional":false,"description":"Promise to determine when the update operation is completed. The promise should be resolved when the update operation is completed, so the draft status can be updated."}],"description":"Updates the draft status and displays the error messages if there are errors during an update.","experimental":{"since":"1.90.0"}}]},{"kind":"class","name":"sap.fe.core.controllerextensions.IntentBasedNavigation","basename":"IntentBasedNavigation","resource":"sap/fe/core/controllerextensions/IntentBasedNavigation.js","module":"sap/fe/core/controllerextensions/IntentBasedNavigation","export":"","static":true,"visibility":"public","since":"1.86.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"Controller extension providing hooks for intent-based navigation","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptNavigationContext","visibility":"public","since":"1.86.0","parameters":[{"name":"oSelectionVariant","type":"sap.fe.navigation.SelectionVariant","optional":false,"description":"SelectionVariant provided by SAP Fiori elements."},{"name":"oNavigationInfo","type":"object","optional":false,"parameterProperties":{"semanticObject":{"name":"semanticObject","type":"string","optional":false,"description":"Semantic object related to the intent"},"action":{"name":"action","type":"string","optional":false,"description":"Action related to the intent"}},"description":"Object containing intent-based navigation-related info"}],"description":"Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation."}]},{"kind":"class","name":"sap.fe.core.controllerextensions.MessageHandler","basename":"MessageHandler","resource":"sap/fe/core/controllerextensions/MessageHandler.js","module":"sap/fe/core/controllerextensions/MessageHandler","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"A controller extension offering message handling.","experimental":{"since":"1.90.0"},"ui5-metadata":{"stereotype":"object"},"methods":[{"name":"showMessageDialog","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"A promise that is resolved once the user closes the dialog. If there are no messages to be shown, the promise is resolved immediately"},"description":"Shows a message dialog with transition messages if there are any. The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages are removed from the message model. If there is more than one message, a list of messages is shown. The user can filter on message types and can display details as well as the long text. If there is one message, the dialog immediately shows the details of the message. If there is just one success message, a message toast is shown instead.","experimental":{"since":"1.90.0"}}]},{"kind":"class","name":"sap.fe.core.controllerextensions.Routing","basename":"Routing","resource":"sap/fe/core/controllerextensions/Routing.js","module":"sap/fe/core/controllerextensions/Routing","export":"","static":true,"visibility":"public","since":"1.86.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"A controller extension offering hooks into the routing flow of the application","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"navigate","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","type":"sap.ui.model.odata.v4.Context","optional":false,"description":"Object containing the context to be navigated"}],"description":"Allows navigation to a specific context."},{"name":"onAfterBinding","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","type":"object","optional":false,"description":"Object containing the context to be navigated"}],"description":"This function is used to intercept the routing event after binding a page.\n\nIf it is declared as an extension, it allows you to intercept and change the normal flow of binding.\n\nThis function is not called directly, but overridden separately by consuming controllers. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"onBeforeBinding","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","type":"object","optional":false,"description":"Object containing the context for the navigation"}],"description":"This function is used to intercept the routing event before binding a page.\n\nIf it is declared as an extension, it allows you to intercept and change the normal flow of binding.\n\nThis function is not called directly, but overridden separately by consuming controllers. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"onBeforeNavigation","visibility":"public","since":"1.86.0","returnValue":{"type":"boolean","description":"`true` to prevent the default execution, false to keep the standard behavior"},"parameters":[{"name":"mNavigationParameters","type":"object","optional":false,"parameterProperties":{"bindingContext":{"name":"bindingContext","type":"sap.ui.model.odata.v4.Context","optional":false,"description":"The currently selected context"}},"description":"Object containing row context and page context"}],"description":"This function can be used to intercept the routing event happening during the normal process of navigating from one page to another.\n\nIf declared as an extension, it allows you to intercept and change the normal navigation flow. If you decide to do your own navigation processing, you can return `true` to prevent the default routing behavior.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."}]},{"kind":"class","name":"sap.fe.core.controllerextensions.Share","basename":"Share","resource":"sap/fe/core/controllerextensions/Share.js","module":"sap/fe/core/controllerextensions/Share","export":"","static":true,"visibility":"public","since":"1.93.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"A controller extension offering hooks into the Share functionalities of the application","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptShareMetadata","visibility":"public","since":"1.93.0","returnValue":{"type":"object|Promise<object>","description":"Share Metadata or a Promise resolving the Share Metadata"},"parameters":[{"name":"oShareMetadata","type":"object","optional":false,"parameterProperties":{"url":{"name":"url","type":"string","optional":false,"description":"Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'"},"title":{"name":"title","type":"string","optional":false,"description":"Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam' and 'title' in 'Save as Tile'"},"email":{"name":"email","type":"object","optional":true,"parameterProperties":{"url":{"name":"url","type":"string","optional":false,"description":"URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url."},"title":{"name":"title","type":"string","optional":false,"description":"Title that will be used as \"email subject\" in 'Send Email'. This takes precedence over oShareMetadata.title."}},"description":"Email-specific metadata."},"jam":{"name":"jam","type":"object","optional":true,"parameterProperties":{"url":{"name":"url","type":"string","optional":false,"description":"URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url."},"title":{"name":"title","type":"string","optional":false,"description":"Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title."}},"description":"SAP Jam-specific metadata."},"tile":{"name":"tile","type":"object","optional":true,"parameterProperties":{"url":{"name":"url","type":"string","optional":false,"description":"URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url."},"title":{"name":"title","type":"string","optional":false,"description":"Title to be used for the tile. This takes precedence over oShareMetadata.title."},"subtitle":{"name":"subtitle","type":"string","optional":false,"description":"Subtitle to be used for the tile."},"icon":{"name":"icon","type":"string","optional":false,"description":"Icon to be used for the tile."},"queryUrl":{"name":"queryUrl","type":"string","optional":false,"description":"Query URL of an OData service from which data for a dynamic tile is read."}},"description":"Save as Tile-specific metadata."}},"description":"Object containing the share metadata."}],"description":"Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'."},{"name":"openShareSheet","visibility":"public","since":"1.93.0","parameters":[{"name":"oControl","type":"object","optional":false,"description":"The control to which the ActionSheet is opened."}],"description":"Opens the share sheet."}]},{"kind":"class","name":"sap.fe.core.controllerextensions.ViewState","basename":"ViewState","resource":"sap/fe/core/controllerextensions/ViewState.js","module":"sap/fe/core/controllerextensions/ViewState","export":"","static":true,"visibility":"public","since":"1.85.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"A controller extension offering hooks for state handling\n\nIf you need to maintain a specific state for your application, you can use the controller extension.","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptControlStateHandler","visibility":"protected","parameters":[{"name":"oControl","type":"sap.ui.base.ManagedObject","optional":false,"description":"The control to get state handler for"},{"name":"aControlHandler","type":"object[]","optional":false,"description":"A list of plain objects with two functions: <code>retrieve</code> and <code>apply</code>"}],"description":"Customize the <code>retrieve</code> and <code>apply</code> functions for a certain control.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"adaptStateControls","visibility":"protected","parameters":[{"name":"aCollectedControls","type":"sap.ui.base.ManagedObject[]","optional":false,"description":"The collected controls"}],"description":"This function should add all controls for given view that should be considered for the state handling to the provided control array.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"applyAdditionalStates","visibility":"protected","parameters":[{"name":"oViewState","type":"object","optional":false,"description":"The current view state"},{"name":"aPromises","type":"Promise","optional":false,"description":"Extensible array of promises to be resolved before continuing"}],"description":"Applying additional, not control related, states - is called only if navigation type is iAppState.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"applyInitialStateOnly","visibility":"protected","returnValue":{"type":"boolean","description":"If <code>true</code>, only the initial view state is applied once, else any new view state is also applied on follow-up calls (default)"},"description":"Defines whether the view state should only be applied once initially.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.\n\nImportant: You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!"},{"name":"applyNavigationParameters","visibility":"protected","parameters":[{"name":"oNavParameter","type":"object","optional":false,"parameterProperties":{"navigationType":{"name":"navigationType","type":"sap.fe.navigation.NavType","optional":false,"description":"The actual navigation type"},"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"The selectionVariant from the navigation"},"selectionVariantDefaults":{"name":"selectionVariantDefaults","type":"object","optional":true,"description":"The selectionVariant defaults from the navigation"},"requiresStandardVariant":{"name":"requiresStandardVariant","type":"boolean","optional":true,"description":"Defines whether standard variant must be used in VM"}},"description":"The current navigation parameter"},{"name":"aPromises","type":"Promise","optional":false,"description":"Extensible array of promises to be resolved before continuing"}],"description":"Apply navigation parameters - is called only if navigation type is not iAppState.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"applyViewState","visibility":"public","returnValue":{"type":"Promise","description":"Promise for async state handling"},"parameters":[{"name":"oViewState","type":"object","optional":false,"description":"The view state to apply (can be undefined)"},{"name":"oNavParameter","type":"object","optional":false,"parameterProperties":{"navigationType":{"name":"navigationType","type":"sap.fe.navigation.NavType","optional":false,"description":"The actual navigation type"},"selectionVariant":{"name":"selectionVariant","type":"object","optional":true,"description":"The selectionVariant from the navigation"},"selectionVariantDefaults":{"name":"selectionVariantDefaults","type":"object","optional":true,"description":"The selectionVariant defaults from the navigation"},"requiresStandardVariant":{"name":"requiresStandardVariant","type":"boolean","optional":true,"description":"Defines whether standard variant must be used in VM"}},"description":"The current navigation parameter"}],"description":"Applies the given view state to this extensions view."},{"name":"onAfterStateApplied","visibility":"protected","parameters":[{"name":"aPromises","type":"Promise","optional":false,"description":"Extensible array of promises to be resolved before continuing"}],"description":"Hook to react when state for given view was applied.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"onBeforeStateApplied","visibility":"protected","parameters":[{"name":"aPromises","type":"Promise","optional":false,"description":"Extensible array of promises to be resolved before continuing"}],"description":"Hook to react before a state for given view is applied.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"retrieveAdditionalStates","visibility":"protected","parameters":[{"name":"mAdditionalStates","type":"object","optional":false,"description":"The additional state"}],"description":"Extend the map of additional states (not control bound) to be added to the current view state of the given view.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}."},{"name":"retrieveViewState","visibility":"public","returnValue":{"type":"Promise","description":"A promise resolving the view state"},"description":"Retrieve the view state of this extensions view. When this function is called more than once before finishing, all but the final response will resolve to <code>undefined</code>."}]},{"kind":"class","name":"sap.fe.core.ExtensionAPI","basename":"ExtensionAPI","resource":"sap/fe/core/ExtensionAPI.js","module":"sap/fe/core/ExtensionAPI","export":"","static":true,"visibility":"public","since":"1.79.0","extends":"sap.ui.base.Object","description":"Common Extension API for all pages of SAP Fiori elements for OData V4.","ui5-metadata":{"stereotype":"object","associations":[{"name":"editFlow","singularName":"editFlow","type":"sap.fe.core.controllerextensions.EditFlow","cardinality":"0..1","visibility":"public","description":"A controller extension offering hooks into the edit flow of the application.","methods":["getEditFlow","setEditFlow"]},{"name":"routing","singularName":"routing","type":"sap.fe.core.controllerextensions.Routing","cardinality":"0..1","visibility":"public","description":"A controller extension offering hooks into the routing flow of the application.","methods":["getRouting","setRouting"]}]},"methods":[{"name":"addDependent","visibility":"public","parameters":[{"name":"oControl","type":"sap.ui.core.Control","optional":false,"description":"Control to be added as a dependent control"}],"description":"Add any control as a dependent control to this SAP Fiori elements page."},{"name":"getEditFlow","visibility":"public","returnValue":{"type":"sap.ui.core.ID"},"description":"ID of the element which is the current target of the association {@link #getEditFlow editFlow}, or <code>null</code>."},{"name":"getModel","visibility":"public","returnValue":{"type":"sap.ui.model.Model","description":"The required model"},"parameters":[{"name":"sModelName","type":"string","optional":false,"description":"Name of the model"}],"description":"Get access to models managed by SAP Fiori elements.<br> The following models can be accessed: <ul> <li>undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page</li> <li>i18n / further data models defined in the manifest</li> <li>ui: returns a SAPUI5 JSON model containing UI information. Only the following properties are public and supported: <ul> <li>editMode: contains either 'Editable' or 'Display'</li> </ul> </li> </ul>."},{"name":"getRouting","visibility":"public","returnValue":{"type":"sap.ui.core.ID"},"description":"ID of the element which is the current target of the association {@link #getRouting routing}, or <code>null</code>."},{"name":"loadFragment","visibility":"public","returnValue":{"type":"Promise<(Element[]|sap.ui.core.Element[])>","description":"The fragment definition"},"parameters":[{"name":"mSettings","type":"object","optional":false,"parameterProperties":{"id":{"name":"id","type":"string","optional":false,"description":"The ID of the fragment itself"},"name":{"name":"name","type":"string","optional":false,"description":"The name of the fragment to be loaded"},"controller":{"name":"controller","type":"object","optional":false,"description":"The controller to be attached to the fragment"},"contextPath":{"name":"contextPath","type":"string","optional":false,"description":"The contextPath to be used for the templating process"},"initialBindingContext":{"name":"initialBindingContext","type":"sap.ui.model.Context","optional":false,"description":"The initial binding context"}},"description":"The settings object"}],"description":"Load a fragment and go through the template preprocessor with the current page context."},{"name":"navigateToTarget","visibility":"public","parameters":[{"name":"sTarget","type":"string","optional":false,"description":"Name of the target route"},{"name":"oContext","type":"sap.ui.model.Context","optional":true,"description":"Context instance"}],"description":"Navigate to another target."},{"name":"removeDependent","visibility":"public","parameters":[{"name":"oControl","type":"sap.ui.core.Control","optional":false,"description":"Control to be added as a dependent control"}],"description":"Remove a dependent control from this SAP Fiori elements page."},{"name":"setEditFlow","visibility":"public","returnValue":{"type":"this","description":"Reference to <code>this</code> in order to allow method chaining"},"parameters":[{"name":"oEditFlow","type":"sap.ui.core.ID|sap.fe.core.controllerextensions.EditFlow","optional":false,"description":"ID of an element which becomes the new target of this editFlow association; alternatively, an element instance may be given"}],"description":"Sets the associated {@link #getEditFlow editFlow}."},{"name":"setRouting","visibility":"public","returnValue":{"type":"this","description":"Reference to <code>this</code> in order to allow method chaining"},"parameters":[{"name":"oRouting","type":"sap.ui.core.ID|sap.fe.core.controllerextensions.Routing","optional":false,"description":"ID of an element which becomes the new target of this routing association; alternatively, an element instance may be given"}],"description":"Sets the associated {@link #getRouting routing}."},{"name":"updateAppState","visibility":"public","returnValue":{"type":"Promise","description":"A promise that resolves with the new app state object."},"description":"Triggers an update of the app state. Should be called if the state of a control, or any other state-relevant information, was changed."}]},{"kind":"namespace","name":"sap.fe.core.ExtensionAPI.intentBasedNavigation","basename":"intentBasedNavigation","resource":"sap/fe/core/ExtensionAPI.js","module":"sap/fe/core/ExtensionAPI","export":"intentBasedNavigation","static":true,"visibility":"public","since":"1.86.0","description":"ExtensionAPI for intent-based navigation","methods":[{"name":"navigateOutbound","visibility":"public","parameters":[{"name":"sOutbound","type":"string","optional":false,"description":"Identifier to locate the outbound definition in the manifest. This provides the semantic object and action for the intent-based navigation. Additionally, the outbound definition can be used to provide parameters for intent-based navigation. See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries} for more information."},{"name":"mNavigationParameters","type":"object","optional":false,"description":"Optional map containing key/value pairs to be passed to the intent. If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest are ignored."}],"description":"Navigates to an intent defined by an outbound definition in the manifest."}]},{"kind":"namespace","name":"sap.fe.core.fpm","basename":"fpm","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"fpm","static":true,"visibility":"public","description":"Collection of classes provided by SAP Fiori elements for the Flexible Programming Model"},{"kind":"class","name":"sap.fe.core.fpm.Component","basename":"Component","resource":"sap/fe/core/fpm/Component.js","module":"sap/fe/core/fpm/Component","export":"","static":true,"visibility":"public","since":"1.92.0","extends":"sap.fe.core.TemplateComponent","description":"Component that can be used as a wrapper component for custom pages.\n\nThe component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:\n\n<pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n</pre>","experimental":{"since":"1.92.0"},"ui5-metadata":{"properties":[{"name":"viewName","type":"string","defaultValue":null,"group":"Misc","visibility":"public","description":"Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.","methods":["getViewName","setViewName"]}]},"methods":[{"name":"extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"Created class / constructor function"},"parameters":[{"name":"sClassName","type":"string","optional":false,"description":"Name of the class being created"},{"name":"oClassInfo","type":"object","optional":true,"description":"Object literal with information about the class"},{"name":"FNMetaImpl","type":"function","optional":true,"description":"Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class"}],"description":"Creates a new subclass of class sap.fe.core.fpm.Component with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.\n\n<code>oClassInfo</code> might contain the same kind of information as described in {@link sap.fe.core.TemplateComponent.extend}."},{"name":"getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"Metadata object describing this class"},"description":"Returns a metadata object for class sap.fe.core.fpm.Component."},{"name":"getViewName","visibility":"public","returnValue":{"type":"string","description":"Value of property <code>viewName</code>"},"description":"Gets current value of property {@link #getViewName viewName}.\n\nName of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions."},{"name":"setViewName","visibility":"public","returnValue":{"type":"this","description":"Reference to <code>this</code> in order to allow method chaining"},"parameters":[{"name":"sViewName","type":"string","optional":false,"description":"New value for property <code>viewName</code>"}],"description":"Sets a new value for property {@link #getViewName viewName}.\n\nName of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.\n\nWhen called with a value of <code>null</code> or <code>undefined</code>, the default value of the property will be restored."}]},{"kind":"enum","name":"sap.fe.core.InitialLoadMode","basename":"InitialLoadMode","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"InitialLoadMode","static":true,"visibility":"public","since":"1.86.0","description":"Possible initial load (first app startup) modes for a ListReport.","properties":[{"name":"Auto","visibility":"public","static":true,"type":"undefined","description":"Data will be loaded initially if filters are set."},{"name":"Disabled","visibility":"public","static":true,"type":"undefined","description":"Data will not be loaded initially."},{"name":"Enabled","visibility":"public","static":true,"type":"undefined","description":"Data will be loaded initially."}]},{"kind":"class","name":"sap.fe.core.PageController","basename":"PageController","resource":"sap/fe/core/PageController.js","module":"sap/fe/core/PageController","export":"","static":true,"visibility":"public","since":"1.88.0","extends":"sap.fe.core.BaseController","description":"Base controller class for your custom page used inside an SAP Fiori elements application.\n\nThis controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.","ui5-metadata":{"stereotype":"object"}}]}

package/packages/sap.fe.core/test/sap/fe/core/designtime/apiref/api.json

@@ -0,0 +1 @@
+{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.94.0","library":"sap.fe.core","symbols":[{"kind":"namespace","name":"sap.fe","basename":"fe","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","static":true,"visibility":"public","description":"<p><p>Root namespace for all the libraries related to SAP Fiori elements.</p></p>","displayName":"sap.fe","nodes":[{"name":"sap.fe.core","description":"<p>Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.</p>","href":"api/sap.fe.core"}],"title":"namespace sap.fe","subTitle":""},{"kind":"namespace","name":"sap.fe.core","basename":"core","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"","static":true,"visibility":"public","description":"<p><p>Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.</p></p>","displayName":"sap.fe.core","nodes":[{"name":"sap.fe.core.AppComponent","description":"<p>Main class for components used for an application in SAP Fiori elements.\n</p>","href":"api/sap.fe.core.AppComponent"},{"name":"sap.fe.core.BaseController","description":"<p>Internal base controller class for SAP Fiori elements application.\n</p>","href":"api/sap.fe.core.BaseController"},{"name":"sap.fe.core.controllerextensions","description":"<p>Collection of controller extensions used internally in SAP Fiori elements exposing a method that you can override to allow more flexibility.</p>","href":"api/sap.fe.core.controllerextensions"},{"name":"sap.fe.core.ExtensionAPI","description":"<p>Common Extension API for all pages of SAP Fiori elements for OData V4.</p>","href":"api/sap.fe.core.ExtensionAPI"},{"name":"sap.fe.core.fpm","description":"<p>Collection of classes provided by SAP Fiori elements for the Flexible Programming Model</p>","href":"api/sap.fe.core.fpm"},{"name":"sap.fe.core.InitialLoadMode","description":"<p>Possible initial load (first app startup) modes for a ListReport.</p>","href":"api/sap.fe.core.InitialLoadMode"},{"name":"sap.fe.core.PageController","description":"<p>Base controller class for your custom page used inside an SAP Fiori elements application.\n</p>","href":"api/sap.fe.core.PageController"}],"component":"CA-UI5-FE","title":"namespace sap.fe.core","subTitle":""},{"kind":"class","name":"sap.fe.core.AppComponent","basename":"AppComponent","resource":"sap/fe/core/AppComponent.js","module":"sap/fe/core/AppComponent","export":"","static":true,"visibility":"public","extends":"sap.ui.core.UIComponent","implements":["sap.ui.core.IAsyncContentCreation"],"description":"<p>Main class for components used for an application in SAP Fiori elements.</p><p>Application developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.</p><p>When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/></p>","ui5-metadata":{"stereotype":"component","designtime":"sap/fe/core/designtime/AppComponent.designtime"},"methods":[{"name":"sap.fe.core.AppComponent.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.core.AppComponent with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.core.UIComponent#methods/sap.ui.core.UIComponent.extend\">sap.ui.core.UIComponent.extend</a>.</p>","href":"api/sap.fe.core.AppComponent#methods/sap.fe.core.AppComponent.extend","code":"<pre class=\"prettyprint\">sap.fe.core.AppComponent.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"getAppStateHandler","visibility":"restricted","returnValue":{"type":"oObject","description":"<p>A reference to the AppStateHandler</p>","types":[{"value":"oObject","href":"api/oObject","linkEnabled":true}]},"description":"<p>Get a reference to the AppStateHandler.</p>","href":"api/sap.fe.core.AppComponent#methods/getAppStateHandler","code":"<pre class=\"prettyprint\">getAppStateHandler() : oObject</pre>"},{"name":"getRootContainer","visibility":"restricted","returnValue":{"type":"oObject","description":"<p>A reference to NavContainer control or the FCL control</p>","types":[{"value":"oObject","href":"api/oObject","linkEnabled":true}]},"description":"<p>Get the NavContainer control or the FCL control.</p>","href":"api/sap.fe.core.AppComponent#methods/getRootContainer","code":"<pre class=\"prettyprint\">getRootContainer() : oObject</pre>"},{"name":"getRootViewController","visibility":"restricted","returnValue":{"type":"oObject","description":"<p>A reference to the FCL Controller</p>","types":[{"value":"oObject","href":"api/oObject","linkEnabled":true}]},"description":"<p>Get a reference to the nav/FCL Controller.</p>","href":"api/sap.fe.core.AppComponent#methods/getRootViewController","code":"<pre class=\"prettyprint\">getRootViewController() : oObject</pre>"},{"name":"getRouterProxy","visibility":"restricted","returnValue":{"type":"oObject","description":"<p>A Reference to the RouterProxy</p>","types":[{"value":"oObject","href":"api/oObject","linkEnabled":true}]},"description":"<p>Get a reference to the RouterProxy.</p>","href":"api/sap.fe.core.AppComponent#methods/getRouterProxy","code":"<pre class=\"prettyprint\">getRouterProxy() : oObject</pre>"}],"displayName":"sap.fe.core.AppComponent","component":"CA-UI5-FE","title":"class sap.fe.core.AppComponent","subTitle":""},{"kind":"class","name":"sap.fe.core.BaseController","basename":"BaseController","resource":"sap/fe/core/BaseController.js","module":"sap/fe/core/BaseController","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.Controller","description":"<p>Internal base controller class for SAP Fiori elements application.</p><p>If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.</p>","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"sap.fe.core.BaseController.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.core.BaseController with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.core.mvc.Controller#methods/sap.ui.core.mvc.Controller.extend\">sap.ui.core.mvc.Controller.extend</a>.</p>","href":"api/sap.fe.core.BaseController#methods/sap.fe.core.BaseController.extend","code":"<pre class=\"prettyprint\">sap.fe.core.BaseController.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"getAppComponent","visibility":"public","since":"1.91.0","returnValue":{"type":"sap.fe.core.AppComponent","description":"<p>The app component or, if not found, null</p>","types":[{"value":"sap.fe.core.AppComponent","href":"api/sap.fe.core.AppComponent","linkEnabled":true}]},"description":"<p>Returns the current app component.</p>","href":"api/sap.fe.core.BaseController#methods/getAppComponent","code":"<pre class=\"prettyprint\">getAppComponent() : sap.fe.core.AppComponent</pre>"},{"name":"sap.fe.core.BaseController.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.core.BaseController.</p>","href":"api/sap.fe.core.BaseController#methods/sap.fe.core.BaseController.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.core.BaseController.getMetadata() : sap.ui.base.Metadata</pre>"}],"displayName":"sap.fe.core.BaseController","component":"CA-UI5-FE","title":"class sap.fe.core.BaseController","subTitle":""},{"kind":"namespace","name":"sap.fe.core.controllerextensions","basename":"controllerextensions","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"controllerextensions","static":true,"visibility":"public","description":"<p><p>Collection of controller extensions used internally in SAP Fiori elements exposing a method that you can override to allow more flexibility.</p></p>","displayName":"sap.fe.core.controllerextensions","nodes":[{"name":"sap.fe.core.controllerextensions.EditFlow","description":"<p>A controller extension offering hooks into the edit flow of the application</p>","href":"api/sap.fe.core.controllerextensions.EditFlow"},{"name":"sap.fe.core.controllerextensions.IntentBasedNavigation","description":"<p>Controller extension providing hooks for intent-based navigation</p>","href":"api/sap.fe.core.controllerextensions.IntentBasedNavigation"},{"name":"sap.fe.core.controllerextensions.MessageHandler","description":"<p>A controller extension offering message handling.</p>","href":"api/sap.fe.core.controllerextensions.MessageHandler"},{"name":"sap.fe.core.controllerextensions.Routing","description":"<p>A controller extension offering hooks into the routing flow of the application</p>","href":"api/sap.fe.core.controllerextensions.Routing"},{"name":"sap.fe.core.controllerextensions.Share","description":"<p>A controller extension offering hooks into the Share functionalities of the application</p>","href":"api/sap.fe.core.controllerextensions.Share"},{"name":"sap.fe.core.controllerextensions.ViewState","description":"<p>A controller extension offering hooks for state handling</p><p>If you need to maintain a specific state for your application, you can use the controller extension.</p>","href":"api/sap.fe.core.controllerextensions.ViewState"}],"component":"CA-UI5-FE","title":"namespace sap.fe.core.controllerextensions","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.EditFlow","basename":"EditFlow","resource":"sap/fe/core/controllerextensions/EditFlow.js","module":"sap/fe/core/controllerextensions/EditFlow","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>A controller extension offering hooks into the edit flow of the application</p>","experimental":{"since":"1.90.0"},"ui5-metadata":{"stereotype":"object"},"methods":[{"name":"applyDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once the changes have been saved</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the document</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Submit the current set of changes and navigate back.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/applyDocument","code":"<pre class=\"prettyprint\">applyDocument(oContext) : Promise</pre>"},{"name":"cancelDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once editable document has been discarded</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the editable document</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"mParameters","optional":true,"description":"<p>Can contain the following attributes:</p>","types":[{"value":"Object<string,any>"}],"defaultValue":""},{"name":"control","optional":false,"description":"<p>This is the control used to open the Discard popover. It is mandatory.</p>","depth":1,"types":[{"value":"object"}],"phoneName":"mParameters.control","defaultValue":""}],"description":"<p>Discard the editable document.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/cancelDocument","code":"<pre class=\"prettyprint\">cancelDocument(oContext, mParameters?) : Promise</pre>"},{"name":"createDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once the object has been created</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"vListBinding","optional":false,"description":"<p>ODataListBinding object or the binding path for a temporary list binding</p>","types":[{"value":"sap.ui.model.odata.v4.ODataListBinding"},{"value":"string"}],"defaultValue":""}],"description":"<p>Creates a new document.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/createDocument","code":"<pre class=\"prettyprint\">createDocument(vListBinding) : Promise</pre>"},{"name":"deleteDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once document has been deleted</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the document</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"mParameters","optional":true,"description":"<p>Optional, can contain the following attributes:</p>","types":[{"value":"Object<string,any>"}],"defaultValue":""},{"name":"title","optional":false,"description":"<p>Title of the object being deleted</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mParameters.title","defaultValue":""},{"name":"description","optional":false,"description":"<p>Description of the object being deleted</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mParameters.description","defaultValue":""}],"description":"<p>Deletes the document.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/deleteDocument","code":"<pre class=\"prettyprint\">deleteDocument(oContext, mParameters?) : Promise</pre>"},{"name":"editDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once the editable document is available</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the active document</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Creates a draft document for an existing active document.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/editDocument","code":"<pre class=\"prettyprint\">editDocument(oContext) : Promise</pre>"},{"name":"sap.fe.core.controllerextensions.EditFlow.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.core.controllerextensions.EditFlow with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.ui.core.mvc.ControllerExtension#methods/sap.ui.core.mvc.ControllerExtension.extend\">sap.ui.core.mvc.ControllerExtension.extend</a>.</p>","href":"api/sap.fe.core.controllerextensions.EditFlow#methods/sap.fe.core.controllerextensions.EditFlow.extend","code":"<pre class=\"prettyprint\">sap.fe.core.controllerextensions.EditFlow.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"sap.fe.core.controllerextensions.EditFlow.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.core.controllerextensions.EditFlow.</p>","href":"api/sap.fe.core.controllerextensions.EditFlow#methods/sap.fe.core.controllerextensions.EditFlow.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.core.controllerextensions.EditFlow.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"invokeAction","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","types":[{"value":"Promise"}],"description":""},"parameters":[{"name":"sActionName","optional":false,"description":"<p>The name of the action to be called</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mParameters","optional":true,"description":"<p>Contains the following attributes:</p>","types":[{"value":"Object<string,any>"}],"defaultValue":""},{"name":"contexts","optional":true,"description":"<p>For a bound action, a context or an array with contexts for which the action shall be called must be provided</p>","depth":1,"types":[{"value":"sap.ui.model.odata.v4.Context"}],"phoneName":"mParameters.contexts","defaultValue":""},{"name":"model","optional":true,"description":"<p>For an unbound action, an instance of an OData V4 model must be provided</p>","depth":1,"types":[{"value":"sap.ui.model.odata.v4.ODataModel"}],"phoneName":"mParameters.model","defaultValue":""},{"name":"requiresNavigation","optional":true,"description":"<p>Boolean value indicating whether navigation is required after the action has been executed. Navigation takes place to the context returned by the action.</p>","depth":1,"types":[{"value":"boolean"}],"phoneName":"mParameters.requiresNavigation","defaultValue":""},{"name":"label","optional":true,"description":"<p>A human-readable label for the action. This is needed in case the action has a parameter and a parameter dialog is shown to the user.</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mParameters.label","defaultValue":""}],"description":"<p>Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and show the updated data upon navigation.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/invokeAction","code":"<pre class=\"prettyprint\">invokeAction(sActionName, mParameters?) : Promise</pre>"},{"name":"onBeforeSave","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>A promise to be returned by the overridden method. If resolved, the save action is triggered. If rejected, the save action is not triggered and the user stays in edit mode.</p>","types":[{"value":"Promise"}]},"description":"<p>This function can be used to intercept the save action. You can execute custom coding in this function. The framework waits for the returned promise to be resolved before continuing the save action. If you reject the promise the save action is stopped and the user stays in edit mode.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.Instead</a>.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/onBeforeSave","code":"<pre class=\"prettyprint\">onBeforeSave() : Promise</pre>"},{"name":"saveDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once save is complete</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the editable document</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Saves a new document after checking it.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/saveDocument","code":"<pre class=\"prettyprint\">saveDocument(oContext) : Promise</pre>"},{"name":"securedExecution","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>A promise that is rejected if the execution is prohibited and resolved by the promise returned by the fnFunction.</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"fnFunction","optional":false,"description":"<p>The function to be executed. Should return a promise that is settled after completion of the execution. If nothing is returned, immediate completion is assumed.</p>","types":[{"value":"function"}],"defaultValue":""},{"name":"mParameters","optional":true,"description":"<p>Definitions of the preconditions to be checked before execution</p>","types":[{"value":"Object<string,any>"}],"defaultValue":""},{"name":"busy","optional":true,"description":"<p>Defines the busy indicator</p>","depth":1,"types":[{"value":"object"}],"phoneName":"mParameters.busy","defaultValue":""},{"name":"set","optional":true,"defaultValue":true,"description":"<p>Triggers a busy indicator when the function is executed.</p>","depth":2,"types":[{"value":"boolean"}],"phoneName":"mParameters.busy.set"},{"name":"check","optional":true,"defaultValue":true,"description":"<p>Executes function only if application isn't busy.</p>","depth":2,"types":[{"value":"boolean"}],"phoneName":"mParameters.busy.check"},{"name":"updatesDocument","optional":true,"description":"<p>This operation updates the current document without using the bound model and context. As a result, the draft status is updated if a draft document exists, and the user has to confirm the cancellation of the editing process.</p>","depth":1,"types":[{"value":"boolean"}],"phoneName":"mParameters.updatesDocument","defaultValue":""}],"description":"<p>Secured execution of the given function. Ensures that the function is only executed when certain conditions are fulfilled.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/securedExecution","code":"<pre class=\"prettyprint\">securedExecution(fnFunction, mParameters?) : Promise</pre>"},{"name":"syncTask","module":"sap/fe/core/controllerextensions/InternalEditFlow","visibility":"restricted","returnValue":{"type":"Promise","description":"<p>Promise resolves once the task is completed</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"vTask","optional":true,"description":"<p>Optional, a promise or function to be executed synchronously</p>","types":[{"value":"Promise"},{"value":"function"}],"defaultValue":""}],"description":"<p>Performs a task in sync with other tasks created via this function. Returns the promise chain of the task.</p>","resource":"sap/fe/core/controllerextensions/InternalEditFlow.js","href":"api/sap.fe.core.controllerextensions.EditFlow#methods/syncTask","code":"<pre class=\"prettyprint\">syncTask(vTask?) : Promise</pre>"},{"name":"updateDocument","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>Promise resolves once draft status has been updated</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oContext","optional":false,"description":"<p>Context of the updated field</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"oPromise","optional":false,"description":"<p>Promise to determine when the update operation is completed. The promise should be resolved when the update operation is completed, so the draft status can be updated.</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Updates the draft status and displays the error messages if there are errors during an update.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.EditFlow#methods/updateDocument","code":"<pre class=\"prettyprint\">updateDocument(oContext, oPromise) : Promise</pre>"}],"displayName":"sap.fe.core.controllerextensions.EditFlow","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.EditFlow","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.IntentBasedNavigation","basename":"IntentBasedNavigation","resource":"sap/fe/core/controllerextensions/IntentBasedNavigation.js","module":"sap/fe/core/controllerextensions/IntentBasedNavigation","export":"","static":true,"visibility":"public","since":"1.86.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>Controller extension providing hooks for intent-based navigation</p>","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptNavigationContext","visibility":"public","since":"1.86.0","parameters":[{"name":"oSelectionVariant","optional":false,"description":"<p>SelectionVariant provided by SAP Fiori elements.</p>","types":[{"value":"sap.fe.navigation.SelectionVariant","linkEnabled":true,"href":"api/sap.fe.navigation.SelectionVariant"}],"defaultValue":""},{"name":"oNavigationInfo","optional":false,"description":"<p>Object containing intent-based navigation-related info</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"semanticObject","optional":false,"description":"<p>Semantic object related to the intent</p>","depth":1,"types":[{"value":"string"}],"phoneName":"oNavigationInfo.semanticObject","defaultValue":""},{"name":"action","optional":false,"description":"<p>Action related to the intent</p>","depth":1,"types":[{"value":"string"}],"phoneName":"oNavigationInfo.action","defaultValue":""}],"description":"<p>Provides a hook to customize the <a target=\"_self\" href=\"api/sap.fe.navigation.SelectionVariant\">sap.fe.navigation.SelectionVariant</a> related to the intent-based navigation.</p>","href":"api/sap.fe.core.controllerextensions.IntentBasedNavigation#methods/adaptNavigationContext","code":"<pre class=\"prettyprint\">adaptNavigationContext(oSelectionVariant, oNavigationInfo) : void</pre>"}],"displayName":"sap.fe.core.controllerextensions.IntentBasedNavigation","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.IntentBasedNavigation","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.MessageHandler","basename":"MessageHandler","resource":"sap/fe/core/controllerextensions/MessageHandler.js","module":"sap/fe/core/controllerextensions/MessageHandler","export":"","static":true,"visibility":"public","since":"1.90.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>A controller extension offering message handling.</p>","experimental":{"since":"1.90.0"},"ui5-metadata":{"stereotype":"object"},"methods":[{"name":"showMessageDialog","visibility":"public","since":"1.90.0","returnValue":{"type":"Promise","description":"<p>A promise that is resolved once the user closes the dialog. If there are no messages to be shown, the promise is resolved immediately</p>","types":[{"value":"Promise"}]},"description":"<p>Shows a message dialog with transition messages if there are any. The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages are removed from the message model. If there is more than one message, a list of messages is shown. The user can filter on message types and can display details as well as the long text. If there is one message, the dialog immediately shows the details of the message. If there is just one success message, a message toast is shown instead.</p>","experimental":{"since":"1.90.0"},"href":"api/sap.fe.core.controllerextensions.MessageHandler#methods/showMessageDialog","code":"<pre class=\"prettyprint\">showMessageDialog() : Promise</pre>"}],"displayName":"sap.fe.core.controllerextensions.MessageHandler","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.MessageHandler","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.Routing","basename":"Routing","resource":"sap/fe/core/controllerextensions/Routing.js","module":"sap/fe/core/controllerextensions/Routing","export":"","static":true,"visibility":"public","since":"1.86.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>A controller extension offering hooks into the routing flow of the application</p>","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"navigate","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","optional":false,"description":"<p>Object containing the context to be navigated</p>","types":[{"value":"sap.ui.model.odata.v4.Context"}],"defaultValue":""}],"description":"<p>Allows navigation to a specific context.</p>","href":"api/sap.fe.core.controllerextensions.Routing#methods/navigate","code":"<pre class=\"prettyprint\">navigate(oContext) : void</pre>"},{"name":"onAfterBinding","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","optional":false,"description":"<p>Object containing the context to be navigated</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>This function is used to intercept the routing event after binding a page.</p><p>If it is declared as an extension, it allows you to intercept and change the normal flow of binding.</p><p>This function is not called directly, but overridden separately by consuming controllers. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.Routing#methods/onAfterBinding","code":"<pre class=\"prettyprint\">onAfterBinding(oContext) : void</pre>"},{"name":"onBeforeBinding","visibility":"public","since":"1.90.0","parameters":[{"name":"oContext","optional":false,"description":"<p>Object containing the context for the navigation</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>This function is used to intercept the routing event before binding a page.</p><p>If it is declared as an extension, it allows you to intercept and change the normal flow of binding.</p><p>This function is not called directly, but overridden separately by consuming controllers. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.Routing#methods/onBeforeBinding","code":"<pre class=\"prettyprint\">onBeforeBinding(oContext) : void</pre>"},{"name":"onBeforeNavigation","visibility":"public","since":"1.86.0","returnValue":{"type":"boolean","description":"<p>`true` to prevent the default execution, false to keep the standard behavior</p>","types":[{"value":"boolean"}]},"parameters":[{"name":"mNavigationParameters","optional":false,"description":"<p>Object containing row context and page context</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"bindingContext","optional":false,"description":"<p>The currently selected context</p>","depth":1,"types":[{"value":"sap.ui.model.odata.v4.Context"}],"phoneName":"mNavigationParameters.bindingContext","defaultValue":""}],"description":"<p>This function can be used to intercept the routing event happening during the normal process of navigating from one page to another.</p><p>If declared as an extension, it allows you to intercept and change the normal navigation flow. If you decide to do your own navigation processing, you can return `true` to prevent the default routing behavior.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.Routing#methods/onBeforeNavigation","code":"<pre class=\"prettyprint\">onBeforeNavigation(mNavigationParameters) : boolean</pre>"}],"displayName":"sap.fe.core.controllerextensions.Routing","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.Routing","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.Share","basename":"Share","resource":"sap/fe/core/controllerextensions/Share.js","module":"sap/fe/core/controllerextensions/Share","export":"","static":true,"visibility":"public","since":"1.93.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>A controller extension offering hooks into the Share functionalities of the application</p>","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptShareMetadata","visibility":"public","since":"1.93.0","returnValue":{"type":"object|Promise<object>","description":"<p>Share Metadata or a Promise resolving the Share Metadata</p>","types":[{"value":"object"},{"value":"Promise<object>","href":"api/Promise<object>","linkEnabled":true}]},"parameters":[{"name":"oShareMetadata","optional":false,"description":"<p>Object containing the share metadata.</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"url","optional":false,"description":"<p>Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'</p>","depth":1,"types":[{"value":"string"}],"phoneName":"oShareMetadata.url","defaultValue":""},{"name":"title","optional":false,"description":"<p>Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam' and 'title' in 'Save as Tile'</p>","depth":1,"types":[{"value":"string"}],"phoneName":"oShareMetadata.title","defaultValue":""},{"name":"email","optional":true,"description":"<p>Email-specific metadata.</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oShareMetadata.email","defaultValue":""},{"name":"url","optional":false,"description":"<p>URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.email.url","defaultValue":""},{"name":"title","optional":false,"description":"<p>Title that will be used as \"email subject\" in 'Send Email'. This takes precedence over oShareMetadata.title.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.email.title","defaultValue":""},{"name":"jam","optional":true,"description":"<p>SAP Jam-specific metadata.</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oShareMetadata.jam","defaultValue":""},{"name":"url","optional":false,"description":"<p>URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.jam.url","defaultValue":""},{"name":"title","optional":false,"description":"<p>Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.jam.title","defaultValue":""},{"name":"tile","optional":true,"description":"<p>Save as Tile-specific metadata.</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oShareMetadata.tile","defaultValue":""},{"name":"url","optional":false,"description":"<p>URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.tile.url","defaultValue":""},{"name":"title","optional":false,"description":"<p>Title to be used for the tile. This takes precedence over oShareMetadata.title.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.tile.title","defaultValue":""},{"name":"subtitle","optional":false,"description":"<p>Subtitle to be used for the tile.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.tile.subtitle","defaultValue":""},{"name":"icon","optional":false,"description":"<p>Icon to be used for the tile.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.tile.icon","defaultValue":""},{"name":"queryUrl","optional":false,"description":"<p>Query URL of an OData service from which data for a dynamic tile is read.</p>","depth":2,"types":[{"value":"string"}],"phoneName":"oShareMetadata.tile.queryUrl","defaultValue":""}],"description":"<p>Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'.</p>","href":"api/sap.fe.core.controllerextensions.Share#methods/adaptShareMetadata","code":"<pre class=\"prettyprint\">adaptShareMetadata(oShareMetadata) : object|Promise<object></pre>"},{"name":"openShareSheet","visibility":"public","since":"1.93.0","parameters":[{"name":"oControl","optional":false,"description":"<p>The control to which the ActionSheet is opened.</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Opens the share sheet.</p>","href":"api/sap.fe.core.controllerextensions.Share#methods/openShareSheet","code":"<pre class=\"prettyprint\">openShareSheet(oControl) : void</pre>"}],"displayName":"sap.fe.core.controllerextensions.Share","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.Share","subTitle":""},{"kind":"class","name":"sap.fe.core.controllerextensions.ViewState","basename":"ViewState","resource":"sap/fe/core/controllerextensions/ViewState.js","module":"sap/fe/core/controllerextensions/ViewState","export":"","static":true,"visibility":"public","since":"1.85.0","extends":"sap.ui.core.mvc.ControllerExtension","description":"<p>A controller extension offering hooks for state handling</p><p>If you need to maintain a specific state for your application, you can use the controller extension.</p>","ui5-metadata":{"stereotype":"object"},"methods":[{"name":"adaptControlStateHandler","visibility":"protected","parameters":[{"name":"oControl","optional":false,"description":"<p>The control to get state handler for</p>","types":[{"value":"sap.ui.base.ManagedObject","linkEnabled":true,"href":"api/sap.ui.base.ManagedObject"}],"defaultValue":""},{"name":"aControlHandler","optional":false,"description":"<p>A list of plain objects with two functions: <code>retrieve</code> and <code>apply</code></p>","types":[{"value":"object[]"}],"defaultValue":""}],"description":"<p>Customize the <code>retrieve</code> and <code>apply</code> functions for a certain control.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/adaptControlStateHandler","code":"<pre class=\"prettyprint\">adaptControlStateHandler(oControl, aControlHandler) : void</pre>"},{"name":"adaptStateControls","visibility":"protected","parameters":[{"name":"aCollectedControls","optional":false,"description":"<p>The collected controls</p>","types":[{"value":"sap.ui.base.ManagedObject[]"}],"defaultValue":""}],"description":"<p>This function should add all controls for given view that should be considered for the state handling to the provided control array.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/adaptStateControls","code":"<pre class=\"prettyprint\">adaptStateControls(aCollectedControls) : void</pre>"},{"name":"applyAdditionalStates","visibility":"protected","parameters":[{"name":"oViewState","optional":false,"description":"<p>The current view state</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"aPromises","optional":false,"description":"<p>Extensible array of promises to be resolved before continuing</p>","types":[{"value":"Promise"}],"defaultValue":""}],"description":"<p>Applying additional, not control related, states - is called only if navigation type is iAppState.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/applyAdditionalStates","code":"<pre class=\"prettyprint\">applyAdditionalStates(oViewState, aPromises) : void</pre>"},{"name":"applyInitialStateOnly","visibility":"protected","returnValue":{"type":"boolean","description":"<p>If <code>true</code>, only the initial view state is applied once, else any new view state is also applied on follow-up calls (default)</p>","types":[{"value":"boolean"}]},"description":"<p>Defines whether the view state should only be applied once initially.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.Instead</a>.</p><p>Important: You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/applyInitialStateOnly","code":"<pre class=\"prettyprint\">applyInitialStateOnly() : boolean</pre>"},{"name":"applyNavigationParameters","visibility":"protected","parameters":[{"name":"oNavParameter","optional":false,"description":"<p>The current navigation parameter</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"navigationType","optional":false,"description":"<p>The actual navigation type</p>","depth":1,"types":[{"value":"sap.fe.navigation.NavType","linkEnabled":true,"href":"api/sap.fe.navigation.NavType"}],"phoneName":"oNavParameter.navigationType","defaultValue":""},{"name":"selectionVariant","optional":true,"description":"<p>The selectionVariant from the navigation</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oNavParameter.selectionVariant","defaultValue":""},{"name":"selectionVariantDefaults","optional":true,"description":"<p>The selectionVariant defaults from the navigation</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oNavParameter.selectionVariantDefaults","defaultValue":""},{"name":"requiresStandardVariant","optional":true,"description":"<p>Defines whether standard variant must be used in VM</p>","depth":1,"types":[{"value":"boolean"}],"phoneName":"oNavParameter.requiresStandardVariant","defaultValue":""},{"name":"aPromises","optional":false,"description":"<p>Extensible array of promises to be resolved before continuing</p>","types":[{"value":"Promise"}],"defaultValue":""}],"description":"<p>Apply navigation parameters - is called only if navigation type is not iAppState.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/applyNavigationParameters","code":"<pre class=\"prettyprint\">applyNavigationParameters(oNavParameter, aPromises) : void</pre>"},{"name":"applyViewState","visibility":"public","returnValue":{"type":"Promise","description":"<p>Promise for async state handling</p>","types":[{"value":"Promise"}]},"parameters":[{"name":"oViewState","optional":false,"description":"<p>The view state to apply (can be undefined)</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"oNavParameter","optional":false,"description":"<p>The current navigation parameter</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"navigationType","optional":false,"description":"<p>The actual navigation type</p>","depth":1,"types":[{"value":"sap.fe.navigation.NavType","linkEnabled":true,"href":"api/sap.fe.navigation.NavType"}],"phoneName":"oNavParameter.navigationType","defaultValue":""},{"name":"selectionVariant","optional":true,"description":"<p>The selectionVariant from the navigation</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oNavParameter.selectionVariant","defaultValue":""},{"name":"selectionVariantDefaults","optional":true,"description":"<p>The selectionVariant defaults from the navigation</p>","depth":1,"types":[{"value":"object"}],"phoneName":"oNavParameter.selectionVariantDefaults","defaultValue":""},{"name":"requiresStandardVariant","optional":true,"description":"<p>Defines whether standard variant must be used in VM</p>","depth":1,"types":[{"value":"boolean"}],"phoneName":"oNavParameter.requiresStandardVariant","defaultValue":""}],"description":"<p>Applies the given view state to this extensions view.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/applyViewState","code":"<pre class=\"prettyprint\">applyViewState(oViewState, oNavParameter) : Promise</pre>"},{"name":"onAfterStateApplied","visibility":"protected","parameters":[{"name":"aPromises","optional":false,"description":"<p>Extensible array of promises to be resolved before continuing</p>","types":[{"value":"Promise"}],"defaultValue":""}],"description":"<p>Hook to react when state for given view was applied.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/onAfterStateApplied","code":"<pre class=\"prettyprint\">onAfterStateApplied(aPromises) : void</pre>"},{"name":"onBeforeStateApplied","visibility":"protected","parameters":[{"name":"aPromises","optional":false,"description":"<p>Extensible array of promises to be resolved before continuing</p>","types":[{"value":"Promise"}],"defaultValue":""}],"description":"<p>Hook to react before a state for given view is applied.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/onBeforeStateApplied","code":"<pre class=\"prettyprint\">onBeforeStateApplied(aPromises) : void</pre>"},{"name":"retrieveAdditionalStates","visibility":"protected","parameters":[{"name":"mAdditionalStates","optional":false,"description":"<p>The additional state</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Extend the map of additional states (not control bound) to be added to the current view state of the given view.</p><p>This function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: <a target=\"_self\" href=\"api/sap.ui.core.mvc.OverrideExecution\">sap.ui.core.mvc.OverrideExecution.After</a>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/retrieveAdditionalStates","code":"<pre class=\"prettyprint\">retrieveAdditionalStates(mAdditionalStates) : void</pre>"},{"name":"retrieveViewState","visibility":"public","returnValue":{"type":"Promise","description":"<p>A promise resolving the view state</p>","types":[{"value":"Promise"}]},"description":"<p>Retrieve the view state of this extensions view. When this function is called more than once before finishing, all but the final response will resolve to <code>undefined</code>.</p>","href":"api/sap.fe.core.controllerextensions.ViewState#methods/retrieveViewState","code":"<pre class=\"prettyprint\">retrieveViewState() : Promise</pre>"}],"displayName":"sap.fe.core.controllerextensions.ViewState","component":"CA-UI5-FE","title":"class sap.fe.core.controllerextensions.ViewState","subTitle":""},{"kind":"class","name":"sap.fe.core.ExtensionAPI","basename":"ExtensionAPI","resource":"sap/fe/core/ExtensionAPI.js","module":"sap/fe/core/ExtensionAPI","export":"","static":true,"visibility":"public","since":"1.79.0","extends":"sap.ui.base.Object","description":"<p>Common Extension API for all pages of SAP Fiori elements for OData V4.</p>","ui5-metadata":{"stereotype":"object","associations":[{"name":"editFlow","singularName":"editFlow","type":"sap.fe.core.controllerextensions.EditFlow","cardinality":"0..1","visibility":"public","description":"<p>A controller extension offering hooks into the edit flow of the application.</p>","methods":["getEditFlow","setEditFlow"],"linkEnabled":true},{"name":"routing","singularName":"routing","type":"sap.fe.core.controllerextensions.Routing","cardinality":"0..1","visibility":"public","description":"<p>A controller extension offering hooks into the routing flow of the application.</p>","methods":["getRouting","setRouting"],"linkEnabled":true}]},"methods":[{"name":"addDependent","visibility":"public","parameters":[{"name":"oControl","optional":false,"description":"<p>Control to be added as a dependent control</p>","types":[{"value":"sap.ui.core.Control","linkEnabled":true,"href":"api/sap.ui.core.Control"}],"defaultValue":""}],"description":"<p>Add any control as a dependent control to this SAP Fiori elements page.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/addDependent","code":"<pre class=\"prettyprint\">addDependent(oControl) : void</pre>"},{"name":"getEditFlow","visibility":"public","returnValue":{"type":"sap.ui.core.ID","types":[{"value":"sap.ui.core.ID","href":"api/sap.ui.core.ID","linkEnabled":true}],"description":""},"description":"<p>ID of the element which is the current target of the association <a target=\"_self\" href=\"api/sap.fe.core.ExtensionAPI#methods/getEditFlow\">editFlow</a>, or <code>null</code>.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/getEditFlow","code":"<pre class=\"prettyprint\">getEditFlow() : sap.ui.core.ID</pre>"},{"name":"getModel","visibility":"public","returnValue":{"type":"sap.ui.model.Model","description":"<p>The required model</p>","types":[{"value":"sap.ui.model.Model","href":"api/sap.ui.model.Model","linkEnabled":true}]},"parameters":[{"name":"sModelName","optional":false,"description":"<p>Name of the model</p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Get access to models managed by SAP Fiori elements.<br> The following models can be accessed: <ul> <li>undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page</li> <li>i18n / further data models defined in the manifest</li> <li>ui: returns a SAPUI5 JSON model containing UI information. Only the following properties are public and supported: <ul> <li>editMode: contains either 'Editable' or 'Display'</li> </ul> </li> </ul>.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/getModel","code":"<pre class=\"prettyprint\">getModel(sModelName) : sap.ui.model.Model</pre>"},{"name":"getRouting","visibility":"public","returnValue":{"type":"sap.ui.core.ID","types":[{"value":"sap.ui.core.ID","href":"api/sap.ui.core.ID","linkEnabled":true}],"description":""},"description":"<p>ID of the element which is the current target of the association <a target=\"_self\" href=\"api/sap.fe.core.ExtensionAPI#methods/getRouting\">routing</a>, or <code>null</code>.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/getRouting","code":"<pre class=\"prettyprint\">getRouting() : sap.ui.core.ID</pre>"},{"name":"loadFragment","visibility":"public","returnValue":{"type":"Promise<(Element[]|sap.ui.core.Element[])>","description":"<p>The fragment definition</p>","types":[{"value":"Promise<(Element[]","href":"api/Promise<(Element","linkEnabled":true},{"value":"sap.ui.core.Element[])>","href":"api/sap.ui.core.Element)>","linkEnabled":true}]},"parameters":[{"name":"mSettings","optional":false,"description":"<p>The settings object</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"id","optional":false,"description":"<p>The ID of the fragment itself</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mSettings.id","defaultValue":""},{"name":"name","optional":false,"description":"<p>The name of the fragment to be loaded</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mSettings.name","defaultValue":""},{"name":"controller","optional":false,"description":"<p>The controller to be attached to the fragment</p>","depth":1,"types":[{"value":"object"}],"phoneName":"mSettings.controller","defaultValue":""},{"name":"contextPath","optional":false,"description":"<p>The contextPath to be used for the templating process</p>","depth":1,"types":[{"value":"string"}],"phoneName":"mSettings.contextPath","defaultValue":""},{"name":"initialBindingContext","optional":false,"description":"<p>The initial binding context</p>","depth":1,"types":[{"value":"sap.ui.model.Context","linkEnabled":true,"href":"api/sap.ui.model.Context"}],"phoneName":"mSettings.initialBindingContext","defaultValue":""}],"description":"<p>Load a fragment and go through the template preprocessor with the current page context.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/loadFragment","code":"<pre class=\"prettyprint\">loadFragment(mSettings) : Promise<(Element[]|sap.ui.core.Element[])></pre>"},{"name":"navigateToTarget","visibility":"public","parameters":[{"name":"sTarget","optional":false,"description":"<p>Name of the target route</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oContext","optional":true,"description":"<p>Context instance</p>","types":[{"value":"sap.ui.model.Context","linkEnabled":true,"href":"api/sap.ui.model.Context"}],"defaultValue":""}],"description":"<p>Navigate to another target.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/navigateToTarget","code":"<pre class=\"prettyprint\">navigateToTarget(sTarget, oContext?) : void</pre>"},{"name":"removeDependent","visibility":"public","parameters":[{"name":"oControl","optional":false,"description":"<p>Control to be added as a dependent control</p>","types":[{"value":"sap.ui.core.Control","linkEnabled":true,"href":"api/sap.ui.core.Control"}],"defaultValue":""}],"description":"<p>Remove a dependent control from this SAP Fiori elements page.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/removeDependent","code":"<pre class=\"prettyprint\">removeDependent(oControl) : void</pre>"},{"name":"setEditFlow","visibility":"public","returnValue":{"type":"this","description":"<p>Reference to <code>this</code> in order to allow method chaining</p>","types":[{"value":"this"}]},"parameters":[{"name":"oEditFlow","optional":false,"description":"<p>ID of an element which becomes the new target of this editFlow association; alternatively, an element instance may be given</p>","types":[{"value":"sap.ui.core.ID","linkEnabled":true,"href":"api/sap.ui.core.ID"},{"value":"sap.fe.core.controllerextensions.EditFlow","linkEnabled":true,"href":"api/sap.fe.core.controllerextensions.EditFlow"}],"defaultValue":""}],"description":"<p>Sets the associated <a target=\"_self\" href=\"api/sap.fe.core.ExtensionAPI#methods/getEditFlow\">editFlow</a>.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/setEditFlow","code":"<pre class=\"prettyprint\">setEditFlow(oEditFlow) : this</pre>"},{"name":"setRouting","visibility":"public","returnValue":{"type":"this","description":"<p>Reference to <code>this</code> in order to allow method chaining</p>","types":[{"value":"this"}]},"parameters":[{"name":"oRouting","optional":false,"description":"<p>ID of an element which becomes the new target of this routing association; alternatively, an element instance may be given</p>","types":[{"value":"sap.ui.core.ID","linkEnabled":true,"href":"api/sap.ui.core.ID"},{"value":"sap.fe.core.controllerextensions.Routing","linkEnabled":true,"href":"api/sap.fe.core.controllerextensions.Routing"}],"defaultValue":""}],"description":"<p>Sets the associated <a target=\"_self\" href=\"api/sap.fe.core.ExtensionAPI#methods/getRouting\">routing</a>.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/setRouting","code":"<pre class=\"prettyprint\">setRouting(oRouting) : this</pre>"},{"name":"updateAppState","visibility":"public","returnValue":{"type":"Promise","description":"<p>A promise that resolves with the new app state object.</p>","types":[{"value":"Promise"}]},"description":"<p>Triggers an update of the app state. Should be called if the state of a control, or any other state-relevant information, was changed.</p>","href":"api/sap.fe.core.ExtensionAPI#methods/updateAppState","code":"<pre class=\"prettyprint\">updateAppState() : Promise</pre>"}],"displayName":"sap.fe.core.ExtensionAPI","nodes":[{"name":"sap.fe.core.ExtensionAPI.intentBasedNavigation","description":"<p>ExtensionAPI for intent-based navigation</p>","href":"api/sap.fe.core.ExtensionAPI.intentBasedNavigation"}],"component":"CA-UI5-FE","title":"class sap.fe.core.ExtensionAPI","subTitle":""},{"kind":"namespace","name":"sap.fe.core.ExtensionAPI.intentBasedNavigation","basename":"intentBasedNavigation","resource":"sap/fe/core/ExtensionAPI.js","module":"sap/fe/core/ExtensionAPI","export":"intentBasedNavigation","static":true,"visibility":"public","since":"1.86.0","description":"<p><p>ExtensionAPI for intent-based navigation</p></p>","methods":[{"name":"navigateOutbound","visibility":"public","parameters":[{"name":"sOutbound","optional":false,"description":"<p>Identifier to locate the outbound definition in the manifest. This provides the semantic object and action for the intent-based navigation. Additionally, the outbound definition can be used to provide parameters for intent-based navigation. See <a target=\"_self\" href=\"topic/be0cf40f61184b358b5faedaec98b2da\">Descriptor for Applications, Components, and Libraries</a> for more information.</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"mNavigationParameters","optional":false,"description":"<p>Optional map containing key/value pairs to be passed to the intent. If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest are ignored.</p>","types":[{"value":"object"}],"defaultValue":""}],"description":"<p>Navigates to an intent defined by an outbound definition in the manifest.</p>","href":"api/sap.fe.core.ExtensionAPI.intentBasedNavigation#methods/navigateOutbound","code":"<pre class=\"prettyprint\">navigateOutbound(sOutbound, mNavigationParameters) : void</pre>"}],"displayName":"sap.fe.core.ExtensionAPI.intentBasedNavigation","component":"CA-UI5-FE","title":"namespace sap.fe.core.ExtensionAPI.intentBasedNavigation","subTitle":""},{"kind":"namespace","name":"sap.fe.core.fpm","basename":"fpm","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"fpm","static":true,"visibility":"public","description":"<p><p>Collection of classes provided by SAP Fiori elements for the Flexible Programming Model</p></p>","displayName":"sap.fe.core.fpm","nodes":[{"name":"sap.fe.core.fpm.Component","description":"<p>Component that can be used as a wrapper component for custom pages.\n</p>","href":"api/sap.fe.core.fpm.Component"}],"component":"CA-UI5-FE","title":"namespace sap.fe.core.fpm","subTitle":""},{"kind":"class","name":"sap.fe.core.fpm.Component","basename":"Component","resource":"sap/fe/core/fpm/Component.js","module":"sap/fe/core/fpm/Component","export":"","static":true,"visibility":"public","since":"1.92.0","extends":"sap.fe.core.TemplateComponent","description":"<p>Component that can be used as a wrapper component for custom pages.</p><p>The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:</p><p><pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n</pre></p>","experimental":{"since":"1.92.0"},"ui5-metadata":{"properties":[{"name":"viewName","type":"string","defaultValue":"","group":"Misc","visibility":"public","description":"<p>Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.</p>","methods":["getViewName","setViewName"]}]},"methods":[{"name":"sap.fe.core.fpm.Component.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class sap.fe.core.fpm.Component with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/sap.fe.core.TemplateComponent#methods/sap.fe.core.TemplateComponent.extend\">sap.fe.core.TemplateComponent.extend</a>.</p>","href":"api/sap.fe.core.fpm.Component#methods/sap.fe.core.fpm.Component.extend","code":"<pre class=\"prettyprint\">sap.fe.core.fpm.Component.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"sap.fe.core.fpm.Component.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class sap.fe.core.fpm.Component.</p>","href":"api/sap.fe.core.fpm.Component#methods/sap.fe.core.fpm.Component.getMetadata","code":"<pre class=\"prettyprint\">sap.fe.core.fpm.Component.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"getViewName","visibility":"public","returnValue":{"type":"string","description":"<p>Value of property <code>viewName</code></p>","types":[{"value":"string"}]},"description":"<p>Gets current value of property <a target=\"_self\" href=\"api/sap.fe.core.fpm.Component#methods/getViewName\">viewName</a>.</p><p>Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.</p>","href":"api/sap.fe.core.fpm.Component#methods/getViewName","code":"<pre class=\"prettyprint\">getViewName() : string</pre>"},{"name":"setViewName","visibility":"public","returnValue":{"type":"this","description":"<p>Reference to <code>this</code> in order to allow method chaining</p>","types":[{"value":"this"}]},"parameters":[{"name":"sViewName","optional":false,"description":"<p>New value for property <code>viewName</code></p>","types":[{"value":"string"}],"defaultValue":""}],"description":"<p>Sets a new value for property <a target=\"_self\" href=\"api/sap.fe.core.fpm.Component#methods/getViewName\">viewName</a>.</p><p>Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.</p><p>When called with a value of <code>null</code> or <code>undefined</code>, the default value of the property will be restored.</p>","href":"api/sap.fe.core.fpm.Component#methods/setViewName","code":"<pre class=\"prettyprint\">setViewName(sViewName) : this</pre>"}],"displayName":"sap.fe.core.fpm.Component","component":"CA-UI5-FE","title":"class sap.fe.core.fpm.Component","subTitle":""},{"kind":"enum","name":"sap.fe.core.InitialLoadMode","basename":"InitialLoadMode","resource":"sap/fe/core/library.js","module":"sap/fe/core/library","export":"InitialLoadMode","static":true,"visibility":"public","since":"1.86.0","description":"<p><p>Possible initial load (first app startup) modes for a ListReport.</p></p>","properties":[{"name":"sap.fe.core.InitialLoadMode.Auto","visibility":"public","description":"<p>Data will be loaded initially if filters are set.</p>"},{"name":"sap.fe.core.InitialLoadMode.Disabled","visibility":"public","description":"<p>Data will not be loaded initially.</p>"},{"name":"sap.fe.core.InitialLoadMode.Enabled","visibility":"public","description":"<p>Data will be loaded initially.</p>"}],"displayName":"sap.fe.core.InitialLoadMode","component":"CA-UI5-FE","title":"enum sap.fe.core.InitialLoadMode","subTitle":""},{"kind":"class","name":"sap.fe.core.PageController","basename":"PageController","resource":"sap/fe/core/PageController.js","module":"sap/fe/core/PageController","export":"","static":true,"visibility":"public","since":"1.88.0","extends":"sap.fe.core.BaseController","description":"<p>Base controller class for your custom page used inside an SAP Fiori elements application.</p><p>This controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.</p>","ui5-metadata":{"stereotype":"object"},"displayName":"sap.fe.core.PageController","component":"CA-UI5-FE","title":"class sap.fe.core.PageController","subTitle":""},{"name":"sap","displayName":"sap","kind":"namespace","nodes":[{"name":"sap.fe","description":"<p>Root namespace for all the libraries related to SAP Fiori elements.</p>","href":"api/sap.fe"}],"title":"namespace sap","subTitle":""}],"defaultComponent":"CA-UI5-FE"}

package/packages/sap.fe.core/test/sap/fe/core/designtime/codeassistance/Library.jsmeta.json

@@ -0,0 +1 @@
+{"!name":"sap.fe.core","!version":"1.21.1","!define":{"sap.fe.core.PageController":{"!description":"Base controller class for your custom page used inside an SAP Fiori elements application.\n\nThis controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.","!module":"sap/fe/core/PageController","!helpDescription":"Base controller class for your custom page used inside an SAP Fiori elements application.\n\nThis controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.","!proto":"sap.fe.core.BaseController","!category":"class"},"sap.fe.core.controllerextensions.ViewState_obj":{"!type":"fn()","prototype":"sap.fe.core.controllerextensions.ViewState"},"sap.fe.core.fpm":{"!description":"Collection of classes provided by SAP Fiori elements for the Flexible Programming Model","!module":"sap/fe/core/library","viewName":{"!description":"Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.","!category":"enum","!type":"String"},"!helpDescription":"Collection of classes provided by SAP Fiori elements for the Flexible Programming Model","!category":"namespace","Component":"sap.fe.core.fpm.Component_obj"},"sap.fe.core.BaseController_obj":{"extend":{"!description":"Creates a new subclass of class sap.fe.core.BaseController with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.mvc.Controller.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"!type":"fn()","prototype":"sap.fe.core.BaseController"},"sap.fe.core.AppComponent_obj":{"extend":{"!description":"Creates a new subclass of class sap.fe.core.AppComponent with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"!type":"fn()","prototype":"sap.fe.core.AppComponent"},"sap.fe.core.controllerextensions.Routing":{"!description":"A controller extension offering hooks into the routing flow of the application","navigate":{"!description":"Allows navigation to a specific context.","!static":false,"!category":"function","!type":"fn(oContext: sap.ui.model.odata.v4.Context)","parameters":{"oContext":"type: sap.ui.model.odata.v4.Context, description: Object containing the context to be navigated"}},"!module":"sap/fe/core/controllerextensions/Routing","onBeforeNavigation":{"!description":"This function can be used to intercept the routing event happening during the normal process of navigating from one page to another.\n\nIf declared as an extension, it allows you to intercept and change the normal navigation flow. If you decide to do your own navigation processing, you can return `true` to prevent the default routing behavior.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(mNavigationParameters: Object) -> Boolean","parameters":{"mNavigationParameters":"type: object, description: Object containing row context and page context"}},"!helpDescription":"A controller extension offering hooks into the routing flow of the application","!proto":"sap.ui.core.mvc.ControllerExtension","!category":"class","onAfterBinding":{"!description":"This function is used to intercept the routing event after binding a page.\n\nIf it is declared as an extension, it allows you to intercept and change the normal flow of binding.\n\nThis function is not called directly, but overridden separately by consuming controllers. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(oContext: Object)","parameters":{"oContext":"type: object, description: Object containing the context to be navigated"}},"onBeforeBinding":{"!description":"This function is used to intercept the routing event before binding a page.\n\nIf it is declared as an extension, it allows you to intercept and change the normal flow of binding.\n\nThis function is not called directly, but overridden separately by consuming controllers. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(oContext: Object)","parameters":{"oContext":"type: object, description: Object containing the context for the navigation"}}},"sap.fe.core.ExtensionAPI.intentBasedNavigation":{"!description":"ExtensionAPI for intent-based navigation","navigateOutbound":{"!description":"Navigates to an intent defined by an outbound definition in the manifest.","!static":"true","!category":"function","!type":"fn(sOutbound: String, mNavigationParameters: Object)"},"!module":"sap/fe/core/ExtensionAPI","!helpDescription":"ExtensionAPI for intent-based navigation","!category":"namespace"},"sap.fe":{"!description":"Root namespace for all the libraries related to SAP Fiori elements.","core":"sap.fe.core","!module":"sap/fe/core/library","!helpDescription":"Root namespace for all the libraries related to SAP Fiori elements.","!category":"namespace"},"sap.fe.core.controllerextensions.EditFlow_obj":{"extend":{"!description":"Creates a new subclass of class sap.fe.core.controllerextensions.EditFlow with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"!type":"fn()","prototype":"sap.fe.core.controllerextensions.EditFlow"},"sap.fe.core.BaseController":{"!description":"Internal base controller class for SAP Fiori elements application.\n\nIf you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.","extend":{"!description":"Creates a new subclass of class sap.fe.core.BaseController with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.mvc.Controller.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"getAppComponent":{"!description":"Returns the current app component.","!static":false,"!category":"function","!type":"fn() -> sap.fe.core.AppComponent"},"getMetadata":{"!description":"Returns a metadata object for class sap.fe.core.BaseController.","!static":true,"!category":"function","!type":"fn() -> sap.ui.base.Metadata"},"!module":"sap/fe/core/BaseController","!helpDescription":"Internal base controller class for SAP Fiori elements application.\n\nIf you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.","!proto":"sap.ui.core.mvc.Controller","!category":"class"},"sap.fe.core.controllerextensions":{"IntentBasedNavigation":"sap.fe.core.controllerextensions.IntentBasedNavigation_obj","!description":"Collection of controller extensions used internally in SAP Fiori elements exposing a method that you can override to allow more flexibility.","MessageHandler":"sap.fe.core.controllerextensions.MessageHandler_obj","!module":"sap/fe/core/library","!helpDescription":"Collection of controller extensions used internally in SAP Fiori elements exposing a method that you can override to allow more flexibility.","EditFlow":"sap.fe.core.controllerextensions.EditFlow_obj","Routing":"sap.fe.core.controllerextensions.Routing_obj","ViewState":"sap.fe.core.controllerextensions.ViewState_obj","!category":"namespace","Share":"sap.fe.core.controllerextensions.Share_obj"},"sap.fe.core.ExtensionAPI":{"!description":"Common Extension API for all pages of SAP Fiori elements for OData V4.","getModel":{"!description":"Get access to models managed by SAP Fiori elements.<br> The following models can be accessed: <ul> <li>undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page<\/li> <li>i18n / further data models defined in the manifest<\/li> <li>ui: returns a SAPUI5 JSON model containing UI information. Only the following properties are public and supported: <ul> <li>editMode: contains either 'Editable' or 'Display'<\/li> <\/ul> <\/li> <\/ul>.","!static":false,"!category":"function","!type":"fn(sModelName: String) -> sap.ui.model.Model","parameters":{"sModelName":"type: string, description: Name of the model"}},"removeDependent":{"!description":"Remove a dependent control from this SAP Fiori elements page.","!static":false,"!category":"function","!type":"fn(oControl: sap.ui.core.Control)","parameters":{"oControl":"type: sap.ui.core.Control, description: Control to be added as a dependent control"}},"!proto":"sap.ui.base.Object","updateAppState":{"!description":"Triggers an update of the app state. Should be called if the state of a control, or any other state-relevant information, was changed.","!static":false,"!category":"function","!type":"fn() -> Promise"},"!category":"class","loadFragment":{"!description":"Load a fragment and go through the template preprocessor with the current page context.","!static":false,"!category":"function","!type":"fn(mSettings: Object) -> [Promise<(Element[] | sap.ui.core.Element]","parameters":{"mSettings":"type: object, description: The settings object"}},"setRouting":{"!description":"Sets the associated {@link #getRouting routing}.","!static":false,"!category":"function","!type":"fn(oRouting: sap.ui.core.ID | sap.fe.core.controllerextensions.Routing) -> sap.fe.core.ExtensionAPI","parameters":{"oRouting":"type: sap.ui.core.ID|sap.fe.core.controllerextensions.Routing, description: ID of an element which becomes the new target of this routing association; alternatively, an element instance may be given"}},"!constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n<\/p><p>\nThe supported settings are:\n<ul>\n<li>Associations\n<ul>\n<li>{@link #getEditFlow editFlow} : (sap.ui.core.ID | sap.fe.core.controllerextensions.EditFlow)<\/li>\n<li>{@link #getRouting routing} : (sap.ui.core.ID | sap.fe.core.controllerextensions.Routing)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\nIn addition, all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object}\ncan be used as well.","setEditFlow":{"!description":"Sets the associated {@link #getEditFlow editFlow}.","!static":false,"!category":"function","!type":"fn(oEditFlow: sap.ui.core.ID | sap.fe.core.controllerextensions.EditFlow) -> sap.fe.core.ExtensionAPI","parameters":{"oEditFlow":"type: sap.ui.core.ID|sap.fe.core.controllerextensions.EditFlow, description: ID of an element which becomes the new target of this editFlow association; alternatively, an element instance may be given"}},"!module":"sap/fe/core/ExtensionAPI","addDependent":{"!description":"Add any control as a dependent control to this SAP Fiori elements page.","!static":false,"!category":"function","!type":"fn(oControl: sap.ui.core.Control)","parameters":{"oControl":"type: sap.ui.core.Control, description: Control to be added as a dependent control"}},"getRouting":{"!description":"ID of the element which is the current target of the association {@link #getRouting routing}, or <code>null<\/code>.","!static":false,"!category":"function","!type":"fn() -> sap.ui.core.ID"},"!helpDescription":"Common Extension API for all pages of SAP Fiori elements for OData V4.","navigateToTarget":{"!description":"Navigate to another target.","!static":false,"!category":"function","!type":"fn(sTarget: String, oContext?: sap.ui.model.Context)","parameters":{"oContext":"type: sap.ui.model.Context, description: Context instance","sTarget":"type: string, description: Name of the target route"}},"getEditFlow":{"!description":"ID of the element which is the current target of the association {@link #getEditFlow editFlow}, or <code>null<\/code>.","!static":false,"!category":"function","!type":"fn() -> sap.ui.core.ID"}},"sap.fe.core.controllerextensions.EditFlow":{"!description":"A controller extension offering hooks into the edit flow of the application","editDocument":{"!description":"Creates a draft document for an existing active document.","!static":false,"!category":"function","!type":"fn(oContext: Object) -> Promise","parameters":{"oContext":"type: object, description: Context of the active document"}},"invokeAction":{"!description":"Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and show the updated data upon navigation.","!static":false,"!category":"function","!type":"fn(sActionName: String, mParameters?: map) -> Promise","parameters":{"sActionName":"type: string, description: The name of the action to be called","mParameters":"type: map, description: Contains the following attributes:"}},"getMetadata":{"!description":"Returns a metadata object for class sap.fe.core.controllerextensions.EditFlow.","!static":true,"!category":"function","!type":"fn() -> sap.ui.base.Metadata"},"!proto":"sap.ui.core.mvc.ControllerExtension","syncTask":{"!description":"Performs a task in sync with other tasks created via this function. Returns the promise chain of the task.","!static":false,"!category":"function","!type":"fn(vTask?: Promise | fn()) -> Promise","parameters":{"vTask":"type: Promise|function, description: Optional, a promise or function to be executed synchronously"}},"!category":"class","createDocument":{"!description":"Creates a new document.","!static":false,"!category":"function","!type":"fn(vListBinding: sap.ui.model.odata.v4.ODataListBinding | String) -> Promise","parameters":{"vListBinding":"type: sap.ui.model.odata.v4.ODataListBinding|string, description: ODataListBinding object or the binding path for a temporary list binding"}},"extend":{"!description":"Creates a new subclass of class sap.fe.core.controllerextensions.EditFlow with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"!module":"sap/fe/core/controllerextensions/EditFlow","!helpDescription":"A controller extension offering hooks into the edit flow of the application","cancelDocument":{"!description":"Discard the editable document.","!static":false,"!category":"function","!type":"fn(oContext: Object, mParameters?: map) -> Promise","parameters":{"oContext":"type: object, description: Context of the editable document","mParameters":"type: map, description: Can contain the following attributes:"}},"deleteDocument":{"!description":"Deletes the document.","!static":false,"!category":"function","!type":"fn(oContext: Object, mParameters?: map) -> Promise","parameters":{"oContext":"type: object, description: Context of the document","mParameters":"type: map, description: Optional, can contain the following attributes:"}},"securedExecution":{"!description":"Secured execution of the given function. Ensures that the function is only executed when certain conditions are fulfilled.","!static":false,"!category":"function","!type":"fn(fnFunction: fn(), mParameters?: map) -> Promise","parameters":{"fnFunction":"type: function, description: The function to be executed. Should return a promise that is settled after completion of the execution. If nothing is returned, immediate completion is assumed.","mParameters":"type: map, description: Definitions of the preconditions to be checked before execution"}},"applyDocument":{"!description":"Submit the current set of changes and navigate back.","!static":false,"!category":"function","!type":"fn(oContext: Object) -> Promise","parameters":{"oContext":"type: object, description: Context of the document"}},"saveDocument":{"!description":"Saves a new document after checking it.","!static":false,"!category":"function","!type":"fn(oContext: Object) -> Promise","parameters":{"oContext":"type: object, description: Context of the editable document"}},"updateDocument":{"!description":"Updates the draft status and displays the error messages if there are errors during an update.","!static":false,"!category":"function","!type":"fn(oContext: Object, oPromise: Object) -> Promise","parameters":{"oPromise":"type: object, description: Promise to determine when the update operation is completed. The promise should be resolved when the update operation is completed, so the draft status can be updated.","oContext":"type: object, description: Context of the updated field"}},"onBeforeSave":{"!description":"This function can be used to intercept the save action. You can execute custom coding in this function. The framework waits for the returned promise to be resolved before continuing the save action. If you reject the promise the save action is stopped and the user stays in edit mode.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.","!static":false,"!category":"function","!type":"fn() -> Promise"}},"sap.fe.core.fpm.Component":{"!description":"Component that can be used as a wrapper component for custom pages.\n\nThe component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:\n\n<pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n<\/pre>","extend":{"!description":"Creates a new subclass of class sap.fe.core.fpm.Component with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.fe.core.TemplateComponent.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"getMetadata":{"!description":"Returns a metadata object for class sap.fe.core.fpm.Component.","!static":true,"!category":"function","!type":"fn() -> sap.ui.base.Metadata"},"!constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n<\/p><p>\nThe supported settings are:\n<ul>\n<li>Properties\n<ul>\n<li>{@link #getViewName viewName} : string<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\nIn addition, all settings applicable to the base type {@link sap.fe.core.TemplateComponent#constructor sap.fe.core.TemplateComponent}\ncan be used as well.","!module":"sap/fe/core/fpm/Component","setViewName":{"!description":"Sets a new value for property {@link #getViewName viewName}.\n\nName of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.\n\nWhen called with a value of <code>null<\/code> or <code>undefined<\/code>, the default value of the property will be restored.","!static":false,"!category":"function","!type":"fn(sViewName: String) -> sap.fe.core.fpm.Component","parameters":{"sViewName":"type: string, description: New value for property <code>viewName<\/code>"}},"!helpDescription":"Component that can be used as a wrapper component for custom pages.\n\nThe component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:\n\n<pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n<\/pre>","!proto":"sap.fe.core.TemplateComponent","getViewName":{"!description":"Gets current value of property {@link #getViewName viewName}.\n\nName of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.","!static":false,"!category":"function","!type":"fn() -> String"},"!category":"class"},"sap.fe.core":{"!description":"Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.","controllerextensions":"sap.fe.core.controllerextensions","intentBasedNavigation":"sap.fe.core.ExtensionAPI.intentBasedNavigation","fpm":"sap.fe.core.fpm","PageController":"sap.fe.core.PageController_obj","!module":"sap/fe/core/library","!helpDescription":"Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.","BaseController":"sap.fe.core.BaseController_obj","AppComponent":"sap.fe.core.AppComponent_obj","!category":"namespace","ExtensionAPI":"sap.fe.core.ExtensionAPI_obj","InitialLoadMode":"sap.fe.core.InitialLoadMode"},"sap.fe.core.controllerextensions.ViewState":{"!description":"A controller extension offering hooks for state handling\n\nIf you need to maintain a specific state for your application, you can use the controller extension.","retrieveAdditionalStates":{"!description":"Extend the map of additional states (not control bound) to be added to the current view state of the given view.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(mAdditionalStates: Object)","parameters":{"mAdditionalStates":"type: object, description: The additional state"}},"applyAdditionalStates":{"!description":"Applying additional, not control related, states - is called only if navigation type is iAppState.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(oViewState: Object, aPromises: Promise)","parameters":{"oViewState":"type: object, description: The current view state","aPromises":"type: Promise, description: Extensible array of promises to be resolved before continuing"}},"onAfterStateApplied":{"!description":"Hook to react when state for given view was applied.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(aPromises: Promise)","parameters":{"aPromises":"type: Promise, description: Extensible array of promises to be resolved before continuing"}},"!proto":"sap.ui.core.mvc.ControllerExtension","!category":"class","retrieveViewState":{"!description":"Retrieve the view state of this extensions view. When this function is called more than once before finishing, all but the final response will resolve to <code>undefined<\/code>.","!static":false,"!category":"function","!type":"fn() -> Promise"},"applyInitialStateOnly":{"!description":"Defines whether the view state should only be applied once initially.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.\n\nImportant: You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!","!static":false,"!category":"function","!type":"fn() -> Boolean"},"applyViewState":{"!description":"Applies the given view state to this extensions view.","!static":false,"!category":"function","!type":"fn(oViewState: Object, oNavParameter: Object) -> Promise","parameters":{"oViewState":"type: object, description: The view state to apply (can be undefined)","oNavParameter":"type: object, description: The current navigation parameter"}},"!module":"sap/fe/core/controllerextensions/ViewState","!helpDescription":"A controller extension offering hooks for state handling\n\nIf you need to maintain a specific state for your application, you can use the controller extension.","adaptControlStateHandler":{"!description":"Customize the <code>retrieve<\/code> and <code>apply<\/code> functions for a certain control.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(oControl: sap.ui.base.ManagedObject, aControlHandler: [Object])","parameters":{"aControlHandler":"type: object[], description: A list of plain objects with two functions: <code>retrieve<\/code> and <code>apply<\/code>","oControl":"type: sap.ui.base.ManagedObject, description: The control to get state handler for"}},"adaptStateControls":{"!description":"This function should add all controls for given view that should be considered for the state handling to the provided control array.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(aCollectedControls: [sap.ui.base.ManagedObject])","parameters":{"aCollectedControls":"type: sap.ui.base.ManagedObject[], description: The collected controls"}},"onBeforeStateApplied":{"!description":"Hook to react before a state for given view is applied.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(aPromises: Promise)","parameters":{"aPromises":"type: Promise, description: Extensible array of promises to be resolved before continuing"}},"applyNavigationParameters":{"!description":"Apply navigation parameters - is called only if navigation type is not iAppState.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","!static":false,"!category":"function","!type":"fn(oNavParameter: Object, aPromises: Promise)","parameters":{"aPromises":"type: Promise, description: Extensible array of promises to be resolved before continuing","oNavParameter":"type: object, description: The current navigation parameter"}}},"sap":{"sap":"sap","!category":"namespace","fe":"sap.fe"},"sap.fe.core.controllerextensions.Share_obj":{"!type":"fn()","prototype":"sap.fe.core.controllerextensions.Share"},"sap.fe.core.InitialLoadMode":{"!description":"Possible initial load (first app startup) modes for a ListReport.","Auto":{"!description":"Data will be loaded initially if filters are set.","!category":"enum","!type":"String"},"!module":"sap/fe/core/library","Enabled":{"!description":"Data will be loaded initially.","!category":"enum","!type":"String"},"!category":"static class","Disabled":{"!description":"Data will not be loaded initially.","!category":"enum","!type":"String"}},"sap.fe.core.AppComponent":{"!description":"Main class for components used for an application in SAP Fiori elements.\n\nApplication developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.\n\nWhen you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>","extend":{"!description":"Creates a new subclass of class sap.fe.core.AppComponent with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"getRouterProxy":{"!description":"Get a reference to the RouterProxy.","!static":false,"!category":"function","!type":"fn() -> oObject"},"!constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n\nThis class does not have its own settings, but all settings applicable to the base type\n{@link sap.ui.core.UIComponent#constructor sap.ui.core.UIComponent} can be used.","getRootViewController":{"!description":"Get a reference to the nav/FCL Controller.","!static":false,"!category":"function","!type":"fn() -> oObject"},"!module":"sap/fe/core/AppComponent","!helpDescription":"Main class for components used for an application in SAP Fiori elements.\n\nApplication developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.\n\nWhen you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>","!proto":"sap.ui.core.UIComponent","!category":"class","getRootContainer":{"!description":"Get the NavContainer control or the FCL control.","!static":false,"!category":"function","!type":"fn() -> oObject"},"getAppStateHandler":{"!description":"Get a reference to the AppStateHandler.","!static":false,"!category":"function","!type":"fn() -> oObject"}},"sap.fe.core.controllerextensions.IntentBasedNavigation_obj":{"!type":"fn()","prototype":"sap.fe.core.controllerextensions.IntentBasedNavigation"},"sap.fe.core.controllerextensions.Routing_obj":{"!type":"fn()","prototype":"sap.fe.core.controllerextensions.Routing"},"sap.fe.core.controllerextensions.Share":{"!description":"A controller extension offering hooks into the Share functionalities of the application","adaptShareMetadata":{"!description":"Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'.","!static":false,"!category":"function","!type":"fn(oShareMetadata: Object) -> Object | Promise<object>","parameters":{"oShareMetadata":"type: object, description: Object containing the share metadata."}},"openShareSheet":{"!description":"Opens the share sheet.","!static":false,"!category":"function","!type":"fn(oControl: Object)","parameters":{"oControl":"type: object, description: The control to which the ActionSheet is opened."}},"!module":"sap/fe/core/controllerextensions/Share","!helpDescription":"A controller extension offering hooks into the Share functionalities of the application","!proto":"sap.ui.core.mvc.ControllerExtension","!category":"class"},"sap.fe.core.PageController_obj":{"!type":"fn()","prototype":"sap.fe.core.PageController"},"sap.fe.core.fpm.Component_obj":{"extend":{"!description":"Creates a new subclass of class sap.fe.core.fpm.Component with name <code>sClassName<\/code> and enriches it with the information contained in <code>oClassInfo<\/code>.\n\n<code>oClassInfo<\/code> might contain the same kind of information as described in {@link sap.fe.core.TemplateComponent.extend}.","!static":true,"!category":"function","!type":"fn(sClassName: String, oClassInfo?: Object, FNMetaImpl?: fn()) -> fn()","parameters":{"oClassInfo":"type: object, description: Object literal with information about the class","FNMetaImpl":"type: function, description: Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class","sClassName":"type: string, description: Name of the class being created"}},"!type":"fn()","prototype":"sap.fe.core.fpm.Component"},"sap.fe.core.controllerextensions.IntentBasedNavigation":{"!description":"Controller extension providing hooks for intent-based navigation","adaptNavigationContext":{"!description":"Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.","!static":false,"!category":"function","!type":"fn(oSelectionVariant: sap.fe.navigation.SelectionVariant, oNavigationInfo: Object)","parameters":{"oSelectionVariant":"type: sap.fe.navigation.SelectionVariant, description: SelectionVariant provided by SAP Fiori elements.","oNavigationInfo":"type: object, description: Object containing intent-based navigation-related info"}},"!module":"sap/fe/core/controllerextensions/IntentBasedNavigation","!helpDescription":"Controller extension providing hooks for intent-based navigation","!proto":"sap.ui.core.mvc.ControllerExtension","!category":"class"},"sap.fe.core.controllerextensions.MessageHandler":{"!description":"A controller extension offering message handling.","showMessageDialog":{"!description":"Shows a message dialog with transition messages if there are any. The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages are removed from the message model. If there is more than one message, a list of messages is shown. The user can filter on message types and can display details as well as the long text. If there is one message, the dialog immediately shows the details of the message. If there is just one success message, a message toast is shown instead.","!static":false,"!category":"function","!type":"fn() -> Promise"},"!module":"sap/fe/core/controllerextensions/MessageHandler","!helpDescription":"A controller extension offering message handling.","!proto":"sap.ui.core.mvc.ControllerExtension","!category":"class"},"sap.fe.core.controllerextensions.MessageHandler_obj":{"!type":"fn()","prototype":"sap.fe.core.controllerextensions.MessageHandler"},"sap.fe.core.ExtensionAPI_obj":{"!type":"fn()","prototype":"sap.fe.core.ExtensionAPI"}}}

package/packages/sap.fe.core/test/sap/fe/core/designtime/codeassistance/Library.jstemplates.json

@@ -0,0 +1 @@
+{"Templates":[{"template":"loadFragment(\n\t{\n\t\tid: \"${id}\", // string\n\t\tname: \"${name}\", // string\n\t\tcontroller: ${controller}, // object\n\t\tcontextPath: \"${contextPath}\", // string\n\t\tinitialBindingContext: ${initialBindingContext} // sap.ui.model.Context\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.ExtensionAPI.loadFragment","description":"loadFragment(mSettings) : Promise<(Element[]|sap.ui.core.Element[])>","helpDescription":"Load a fragment and go through the template preprocessor with the current page context.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"cancelDocument(\n\t\"${oContext}\", // object\n\t{\n\t\tcontrol: ${control} // object\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.EditFlow.cancelDocument","description":"cancelDocument(oContext, mParameters?) : Promise","helpDescription":"Discard the editable document.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"deleteDocument(\n\t\"${oContext}\", // object\n\t{\n\t\ttitle: \"${title}\", // string\n\t\tdescription: \"${description}\" // string\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.EditFlow.deleteDocument","description":"deleteDocument(oContext, mParameters?) : Promise","helpDescription":"Deletes the document.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"invokeAction(\n\t\"${sActionName}\", // string\n\t{\n\t\tcontexts: ${contexts}, // sap.ui.model.odata.v4.Context\n\t\tmodel: ${model}, // sap.ui.model.odata.v4.ODataModel\n\t\trequiresNavigation: ${bRequiresNavigation}, // boolean\n\t\tlabel: \"${label}\" // string\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.EditFlow.invokeAction","description":"invokeAction(sActionName, mParameters?) : Promise","helpDescription":"Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and show the updated data upon navigation.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"securedExecution(\n\t\"${fnFunction}\", // function\n\t{\n\t\tbusy: ${busy}, // object\n\t\tupdatesDocument: ${bUpdatesDocument} // boolean\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.EditFlow.securedExecution","description":"securedExecution(fnFunction, mParameters?) : Promise","helpDescription":"Secured execution of the given function. Ensures that the function is only executed when certain conditions are fulfilled.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"adaptNavigationContext(\n\t\"${oSelectionVariant}\", // sap.fe.navigation.SelectionVariant\n\t{\n\t\tsemanticObject: \"${semanticObject}\", // string\n\t\taction: \"${action}\" // string\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.IntentBasedNavigation.adaptNavigationContext","description":"adaptNavigationContext(oSelectionVariant, oNavigationInfo)","helpDescription":"Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"onBeforeNavigation(\n\t{\n\t\tbindingContext: ${bindingContext} // sap.ui.model.odata.v4.Context\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.Routing.onBeforeNavigation","description":"onBeforeNavigation(mNavigationParameters) : boolean","helpDescription":"This function can be used to intercept the routing event happening during the normal process of navigating from one page to another.\n\nIf declared as an extension, it allows you to intercept and change the normal navigation flow. If you decide to do your own navigation processing, you can return `true` to prevent the default routing behavior.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"adaptShareMetadata(\n\t{\n\t\turl: \"${url}\", // string\n\t\ttitle: \"${title}\", // string\n\t\temail: ${email}, // object\n\t\tjam: ${jam}, // object\n\t\ttile: ${tile} // object\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.Share.adaptShareMetadata","description":"adaptShareMetadata(oShareMetadata) : object|Promise<object>","helpDescription":"Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"applyNavigationParameters(\n\t{\n\t\tnavigationType: ${navigationType}, // sap.fe.navigation.NavType\n\t\tselectionVariant: ${selectionVariant}, // object\n\t\tselectionVariantDefaults: ${selectionVariantDefaults}, // object\n\t\trequiresStandardVariant: ${bRequiresStandardVariant} // boolean\n\t},\n\t\"${aPromises}\" // Promise\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.ViewState.applyNavigationParameters","description":"applyNavigationParameters(oNavParameter, aPromises)","helpDescription":"Apply navigation parameters - is called only if navigation type is not iAppState.\n\nThis function is meant to be individually overridden by consuming controllers, but not to be called directly. The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.","category":"method","DeprecatedInfo":{"isDeprecated":false}},{"template":"applyViewState(\n\t\"${oViewState}\", // object\n\t{\n\t\tnavigationType: ${navigationType}, // sap.fe.navigation.NavType\n\t\tselectionVariant: ${selectionVariant}, // object\n\t\tselectionVariantDefaults: ${selectionVariantDefaults}, // object\n\t\trequiresStandardVariant: ${bRequiresStandardVariant} // boolean\n\t}\n)\n","Deprecated":false,"prefix":"^withoutprefix","Experimental":false,"name":"sap.fe.core.controllerextensions.ViewState.applyViewState","description":"applyViewState(oViewState, oNavParameter) : Promise","helpDescription":"Applies the given view state to this extensions view.","category":"method","DeprecatedInfo":{"isDeprecated":false}}],"!version":"1.21.1"}

package/packages/sap.fe.core/test/sap/fe/core/designtime/codeassistance/Library.xmlmeta.json

@@ -0,0 +1 @@
+{"enums":{"sap.fe.core.InitialLoadMode":{"Auto":{"Deprecated":false,"Experimental":false,"description":"Data will be loaded initially if filters are set.","helpDescription":"Data will be loaded initially if filters are set.","DeprecatedInfo":{"isDeprecated":false},"value":"Auto"},"Enabled":{"Deprecated":false,"Experimental":false,"description":"Data will be loaded initially.","helpDescription":"Data will be loaded initially.","DeprecatedInfo":{"isDeprecated":false},"value":"Enabled"},"Disabled":{"Deprecated":false,"Experimental":false,"description":"Data will not be loaded initially.","helpDescription":"Data will not be loaded initially.","DeprecatedInfo":{"isDeprecated":false},"value":"Disabled"}}},"metadatas":{"sap.fe.core.PageController":{"extend":"sap.fe.core.BaseController","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/PageController","description":"Base controller class for your custom page used inside an SAP Fiori elements application.\n\nThis controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.","helpDescription":"Base controller class for your custom page used inside an SAP Fiori elements application.\n\nThis controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core":{"filetype":"library","types":["sap.fe.core.InitialLoadMode"],"typesWithClasses":["sap.fe.core.controllerextensions","sap.fe.core.fpm"],"module":"sap/fe/core/library","name":"sap.fe.core","description":"Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.","helpDescription":"Library providing the core functionality of the runtime for SAP Fiori elements for OData V4.","version":"1.94.0"},"sap.fe.core.controllerextensions.ViewState":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/ViewState","description":"A controller extension offering hooks for state handling\n\nIf you need to maintain a specific state for your application, you can use the controller extension.","helpDescription":"A controller extension offering hooks for state handling\n\nIf you need to maintain a specific state for your application, you can use the controller extension.","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap":{"filetype":"library","types":["sap.fe"],"name":"sap","version":"1.94.0"},"sap.fe.core.controllerextensions.Routing":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/Routing","description":"A controller extension offering hooks into the routing flow of the application","helpDescription":"A controller extension offering hooks into the routing flow of the application","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.AppComponent":{"associations":{},"filetype":"class","Experimental":false,"module":"sap/fe/core/AppComponent","description":"Main class for components used for an application in SAP Fiori elements.\n\nApplication developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.\n\nWhen you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>","constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n\nThis class does not have its own settings, but all settings applicable to the base type\n{@link sap.ui.core.UIComponent#constructor sap.ui.core.UIComponent} can be used.","extend":"sap.ui.core.UIComponent","Deprecated":false,"helpDescription":"Main class for components used for an application in SAP Fiori elements.\n\nApplication developers using the templates and building blocks provided by SAP Fiori elements should create their apps by extending this component. This ensures that all the necessary services that you need for the building blocks and templates to work properly are started.\n\nWhen you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori elements provides two options: <br/> - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router <br/> - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case) <br/>","DeprecatedInfo":{"isDeprecated":false},"aggregations":{"rootControl":{"method":"#getRootControl,destroyRootControl,setRootControl","Deprecated":false,"Experimental":false,"multiple":"false","description":"The root control of the UIComponent.\n\nThe root control should be created inside the function {@link sap.ui.core.UIComponent#createContent}.","fullName":"sap.fe.core.AppComponent#rootControl","helpDescription":"The root control of the UIComponent.\n\nThe root control should be created inside the function {@link sap.ui.core.UIComponent#createContent}.","type":"sap.ui.core.Control","DeprecatedInfo":{"isDeprecated":false}}},"properties":{"models":{"defaultValue":{},"description":"A map of model instances to which the object should be attached. The models are keyed by their model name. For the default model, String(undefined) is expected.","fullName":"sap.fe.core.AppComponent#models","type":"object"},"objectBindings":{"defaultValue":{},"description":"A map of model instances to which the object should be attached. The models are keyed by their model name. For the default model, String(undefined) is expected.","fullName":"sap.fe.core.AppComponent#objectBindings","type":"object"},"componentData":{"defaultValue":"","fullName":"sap.fe.core.AppComponent#componentData","type":"any"},"id":{"defaultValue":"","description":"Unique ID of this instance. If not given, a so called autoID will be generated by the framework. AutoIDs use a unique prefix that must not be used for Ids that the application (or other code) creates. It can be configured option 'autoIDPrefix', see {@link sap.ui.core.Configuration}.","fullName":"sap.fe.core.AppComponent#id","type":"sap.ui.core.ID"},"bindingContexts":{"defaultValue":{},"description":"A map of model instances to which the object should be attached. The models are keyed by their model name. For the default model, String(undefined) is expected.","fullName":"sap.fe.core.AppComponent#bindingContexts","type":"object"},"metadataContexts":{"defaultValue":{},"description":"A map of model instances to which the object should be attached. The models are keyed by their model name. For the default model, String(undefined) is expected. The special setting is only for internal use.","fullName":"sap.fe.core.AppComponent#metadataContexts","type":"object"}},"events":{"formatError":{"method":"sap.fe.core.AppComponent#event:formatError","Deprecated":false,"Experimental":false,"name":"formatError","description":"Fired when a new value for a bound property should have been propagated from the model, but formatting the value failed with an exception.","fullName":"sap.fe.core.AppComponent#formatError","helpDescription":"Fired when a new value for a bound property should have been propagated from the model, but formatting the value failed with an exception.","type":"fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]","DeprecatedInfo":{"isDeprecated":false}},"parseError":{"method":"sap.fe.core.AppComponent#event:parseError","Deprecated":false,"Experimental":false,"name":"parseError","description":"Fired when a new value for a bound property should have been propagated to the model, but parsing the value failed with an exception.","fullName":"sap.fe.core.AppComponent#parseError","helpDescription":"Fired when a new value for a bound property should have been propagated to the model, but parsing the value failed with an exception.","type":"fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]","DeprecatedInfo":{"isDeprecated":false}},"validationSuccess":{"method":"sap.fe.core.AppComponent#event:validationSuccess","Deprecated":false,"Experimental":false,"name":"validationSuccess","description":"Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding uses a data type.","fullName":"sap.fe.core.AppComponent#validationSuccess","helpDescription":"Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding uses a data type.","type":"fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]","DeprecatedInfo":{"isDeprecated":false}},"modelContextChange":{"method":"sap.fe.core.AppComponent#event:modelContextChange","Deprecated":false,"Experimental":false,"name":"modelContextChange","description":"Fired when models or contexts are changed on this object (either by calling setModel/setBindingContext or due to propagation)","fullName":"sap.fe.core.AppComponent#modelContextChange","helpDescription":"Fired when models or contexts are changed on this object (either by calling setModel/setBindingContext or due to propagation)","type":"fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]","DeprecatedInfo":{"isDeprecated":false}},"validationError":{"method":"sap.fe.core.AppComponent#event:validationError","Deprecated":false,"Experimental":false,"name":"validationError","description":"Fired when a new value for a bound property should have been propagated to the model, but validating the value failed with an exception.","fullName":"sap.fe.core.AppComponent#validationError","helpDescription":"Fired when a new value for a bound property should have been propagated to the model, but validating the value failed with an exception.","type":"fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]","DeprecatedInfo":{"isDeprecated":false}}}},"sap.fe.core.BaseController":{"extend":"sap.ui.core.mvc.Controller","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/BaseController","description":"Internal base controller class for SAP Fiori elements application.\n\nIf you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.","helpDescription":"Internal base controller class for SAP Fiori elements application.\n\nIf you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.controllerextensions.Share":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/Share","description":"A controller extension offering hooks into the Share functionalities of the application","helpDescription":"A controller extension offering hooks into the Share functionalities of the application","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.controllerextensions.IntentBasedNavigation":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/IntentBasedNavigation","description":"Controller extension providing hooks for intent-based navigation","helpDescription":"Controller extension providing hooks for intent-based navigation","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.controllerextensions.MessageHandler":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/MessageHandler","description":"A controller extension offering message handling.","helpDescription":"A controller extension offering message handling.","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.ExtensionAPI":{"associations":{"routing":{"method":"#getRouting,setRouting","Deprecated":false,"Experimental":false,"multiple":"false","description":"A controller extension offering hooks into the routing flow of the application.","fullName":"sap.fe.core.ExtensionAPI#routing","helpDescription":"A controller extension offering hooks into the routing flow of the application.","type":"sap.fe.core.controllerextensions.Routing","DeprecatedInfo":{"isDeprecated":false}},"editFlow":{"method":"#getEditFlow,setEditFlow","Deprecated":false,"Experimental":false,"multiple":"false","description":"A controller extension offering hooks into the edit flow of the application.","fullName":"sap.fe.core.ExtensionAPI#editFlow","helpDescription":"A controller extension offering hooks into the edit flow of the application.","type":"sap.fe.core.controllerextensions.EditFlow","DeprecatedInfo":{"isDeprecated":false}}},"filetype":"class","Experimental":false,"module":"sap/fe/core/ExtensionAPI","description":"Common Extension API for all pages of SAP Fiori elements for OData V4.","constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n<\/p><p>\nThe supported settings are:\n<ul>\n<li>Associations\n<ul>\n<li>{@link #getEditFlow editFlow} : (sap.ui.core.ID | sap.fe.core.controllerextensions.EditFlow)<\/li>\n<li>{@link #getRouting routing} : (sap.ui.core.ID | sap.fe.core.controllerextensions.Routing)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\nIn addition, all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object}\ncan be used as well.","extend":"sap.ui.base.Object","Deprecated":false,"helpDescription":"Common Extension API for all pages of SAP Fiori elements for OData V4.","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.controllerextensions.EditFlow":{"extend":"sap.ui.core.mvc.ControllerExtension","associations":{},"filetype":"class","Deprecated":false,"Experimental":false,"module":"sap/fe/core/controllerextensions/EditFlow","description":"A controller extension offering hooks into the edit flow of the application","helpDescription":"A controller extension offering hooks into the edit flow of the application","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{},"events":{}},"sap.fe.core.fpm.Component":{"associations":{},"filetype":"class","Experimental":false,"module":"sap/fe/core/fpm/Component","description":"Component that can be used as a wrapper component for custom pages.\n\nThe component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:\n\n<pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n<\/pre>","constructorDescription":"Accepts an object literal <code>mSettings<\/code> that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee {@link sap.ui.base.ManagedObject#constructor} for a general description of the syntax of the settings object.\n<\/p><p>\nThe supported settings are:\n<ul>\n<li>Properties\n<ul>\n<li>{@link #getViewName viewName} : string<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\nIn addition, all settings applicable to the base type {@link sap.fe.core.TemplateComponent#constructor sap.fe.core.TemplateComponent}\ncan be used as well.","extend":"sap.fe.core.TemplateComponent","Deprecated":false,"helpDescription":"Component that can be used as a wrapper component for custom pages.\n\nThe component can be used in case you want to use SAP Fiori elements Building Blocks or XML template constructions. You can either extend the component and set the viewName and contextPath within your code or you can use it to wrap your custom XML view directly the manifest when you define your custom page under sapui5/routing/targets:\n\n<pre>\n\"myCustomPage\": {\n\t\"type\": \"Component\",\n\t\"id\": \"myCustomPage\",\n\t\"name\": \"sap.fe.core.fpm\",\n\t\"title\": \"My Custom Page\",\n\t\"options\": {\n\t\t\"settings\": {\n\t\t\t\"viewName\": \"myNamespace.myView\",\n\t\t\t\"contextPath\": \"/MyEntitySet\"\n\t\t\t}\n\t\t}\n\t}\n<\/pre>","DeprecatedInfo":{"isDeprecated":false},"aggregations":{},"properties":{"viewName":{"method":"#getViewName,setViewName","Deprecated":false,"Experimental":false,"description":"Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.","fullName":"sap.fe.core.fpm.Component#viewName","helpDescription":"Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building Blocks and XML template constructions.","type":"string","DeprecatedInfo":{"isDeprecated":false}}},"events":{}}},"!version":"1.21.1"}

package/packages/sap.fe.core/test/sap/fe/core/designtime/codeassistance/Library.xmltemplates.json

@@ -0,0 +1 @@
+{"XML_KEYWORDS":[],"XML_TEMPLATES":[],"!version":"1.21.1"}