External Module: Index

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

Interfaces

• Modules
• Runtime

Functions

Init

▸ init(bootstrap: function): void

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

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

Example:

Copy
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
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:

Returns: void

runtime

▸ runtime(): Runtime

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

Example:

Copy
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
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.

Next steps

Explore details of the Page, TopBar, and User external modules.

Explore the attributes and behavior of Adobe Experience Cloud Interfaces:

Modules

Runtime

Return to the Guides Index.

Last updated 12/10/2024

Was this helpful?

Yes

No