Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Navigation

Module for navigating in D365

Hierarchy

  • Navigation

Index

Constructors

Methods

Constructors

constructor

Methods

navigateTo

  • navigateTo(pageInput: PageInputEntityRecord | PageInputEntityList | PageInputHtmlWebResource, navigationOptions?: NavigationOptions, settings?: NavigationSettings): Promise<void>

  • Navigate to the specified page

    Parameters

    • pageInput: PageInputEntityRecord | PageInputEntityList | PageInputHtmlWebResource

      Define where to navigate to (entity record, entity list or html web resource)

    • Optional navigationOptions: NavigationOptions

      Define whether to navigate inline or in a dialog

    • Optional settings: NavigationSettings

      How to handle dialogs that prevent navigation. Cancel discards the dialog, confirm accepts it. Default is discarding it.

    Returns Promise<void>

    Promise which resolves once the page is fully loaded

openAppById

  • Opens the specified UCI app

    Parameters

    • appId: string

      The id of the app to open

    • Optional settings: NavigationSettings

      How to handle dialogs that prevent navigation. Cancel discards the dialog, confirm accepts it. Default is discarding it.

    Returns Promise<void>

    Promise which resolves once the app is fully loaded

openCreateForm

  • Opens a create form for the specified entity

    Parameters

    • entityName: string

      The entity to open the form for

    • Optional settings: FormNavigationSettings

      How to handle dialogs that prevent navigation. Cancel discards the dialog, confirm accepts it. Default is discarding it.

    Returns Promise<void>

    Promise which resolves once form is fully loaded

openQuickCreate

  • openQuickCreate(entityName: string): Promise<void>

  • Opens a quick create form for the specified entity

    Parameters

    • entityName: string

      The entity to open the form for

    Returns Promise<void>

    Promise which resolves once form is fully loaded

openUpdateForm

  • Opens an update form for an existing record

    Parameters

    • entityName: string

      The entity to open the form for

    • entityId: string

      The id of the record to open

    • Optional settings: FormNavigationSettings

      How to handle dialogs that prevent navigation. Cancel discards the dialog, confirm accepts it. Default is discarding it.

    Returns Promise<void>

    Promise which resolves once form is fully loaded

Generated using TypeDoc