FileUploader (cloud-services/uploadgateway)
@ckeditor/ckeditor5-cloud-services/src/uploadgateway/fileuploader
FileUploader class used to upload single file.
Filtering
Properties
-
file : Blob
module:cloud-services/uploadgateway/fileuploader~FileUploader#file
A file that is being uploaded.
-
private
_apiAddress : String
module:cloud-services/uploadgateway/fileuploader~FileUploader#_apiAddress
CKEditor Cloud Services API address.
-
CKEditor Cloud Services access token.
Methods
-
constructor( fileOrData, token, apiAddress )
module:cloud-services/uploadgateway/fileuploader~FileUploader#constructor
Creates
FileUploader
instance.Parameters
fileOrData : Blob | String
A blob object or a data string encoded with Base64.
token : Token
Token used for authentication.
apiAddress : String
API address.
-
abort()
module:cloud-services/uploadgateway/fileuploader~FileUploader#abort
Aborts upload process.
-
onError( callback ) → FileUploader
module:cloud-services/uploadgateway/fileuploader~FileUploader#onError
Registers callback on
error
event. Event is called once when error occurs.Parameters
callback : function
Returns
-
onProgress( callback ) → FileUploader
module:cloud-services/uploadgateway/fileuploader~FileUploader#onProgress
-
send() → Promise.<Object>
module:cloud-services/uploadgateway/fileuploader~FileUploader#send
-
private
_attachXHRListeners()
module:cloud-services/uploadgateway/fileuploader~FileUploader#_attachXHRListeners
Attaches listeners to the XHR.
-
private
_prepareRequest()
module:cloud-services/uploadgateway/fileuploader~FileUploader#_prepareRequest
Prepares XHR request.
-
Sends XHR request.
Events
-
error( eventInfo, error )
module:cloud-services/uploadgateway/fileuploader~FileUploader#event:error
Fired when error occurs.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
error : String
Error message
-
progress( eventInfo, status )
module:cloud-services/uploadgateway/fileuploader~FileUploader#event:progress
Fired on upload progress.
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
status : Object
Total and uploaded status
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.