OpenUI5 APIs are classified into different types. Only APIs of type public should be used by application developers.
All OpenUI5 APIs are assigned one of several possible types. App developers should only use public APIs, as compatibility is guaranteed only for these. APIs of type protected are not relevant for app developers; they are only relevant for library development. For example, they could be functions called by certain controls in control development.
The following table gives an overview over these API types:
API Types
|
API Type |
Description |
Compatibility Assured? |
Can be used by applications? |
Further Details |
Example |
|---|---|---|---|---|---|
|
|
Indicates that the API, such as a class or method, is generally available for application developers. |
||||
|
|
Indicates that usage of the API is restricted. It is not meant to be used by applications. |
The API might be used outside the relevant class or subclasses, but only in closely related classes in OpenUI5 library / control development. |
|||
|
|
Indicates that the API is not meant for use outside of OpenUI5 framework development. It won't be visible in the OpenUI5 documentation. |
The API is not meant to be used outside its own class, module, package, or library. |
|||
|
|
Indicates that the API is only meant for certain stakeholders within OpenUI5 framework development and won't be visible in the OpenUI5 documentation. |
Any potential new usage should be discussed with the owner first, then the stakeholder information should be updated, and only then should the API be used. |
|||
|
|
Deprecated, replaced by |
|
|
1) Unless the API is experimental.
2) There's no compatibility promise for ui5-restricted APIs. However, before introducing incompatible changes the owner is expected to announce them to the listed stakeholders, so that all affected parties can cooperate to achieve a smooth migration.
The OpenUI5 documentation only includes APIs of categories
publicandprotected.
Related Information