CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Class

FileUploader (cloud-services/uploadgateway)

@ckeditor/ckeditor5-cloud-services/src/uploadgateway/fileuploader

class
See source

FileUploader class used to upload single file.

Filtering

Properties

  • file : Blob

    A file that is being uploaded.

    See source

  • _apiAddress : String

    private

    CKEditor Cloud Services API address.

    See source

  • _token : Token

    private

    CKEditor Cloud Services access token.

    See source

Methods

  • constructor( fileOrData, token, apiAddress )

    Creates FileUploader instance.

    See source

    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()

    Aborts upload process.

    See source

  • onError( callback ) → FileUploader

    Registers callback on error event. Event is called once when error occurs.

    See source

    Parameters

    callback : function

    Returns

    FileUploader

  • onProgress( callback ) → FileUploader

    Registers callback on progress event.

    See source

    Parameters

    callback : function

    Returns

    FileUploader

  • send() → Promise.<Object>

    Sends XHR request to API.

    See source

    Returns

    Promise.<Object>

  • _attachXHRListeners()

    private

    Attaches listeners to the XHR.

    See source

  • _prepareRequest()

    private

    Prepares XHR request.

    See source

  • _sendRequest()

    private

    Sends XHR request.

    See source

Events

  • error( eventInfo, error )

    Fired when error occurs.

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    error : String

    Error message

  • progress( eventInfo, status )

    Fired on upload progress.

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    status : Object

    Total and uploaded status