External Module: Index

This API is used to integrate solution web applications with the unified shell of Adobe Experience Cloud.

Interfaces

Functions

Init

▸ init(bootstrap: function): void

Initializes a solution web application by invoking the bootstrap callback once the runtime is ready.

If the module is already defined, begin bootstrap
Otherwise, define the global callback that will be called when runtime is ready

Example:

import React from 'react';
import ReactDOM from 'react-dom';
import runtime, {init} from '@exc/runtime';

init(() => {
  ReactDOM.render(<MainComponent runtime={runtime()} />, document.querySelector('#main'));
});

Parameters:

▪ bootstrap: function

The callback used to bootstrap a solution. The runtime object is passed in as a parameter to this callback.

▸ (runtime: Runtime): void

Parameters:

Name

Type

runtime

Runtime

Returns: void

runtime

▸ runtime(): Runtime

Get the runtime object, which contains all unified-shell APIs.

Example:

import React from 'react';
import ReactDOM from 'react-dom';
import excApp from '@exc/runtime';

export class MyComponent extends React.Component {
  constructor(props) {
    this.runtime = excApp();
  }
}

Returns: Runtime

The runtime object.