Share via


Shell.UI.Notifications.Notification.js

 

Applies To: Windows Azure Pack

Creates a UI notification to be displayed above the drawer.

Notifications do not require any action from the user. They are displayed until the user decides to take action.

Once the notification is created, you can add it with the add method in Shell.UI.Notifications.js.

Widgets

None.

Types

Shell.UI.Notifications.Notification(title, status)

Configures a new progress.

Name

Type

Description

title

String

The title.

status

String

The status.

Properties

None.

Methods

Name

Description

Returns

Parameters

Shell.UI.Notifications.Notification.setActions

Changes the action buttons available with the notification.

Nothing

actions (Array): Action array containing objects that have the following key:

  • text

  • url

  • click

Shell.UI.Notifications.Notification.setDetailsText

Sets the details text.

Nothing

text (String): The text.

Shell.UI.Notifications.Notification.setDetailsUrl

Sets the details iframe url.

Nothing

url (String): The URL.

Shell.UI.Notifications.Notification.setStatus

Sets the status.

Nothing

status (String): The status.

Shell.UI.Notifications.Notification.setTitle

Sets the title.

Nothing

title (String): The title.

Shell.UI.Notifications.Notification.sync

Begins synchronization.

None.

Shell.UI.Notifications.Notification.toJSON

Converts supplied parameters to JSON.

Nothing

a:First.

b: Second parameter.

c: Third parameter.

See Also

Windows Azure Pack Extension Shell Library Reference