Interface App

Interface for Xrm.App API

See

External Link: Xrm.App (Client API reference)

Hierarchy

  • App

Properties

sidePanes

Methods

addGlobalNotification clearGlobalNotification

Properties

sidePanes

sidePanes: {
    state: number;
    createPane(paneOptions?) => PromiseLike<PaneObject>;
    getAllPanes() => PaneObject[];
    getPane(panelId) => PaneObject;
    getSelectedPane() => PaneObject;
}

Provides methods for managing side panes.

Type declaration

  • state: number

    Returns

    whether the selected pane is collapsed or expanded.

  • createPane:function
    • createPane(paneOptions?): PromiseLike<PaneObject>

    • Provides all the information to create side panes.

      Parameters

      • Optional paneOptions: PaneOptions

        The ID to use to clear a specific notification that was set using addGlobalNotification.

      Returns PromiseLike<PaneObject>

  • getAllPanes:function
    • getAllPanes(): PaneObject[]

    • Returns PaneObject[]

      a collection containing all active panes.

  • getPane:function
    • getPane(panelId): PaneObject

    • Parameters

      • panelId: string

        string

      Returns PaneObject

      the side pane corresponding to the input ID. If the side pane does not exist, undefined is returned.

  • getSelectedPane:function
    • getSelectedPane(): PaneObject

    • Returns PaneObject

      the currently selected pane.

See

External Link: sidePanes (Client API reference)

Methods

addGlobalNotification

  • Displays an error, information, warning, or success notification for an app, and lets you specify actions to execute based on the notification.

    Parameters

    Returns PromiseLike<string>

    On success, returns a promise object containing a GUID value to uniquely identify the notification as described earlier in the description of the successCallback parameter.

clearGlobalNotification

  • Clears a notification in the app.

    Parameters

    • uniqueId: string

      The ID to use to clear a specific notification that was set using addGlobalNotification.

    Returns PromiseLike<string>

    On success, returns a promise object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc