# FileUploader

class

FileUploader class used to upload single file.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L21)

<a id="properties">

## Properties

<a id="member-file">

### `file: Blob` _(readonly)_

A file that is being uploaded.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L25)

<a id="member-xhr">

### `xhr?: XMLHttpRequest`

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L27)

<a id="member-_apiAddress">

### `_apiAddress: string` _(private)_

CKEditor Cloud Services API address.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L37)

<a id="member-_token">

### `_token: InitializedToken` _(private)_

CKEditor Cloud Services access token.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L32)

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( fileOrData, token, apiAddress )`

Creates `FileUploader` instance.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L46)

#### Parameters

* `fileOrData: string | Blob`

  A blob object or a data string encoded with Base64.

* `token: InitializedToken`

  Token used for authentication.

* `apiAddress: string`

  API address.

<a id="function-abort">

### `abort() → void`

Aborts upload process.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L107)

#### Returns

* `void`

<a id="function-delegate">

### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_

Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:

```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```

then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventX', data );
```

and `eventY` is delegated (fired by) `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventY', data );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L539)

#### Parameters

* `events: Array<string>`

  Event names that will be delegated to another emitter.

#### Returns

* `EmitterMixinDelegateChain`

<a id="function-fire">

### `fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]` _(inherited)_

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L512)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `eventOrInfo: GetNameOrEventInfo<TEvent>`

  The name of the event or `EventInfo` object if event is delegated.

* `args: TEvent[ 'args' ]`

  Additional arguments to be passed to the callbacks.

#### Returns

* `GetEventInfo<TEvent>[ 'return' ]`

  By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).

<a id="function-listenTo:BASE_EMITTER">

### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using `:`. When namespaced event is fired, it additionally fires all callbacks for that namespace.

```typescript
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```

An event callback can [stop the event](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L475)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `emitter: Emitter`

  The object that fires the event.

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-off">

### `off( event, callback ) → void` _(inherited)_

Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L444)

#### Parameters

* `event: string`

  The name of the event.

* `callback: Function`

  The function to stop being called.

#### Returns

* `void`

<a id="function-on">

### `on( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired.

Shorthand for [`this.listenTo( this, event, callback, options )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L416)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-onError">

### `onError( callback ) → this`

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L98)

#### Parameters

* `callback: ( error: string ) => void`

#### Returns

* `this`

<a id="function-onProgress">

### `onProgress( callback ) → this`

Registers callback on `progress` event.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L89)

#### Parameters

* `callback: ( status: object ) => void`

#### Returns

* `this`

<a id="function-once">

### `once( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling [`on`](#function-on) followed by [`off`](#function-off) in the callback.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L431)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-send">

### `send() → Promise<UploadResponse>`

Sends XHR request to API.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L114)

#### Returns

* `Promise<UploadResponse>`

<a id="function-stopDelegating">

### `stopDelegating( event?, emitter? ) → void` _(inherited)_

Stops delegating events. It can be used at different levels:

* To stop delegating all events.
* To stop delegating a specific event to all emitters.
* To stop delegating a specific event to a specific emitter.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L552)

#### Parameters

* `event?: string`

  The name of the event to stop delegating. If omitted, stops it all delegations.

* `emitter?: Emitter`

  (requires `event`) The object to stop delegating a particular event to. If omitted, stops delegation of `event` to all emitters.

#### Returns

* `void`

<a id="function-stopListening:BASE_STOP">

### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_

Stops listening for events. It can be used at different levels:

* To stop listening to a specific callback.
* To stop listening to a specific event.
* To stop listening to all events fired by a specific object.
* To stop listening to all events fired by all objects.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L497)

#### Parameters

* `emitter?: Emitter`

  The object to stop listening to. If omitted, stops it for all objects.

* `event?: string`

  (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it for all events from `emitter`.

* `callback?: Function`

  (Requires the `event`) The function to be removed from the call list for the given `event`.

#### Returns

* `void`

<a id="function-_attachXHRListeners">

### `_attachXHRListeners() → void` _(private)_

Attaches listeners to the XHR.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L137)

#### Returns

* `void`

<a id="function-_prepareRequest">

### `_prepareRequest() → void` _(private)_

Prepares XHR request.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L124)

#### Returns

* `void`

<a id="function-_sendRequest">

### `_sendRequest() → Promise<UploadResponse>` _(private)_

Sends XHR request.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L172)

#### Returns

* `Promise<UploadResponse>`

<a id="events">

## Events

<a id="event-error">

### `error( eventInfo, error )`

Fired when error occurs.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L217)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `error: string`

  Error message

<a id="event-progress">

### `progress( eventInfo, status )`

Fired on upload progress.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-cloud-services/src/uploadgateway/fileuploader.ts#L228)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `status: object`

  Total and uploaded status

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)