nsIMsgShutdownTask
| IID: | D1B43428-B631-4629-B691-AB0E01A2DB4B |
| Inherits From: | nsISupports |
Properties
readonly PRBool needsToRunTask
Inform the caller wheter or not the task needs to be run. This method gives the task the flexibility to cancel running a task on shutdown if nothing needs to be run.
Methods
PRBool doShutdownTask ( nsIUrlListener inUrlListener , nsIMsgWindow inMsgWindow )
AString getCurrentTaskName ( )
PRBool doShutdownTask ( nsIUrlListener inUrlListener , nsIMsgWindow inMsgWindow )
At shutdown-time, this function will be called to all registered implementors. Shutdown will be temporarily postponed until OnStopRequest() has been called on the passed in url-listener.
- Arguments:
- inUrlListener: The URL listener to report events to.
- inMsgWindow: The current message window to allow for posing dialogs.
- Returns:
- If the shutdown URL was run or not. If the URL is running, the task will be responsible for notifying |inUrlListener| when the task is completed.
AString getCurrentTaskName ( )
Get the displayable name of the current task. This textual information will be shown to the user so they know what shutdown task is being performed.
- Returns:
- The name of the current task being performed.
Reference documentation is generated from Mozilla's source.