gwc.api

The gwc.api namespace object contains functions exported by components (functions that are public or exposed so other components can use them).

These functions are usable by other components. Because this content is dynamic, it is recommended to check the existence of a function before calling it.

Note: While this documentation will highlight some of the APIs of the Client-Side Framework (CSF), it does not attempt to explain all of the APIs. The complete API reference is contained in the JavaScript™ code and can be extracted using the JsDoc Toolkit.

Example

Using an API exported by a main component:

If ( gwc.api.fireAcceleratorByName ) {
  gwc.api.fireAcceleratorByName('accept');
}