ssCore.FileSys.setNotify

Tell SWF Studio about a FileSys event that you'd like to receive notifications for.


Availability:

First available in version 3.5 build 314.


Input Parameters:

event - The name of the event you want notification enabled for. Valid values include: onCopyProgress.


Output Parameters:

result - Notification data for the specified event (see description of events for more detail).


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FileSys.setNotify( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FileSys.setNotify( paramsObject );


Notes:

None.


Events:

name - onCopyProgress
type - triggered
result - "bytes_copied"

During an FileSys.copyFileAsync, the plugin sends the number of bytes copied. The frequency of these notifications is a factor of the specified buffer size, as set in chunkSize parameter.

ssCore.FileSys.setNotify({event:"onCopyProgress"}, {callback:onCopyProgress});

function onCopyProgress(ret_obj, cb_obj, err_obj)
{
    if (ret_obj.success)
    {
        ssDebug.trace("value: " + ret_obj.result);
    }
}