External module: "index"

API used to integrate as solution web application with the unified shell of the Adobe Experience Cloud.

Index#

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, start to 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'));
});
Copied to your clipboard
1import React from 'react';
2import ReactDOM from 'react-dom';
3import runtime, {init} from '@exc/runtime';
4
5init(() => {
6  ReactDOM.render(<MainComponent runtime={runtime()} />, document.querySelector('#main'));
7});

Parameters:

▪ bootstrap: function

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();
  }
}
Copied to your clipboard
1import React from 'react';
2import ReactDOM from 'react-dom';
3import excApp from '@exc/runtime';
4
5export class MyComponent extends React.Component {
6  constructor(props) {
7    this.runtime = excApp();
8  }
9}