Module: alfresco/services/NotificationService

alfresco/services/NotificationService

Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

closeNotificationTopic :string

This is the topic that is subscribed to for handling requests to close a displayed notification.
Type:
  • string
Default Value:
Source:

displayPromptTopic :string

This is the topic that is subscribed to for handling requests to display a prompt.
Type:
  • string
Default Value:
  • topics.DISPLAY_PROMPT
Source:

i18nRequirements :Array

An array of the i18n files to use with this widget.
Type:
  • Array
Source:

showProgressIndicator :boolean

Controls whether or not the subscriptions are created for progress indicator requests so if this is configured to be false then the progress indicator will never be shown.
Type:
  • boolean
Since:
  • 1.0.72
Default Value:
  • false
Source:

Methods

onAddProgressActivity()

Increments the quantity of in-progress activities and displays the progress-indicator if not already displayed.
Since:
  • 1.0.71
Source:

onConfirmationPromptCancellation(payload)

Parameters:
Name Type Description
payload object An object containing the deletion details.
Since:
  • 1.0.85
Source:

onConfirmationPromptConfirmation(payload)

Parameters:
Name Type Description
payload object An object containing the deletion details.
Since:
  • 1.0.85
Source:

onConfirmationPromptRequest(payload)

This is a generic
Parameters:
Name Type Description
payload object
Since:
  • 1.0.85
Source:

onDisplayNotification(payload)

Displays a notification to the user
Parameters:
Name Type Description
payload object The details of the notification.
Source:

onDisplayPrompt(payload)

Displays a prompt to the user
Parameters:
Name Type Description
payload object The details of the notification.
Source:

onDisplayStickyPanel(payload)

Displays a sticky panel at the bottom of the screen.
Parameters:
Name Type Description
payload object The details of the notification.
Since:
  • 1.0.48
Source:

onRemoveAllProgressActivities(payload)

Decrements the quantity of in-progress activities and hides the progress-indicator if its displayed.
Parameters:
Name Type Description
payload Object The publication payload
Since:
  • 1.0.71
Source:

onRemoveProgressActivity(payload)

Decrements the quantity of in-progress activities and hides the progress-indicator if its displayed.
Parameters:
Name Type Description
payload Object The publication payload
Since:
  • 1.0.71
Source:

registerSubscriptions()

Sets up the subscriptions for the NotificationService
Since:
  • 1.0.32
Source:
Listens to Events:

resetProgressIndicator()

Hide the progress indicator (destroy it) and reset the number of activities to zero.
Since:
  • 1.0.71
Source:

Events

displayNotificationTopic

This is the topic that is subscribed to for handling requests to display a notification.
Type:
  • string
Default Value:
  • topics.DISPLAY_NOTIFICATION
Source:
Listens to Events:
Listeners of This Event: