Web SDK documentation
  1. Injectables
  2. ModalService

File

core/modal/modal.service.ts

Description

Service to show a modal.

Index

Methods

Constructor

constructor(modalService: BsModalService, gainsightService: GainsightService)
Parameters :
Name Type Optional
modalService BsModalService No
gainsightService GainsightService No

Methods

Async acknowledge
acknowledge(title: string, body: string, status: StatusType, acknowledgeLabel: string, productExperienceEvent: ProductExperienceEvent)

Shows a quick acknowledge message modal.

Parameters :
Name Type Optional Default value Description
title string No

The title of that modal.
body string No

The text body to display.
status StatusType No Status.INFO

The status.
acknowledgeLabel string No gettext('Confirm')

The label to use.
productExperienceEvent ProductExperienceEvent No { eventName: 'confirmModal' }

Additional data to attach to custom product experience events.
Returns : unknown
Async confirm
confirm(title: string, body: string, status: StatusType, labels: ConfirmModalComponent, confirmOptions: ConfirmOptions, productExperienceEvent: ProductExperienceEvent)

Shows a quick confirm message modal.

Parameters :
Name Type Optional Default value Description
title string No

The title of that modal.
body string No

The text body to display.
status StatusType No Status.INFO

The status.
labels ConfirmModalComponent No {}

The labels to use. Default: { ok: 'Confirm', cancel: 'Cancel'}
confirmOptions ConfirmOptions No {}

Selection options to display as checkbox list.
productExperienceEvent ProductExperienceEvent No { eventName: 'confirmModal' }

Additional data to attach to custom product experience events.
Returns : unknown
Async confirmLogout
confirmLogout(body?: string, status: StatusType, labels: any)

Shows a quick logout confirmation modal.

Parameters :
Name Type Optional Default value Description
body string Yes

The text body to display. Default: 'You will be logged out to apply your changes. Do you want to proceed?'
status StatusType No Status.WARNING

The status.
labels any No {}

The labels to use. Default: { ok: 'Confirm and log out', cancel: 'Cancel' }
Returns : unknown

results matching ""

    No results matching ""