Mobile Investigator API

The SAS Mobile Investigator API provides a set of methods and HTML elements that enable developers to create customized solutions within the application.

Getting Started

For documentation and examples, see Solution Extension GitHub.

API

The SMI API is available through the JavaScript window object:

window.sas.smi.about.getAppVersion().then((version) => {
    console.log(version);
});
Copy

The control API can be accessed through the controlApi property on control elements:

this.controlApi.control.state;
Copy

The following HTML elements are exposed in the package:

ControlLabelElement

<smi-control-label></smi-control-label>
Copy

RelateCreateStepElement

<smi-relate-create-step id="relate-create"></smi-relate-create-step>
Copy

SmiRelateToStepComponent

<smi-relate-to-step id="relate-to"></smi-relate-to-step>
Copy

RelateSearchResultsStepElement

<smi-relate-search-results-step id="relate-search-results"></smi-relate-search-results-step>
Copy

RelateCreateStepElement

<smi-relate-view-step id="relate-view"></smi-relate-view-step>
Copy

SmiRelatePropertiesStepComponent

<smi-relate-properties-step id="relate-properties"></smi-relate-properties-step>
Copy

WizardElement

<smi-wizard #wizard>
    <template>
        <smi-relate-to-step id="relate-to"></smi-relate-to-step>
        <smi-relate-create-step id="relate-create"></smi-relate-create-step>
        <smi-relate-search-results-step id="relate-search-results"></smi-relate-search-results-step>
        <smi-relate-view-step id="relate-view"></smi-relate-view-step>
        <smi-relate-properties-step id="relate-properties"></smi-relate-properties-step>
    </template>
</smi-wizard>
Copy

Typings

To complement the API, solution developers can download the API typings package. Run the following command in your project:

npm install @sassoftware/mobile-investigator
Copy

Use types to help with the autocompletion of API spaces, methods, and expected return types.

import { SmiWindow, isSasMobileWindowApi } from "@sassoftware/mobile-investigator";

const smiWindow = window as SmiWindow;
if (isSasMobileWindowApi(smiWindow.sas)) {
    smiWindow.sas.smi.config.registerSolutionExtension(control);
}
Copy