scheduledFile.progress Client Message

Client-side message raised when a script file execution scheduled via core_v2_widget.ScheduleFile() reports progress.

scheduledFile client messages are typically intended to be handled automatically by the scheduledfile UI component.

While scheduledFile client messages are pushed via socket to the initiating user, it is recommended to initiate monitoring of these messages via $.telligent.evolution.scheduledFile.monitor(progressKey) to ensure their receipt via automatic AJAX fallback requests if expected.

Usage

messaging.subscribe('scheduledFile.progress', function(data) {
    // handle the event
});

Data

progressKey: Identifier matching the ProgressKey passed to core_v2_widget.ScheduleFile()
percentComplete: Percent complete, if provided
message: Progress status message, if provided

Recommended