scheduledFile.complete Client Message

Ben Tiedt — Fri, 15 Jan 2021 20:23:36 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:23:36

scheduledFile.complete Client Message

[[messaging JavaScript API Module|Client-side message]] raised when a script file execution scheduled via core_v2_widget.ScheduleFile() completes.

scheduledFile client messages are typically intended to be handled automatically by the [[scheduledfile UI Component|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.complete', function(data) {
    // handle the event
});

Data

progressKey: Identifier matching the ProgressKey passed to core_v2_widget.ScheduleFile()
percentComplete: Percent complete
result: Completion result. Either a string or deserialized JSON object.