Shell.UI.Notifications.Progress.js
Applies To: Windows Azure Pack
Creates a UI progress notification to be displayed above the drawer.
Progress notifications can be deterministic or nondeterministic. Each notification can contain steps to display more details.
Once the progress notification is created, you can add it with the add method in Shell.UI.Notifications.js.
Widgets
None.
Types
Shell.UI.Notifications.Progress(title, status, indeterminate)
Parameter |
Type |
Description |
|---|---|---|
title |
String |
The Progress title. |
status |
String |
The Progress status. |
indeterminate |
Boolean |
True if the Progress is determinate, otherwise False. If the Progress is not indeterminate, control progress with setValue(percentage). |
Shell.UI.Notifications.ProgressStep(title, status, index,parent)
Parameter |
Type |
Description |
|---|---|---|
title |
String |
The Progress Step title. |
status |
String |
The Progress Step status. |
index |
Number |
The position of the Progress Step in the Progress. |
parent |
Object |
The internal parent of the Progress Step. |
Properties
None.
Methods-Progress
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
Shell.UI.Notifications.Progress.addStep |
Adds a step to the current progress. |
index (Number): Index of the step, if not provided, adds at the end. title (String): Title of the progress step. status (String): Status of the progress step. |
|
Shell.UI.Notifications.Progress.removeAllSteps |
Removes all the steps from the current progress. |
Nothing |
None |
Shell.UI.Notifications.Progress.removeStep |
Removes a step from the current progress. |
Nothing |
progressStep (Shell.UI.Notifications.ProgressStep): The step. |
Shell.UI.Notifications.Progress.setActions |
Changes the action buttons available with the progress. |
Nothing |
actions (Array): Action array containing objects that have the following key:
|
Shell.UI.Notifications.Progress.setDetailsText |
Sets the details text. |
Nothing |
text (String): The text. |
Shell.UI.Notifications.Progress.setDetailsUrl |
Sets the details iframe url. |
None. |
url (String): The URL. |
Shell.UI.Notifications.Progress.setDismiss |
Sets a callback that is called when the progress operation is dismissed. |
Nothing |
callback (Function): The callback to be called. |
Shell.UI.Notifications.Progress.setDismissable |
Indicates the progress can be dismissed. |
Nothing |
dismissable (Boolean): True if it can be dismissed. |
Shell.UI.Notifications.Progress.setStatus |
Sets the status. |
Nothing |
status (String): The status. |
Shell.UI.Notifications.Progress.setTitle |
Sets the title. |
Nothing |
title (String): The title. |
Shell.UI.Notifications.Progress.setValue |
Updates deterministic progress (0-100). |
Nothing |
value (Number): Percent complete (0-100). |
Shell.UI.Notifications.Progress.sync |
Begins synchronization. |
Nothing |
None |
Shell.UI.Notifications.Progress.toJSON |
Converts supplied parameters to JSON. |
Object. Consists of a widgetOptions object and a an array of steps. WidgetOptions is an object with the following members: title: The title detailsText: Details text detailsUrl: The URL to the details. actions: An array of actions. Focus: the focus. |
a: First parameter. b: Second parameter. c: Third parameter. |
Methods – ProgressStep
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
Shell.UI.Notifications.ProgressStep.setTitle |
Sets the title for the Progress Step. |
Nothing |
title: The new Progress Step title. |
Shell.UI.Notifications.ProgressStep.setStatus |
Sets the status for the progress step. |
Nothing |
Status String: The new Progress Step status. |
Shell.UI.Notifications.ProgressStep.setDetailsText |
Sets the details text for the Progress Step. |
Nothing |
text String: The new Progress Step details text. |
Shell.UI.Notifications.ProgressStep.setDetailsUrl |
Sets the details iframe url. |
Nothing |
url (String): The URL. |
Shell.UI.Notifications.ProgressStep.toJSON |
Returns the Progress Step in JSON format. |
widgetOptions. An object with the following members: title: The title detailsText: Details text detailsUrl: The URL to the details. actions: An array of actions. Focus: the focus. |
None. |