# CommentsRepository

class

Stores the list of [`CommentThread`](module_comments_comments_commentsrepository-CommentThread.md) and provides event-driven API for managing them. It is also responsible for using the comments adapter to communicate with the data source.

[`CommentsRepository`](module_comments_comments_commentsrepository-CommentsRepository.md) is a context plugin. It can be added to a context or to an editor. Add it to the context configuration if you use [`Context`](module_core_context-Context.md) in your integration.

The event-driven API makes it possible to attach a listener to each action that changes comment data. Using different event priorities allows to attach an action before the main action ('low' priority) or after the main action ('high' priority). It works very similar to [`decorate`](module_utils_observablemixin-Observable.md#function-decorate).

Sample usage:

```typescript
// Get the comments repository:
const commentsRepository = editor.plugins.get( 'CommentsRepository' );

// Create a new, empty comment thread on a DOM form field element:
commentsRepository.openNewCommentThread( { channelId, target: formFieldElement } );

// Get all comment threads:
commentsRepository.getCommentThreads();

// Set the adapter:
commentsRepository.adapter = {
	// ...
};
```

For more information about the comments adapter see [`CommentsAdapter`](module_comments_comments_commentsrepository-CommentsAdapter.md).

<a id="properties">

## Properties

<a id="member-activeCommentThread">

### `activeCommentThread: CommentThread | null` _(observable)_

The currently active comment thread. An annotation with this thread will be marked as active.

<a id="member-adapter">

### `adapter: CommentsAdapter`

#### Parameters

* `adapter: CommentsAdapter`

<a id="member-context">

### `context: ContextInterface` _(readonly)_

The context or editor instance.

#### Static properties

<a id="static-member-isContextPlugin">

### `isContextPlugin: true` _(readonly)_

<a id="static-member-isOfficialPlugin">

### `isOfficialPlugin: true` _(readonly)_

<a id="static-member-isPremiumPlugin">

### `isPremiumPlugin: true` _(readonly)_

<a id="static-member-pluginName">

### `pluginName: 'CommentsRepository'` _(readonly)_

<a id="static-member-requires">

### `requires: readonly [ PluginConstructor<Editor> & new ( context: Editor ) => Annotations, PluginConstructor<Editor> & new ( context: Editor ) => PendingActions, PluginConstructor<Editor> & new ( context: Editor ) => Users ]` _(readonly)_

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( context )`

#### Parameters

* `context: Editor | Context`

<a id="function-addCommentThread">

### `addCommentThread( data ) → CommentThread | undefined`

Adds a new comment thread.

When a target is provided, the comment annotation will be attached to this target.

Use this method to load the comments data during the editor initialization if you do not use the adapter integration.

**Note:** This method fires the [event-addCommentThread](#event-addCommentThread) event and the default behavior is added as a `'normal'` priority listener. It makes it possible to cancel the method or call some custom code before or after the default behavior is executed.

**Note:** The comments adapter will send the data only if `commentThreadData.comments` is not empty and `commentThreadData.isFromAdapter` is set to `false`.

See also `CommentsRepository#openNewCommentThread()`.

An example of loading a comment thread on editor initialization:

```typescript
commentsRepository.addCommentThread( {
	threadId: 'thread-id',
	channelId: 'channel-id',
	comments: [
		{
			commentId: 'comment-1',	  // String
			authorId: 'author-id',	   // String
			content: 'First comment',	// String
			createdAt: new Date( ... )   // Date instance
		},
		// ...
	],
	target: () => ...,
	// Added during initialization, so do not call the adapter:
	isFromAdapter: true
} );
```

See also [`setAttribute`](module_comments_comments_commentsrepository-CommentThread.md#function-setAttribute) and [`removeAttribute`](module_comments_comments_commentsrepository-CommentThread.md#function-removeAttribute).

#### Parameters

* `data: Partial<Omit<AddCommentThreadEventData, 'target'>> & object`

  The data of the comment thread to add.

  Defaults to `{}`

#### Returns

* `CommentThread | undefined`

  The added comment thread.

#### Fires

* [addCommentThread](#event-addCommentThread)

<a id="function-bind:MANY_BIND">

### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

#### Parameters

* `bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'setPermissions' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'getAnnotationForCommentThread' | 'getCommentThreadForAnnotation' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'getPermissions' | '_attachCommentThread' | '_bindAnnotationToEditors' | '_unbindEditors' | '_removeCommentThread' | '_detachCommentThread' | '_updateComment' | '_removeComment'>`

  Observable properties that will be bound to other observable(s).

#### Returns

* `ObservableMultiBindChain`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:DUAL_BIND">

### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, CommentsRepository[ K1 ], K2, CommentsRepository[ K2 ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

#### Type parameters

* * `K1`
  * `K2`

#### Parameters

* `bindProperty1: K1`

  Observable property that will be bound to other observable(s).

* `bindProperty2: K2`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableDualBindChain<K1, CommentsRepository[ K1 ], K2, CommentsRepository[ K2 ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:SINGLE_BIND">

### `bind( bindProperty ) → ObservableSingleBindChain<K, CommentsRepository[ K ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

#### Type parameters

* `K`

#### Parameters

* `bindProperty: K`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableSingleBindChain<K, CommentsRepository[ K ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-createCommentThreadController">

### `createCommentThreadController( commentThreadModel, commentThreadView ) → CommentThreadController`

Create an instance of the [`CommentThreadController`](module_comments_comments_ui_commentthreadcontroller-CommentThreadController.md) class.

#### Parameters

* `commentThreadModel: CommentThread`

  Comment thread model.

* `commentThreadView: BaseCommentThreadView`

  Comment thread view.

#### Returns

* `CommentThreadController`

<a id="function-decorate">

### `decorate( methodName ) → void` _(inherited)_

Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the [dedicated](../framework/deep-dive/observables.md#decorating-object-methods) guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be [stopped](module_utils_eventinfo-EventInfo.md#member-stop):

```typescript
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```

**Note**: The high [priority](module_utils_priorities-PriorityString.md) listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:

```typescript
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```

Finally, it is possible to access and modify the arguments the method is called with:

```typescript
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```

#### Parameters

* `methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'setPermissions' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'getAnnotationForCommentThread' | 'getCommentThreadForAnnotation' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'getPermissions' | '_attachCommentThread' | '_bindAnnotationToEditors' | '_unbindEditors' | '_removeCommentThread' | '_detachCommentThread' | '_updateComment' | '_removeComment'`

  Name of the method to decorate.

#### 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 );
```

#### Parameters

* `events: Array<string>`

  Event names that will be delegated to another emitter.

#### Returns

* `EmitterMixinDelegateChain`

<a id="function-destroy">

### `destroy() → void` _(inherited)_

Destroys the plugin.

**Note:** This method is optional. A plugin instance does not need to have it defined.

#### Returns

* `void`

<a id="function-fetchCommentThread">

### `fetchCommentThread( __namedParameters ) → Promise<CommentThread | undefined>`

Gets the comment thread data using the adapter and adds the thread to the editor.

When the comment thread is already present in the repository, then the adapter will not be used but the result will be asynchronous as well.

#### Parameters

* `__namedParameters: BaseCommentThread`

  Defaults to `...`

#### Returns

* `Promise<CommentThread | undefined>`

<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.

#### 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-getAnnotationForCommentThread">

### `getAnnotationForCommentThread( thread ) → Annotation | null`

Returns the annotation associated with the given comment thread.

#### Parameters

* `thread: CommentThread`

#### Returns

* `Annotation | null`

<a id="function-getCommentThread">

### `getCommentThread( threadId ) → CommentThread | undefined`

Returns comment thread of given id.

#### Parameters

* `threadId: string`

#### Returns

* `CommentThread | undefined`

<a id="function-getCommentThreadForAnnotation">

### `getCommentThreadForAnnotation( annotation ) → CommentThread | null`

Returns the comment thread associated with the given annotation.

#### Parameters

* `annotation: Annotation`

#### Returns

* `CommentThread | null`

<a id="function-getCommentThreads">

### `getCommentThreads( data = { data.channelId?, data.skipEmpty?, data.skipNotAttached?, data.toJSON } ) → Array<CommentThreadDataJSON>`

#### Parameters

* `data: object`

  Properties

  * `data.channelId?: string | symbol`
  * `data.skipEmpty?: boolean`
  * `data.skipNotAttached?: boolean`
  * `data.toJSON: true`

#### Returns

* `Array<CommentThreadDataJSON>`

<a id="function-getCommentThreads">

### `getCommentThreads( data? = { data.channelId?, data.skipEmpty?, data.skipNotAttached?, data.toJSON? } ) → Array<CommentThread>`

#### Parameters

* `data?: object`

  Properties

  * `data.channelId?: string | symbol`
  * `data.skipEmpty?: boolean`
  * `data.skipNotAttached?: boolean`
  * `data.toJSON?: false`

#### Returns

* `Array<CommentThread>`

<a id="function-getPermissions">

### `getPermissions( channelId ) → CommentPermissionsConfig`

Gets permissions set for repository (or default if permissions was not set).

#### Parameters

* `channelId: string | symbol`

  Defaults to `noChannel`

#### Returns

* `CommentPermissionsConfig`

<a id="function-hasCommentThread">

### `hasCommentThread( threadId ) → boolean`

Checks if a comment thread with a given ID is added to the repository.

#### Parameters

* `threadId: string`

#### Returns

* `boolean`

<a id="function-init">

### `init() → void`

#### Returns

* `void`

<a id="function-isReadOnly">

### `isReadOnly( channelId ) → boolean`

Returns `true` if a given channel is set to read-only mode, returns `false` otherwise.

#### Parameters

* `channelId: string | symbol`

#### Returns

* `boolean`

<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.

#### 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).

#### 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).

#### 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-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.

#### 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-openNewCommentThread">

### `openNewCommentThread( commentThreadData ) → CommentThread | null`

Creates a new, empty comment thread.

Displays a new comment annotation attached to the target and focuses the comment editor. When the comment data is submitted, the comment thread is added to the editor and sent to the adapter.

Use this method to start a new comment thread after a user performed an action (clicked a button, etc.).

#### Parameters

* `commentThreadData: AddCommentThreadEventData`

  The data of the comment thread to add.

#### Returns

* `CommentThread | null`

  The created comment thread or `null` if there was a problem creating the thread (for example, if the comments repository was in the read-only mode).

#### Fires

* [addCommentThread](#event-addCommentThread)

<a id="function-set:OBJECT">

### `set( values ) → void` _(inherited)_

Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```

#### Parameters

* `values: object & object`

  An object with `name=>value` pairs.

#### Returns

* `void`

<a id="function-set:KEY_VALUE">

### `set( name, value ) → void` _(inherited)_

Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```

#### Type parameters

* `K`

#### Parameters

* `name: K`

  The property's name.

* `value: CommentsRepository[ K ]`

  The property's value.

#### Returns

* `void`

<a id="function-setActiveCommentThread">

### `setActiveCommentThread( threadId ) → void`

Marks a comment thread with the given ID as active. When `threadId` is `null`, the currently active comment thread will be deactivated.

#### Parameters

* `threadId: string | null`

#### Returns

* `void`

<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.

#### 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.

#### 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-switchReadOnly">

### `switchReadOnly( value, channelId? ) → void`

Changes the read-only state for comment threads.

When the value is `true` then all comment threads will be switched to read-only, when the value is `false` then all comment threads will be switched to editing mode.

Optionally new state can be applied to a comment threads limited to a given channel. This function has precedence over any permission settings.

#### Parameters

* `value: boolean`
* `channelId?: string | symbol`

#### Returns

* `void`

<a id="function-unbind">

### `unbind( unbindProperties ) → void` _(inherited)_

Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).

```typescript
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```

#### Parameters

* `unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'setPermissions' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'getAnnotationForCommentThread' | 'getCommentThreadForAnnotation' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'getPermissions' | '_attachCommentThread' | '_bindAnnotationToEditors' | '_unbindEditors' | '_removeCommentThread' | '_detachCommentThread' | '_updateComment' | '_removeComment'>`

  Observable properties to be unbound. All the bindings will be released if no properties are provided.

#### Returns

* `void`

<a id="function-updateCommentThread">

### `updateCommentThread( data ) → CommentThread`

Updates an existing comment thread. See also [`setAttribute`](module_comments_comments_commentsrepository-CommentThread.md#function-setAttribute) and [`removeAttribute`](module_comments_comments_commentsrepository-CommentThread.md#function-removeAttribute).

#### Parameters

* `data: UpdateCommentThreadEventData`

  The data of the comment thread to add.

#### Returns

* `CommentThread`

  The updated comment thread.

#### Fires

* [updateCommentThread](#event-updateCommentThread)

<a id="events">

## Events

<a id="event-addComment">

### `addComment( eventInfo, <anonymous> )`

Fired whenever a comment is added.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

It is also possible to listen to events from the given thread ID by appending `:[threadId]` part to the event name

```typescript
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `addComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: CommentEventData`

<a id="event-addCommentThread">

### `addCommentThread( eventInfo, <anonymous> )`

Fired whenever a comment thread is added to the comments repository.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

```typescript
const channelId = 'foo';

commentsRepository.on( `addCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: Required<AddCommentThreadEventData>`

<a id="event-change:_readOnlyChannels">

### `change:_readOnlyChannels( eventInfo, name, value, oldValue )`

Fired when the `_readOnlyChannels` property changed value.

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`_readOnlyChannels`).

* `value: Set<string | symbol | undefined>`

  New value of the `_readOnlyChannels` property with given key or `null`, if operation should remove property.

* `oldValue: Set<string | symbol | undefined>`

  Old value of the `_readOnlyChannels` property with given key or `null`, if property was not set before.

<a id="event-change:activeCommentThread">

### `change:activeCommentThread( eventInfo, name, value, oldValue )`

Fired when the `activeCommentThread` property changed value.

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`activeCommentThread`).

* `value: CommentThread | null`

  New value of the `activeCommentThread` property with given key or `null`, if operation should remove property.

* `oldValue: CommentThread | null`

  Old value of the `activeCommentThread` property with given key or `null`, if property was not set before.

<a id="event-change:%7Bproperty%7D">

### `change:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property changed value.

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

<a id="event-removeComment">

### `removeComment( eventInfo, <anonymous> )`

Fired whenever a comment is removed.

The event name includes `channelId` so it is possible to listen only to changes happening in the specified channel.

It is also possible to listen to events from the given thread ID by appending `:[threadId]` part to the event name

```typescript
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `removeComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: BaseComment`

<a id="event-removeCommentThread">

### `removeCommentThread( eventInfo, <anonymous> )`

Fired whenever a comment thread is removed from the comments repository.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

```typescript
const channelId = 'foo';

commentsRepository.on( `removeCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: BaseCommentThread`

<a id="event-reopenCommentThread">

### `reopenCommentThread( eventInfo, <anonymous> )`

Fired whenever a comment thread is reopened.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

```typescript
const channelId = 'foo';

commentsRepository.on( `reopenCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: BaseCommentThread`

<a id="event-resolveCommentThread">

### `resolveCommentThread( eventInfo, <anonymous> )`

Fired whenever a comment thread is resolved.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

```typescript
const channelId = 'foo';

commentsRepository.on( `resolveCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: ResolveCommentThreadEventData`

<a id="event-set:_readOnlyChannels">

### `set:_readOnlyChannels( eventInfo, name, value, oldValue )`

Fired when the `_readOnlyChannels` property is going to be set but is not set yet (before the `change` event is fired).

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`_readOnlyChannels`).

* `value: Set<string | symbol | undefined>`

  New value of the `_readOnlyChannels` property with given key or `null`, if operation should remove property.

* `oldValue: Set<string | symbol | undefined>`

  Old value of the `_readOnlyChannels` property with given key or `null`, if property was not set before.

<a id="event-set:activeCommentThread">

### `set:activeCommentThread( eventInfo, name, value, oldValue )`

Fired when the `activeCommentThread` property is going to be set but is not set yet (before the `change` event is fired).

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`activeCommentThread`).

* `value: CommentThread | null`

  New value of the `activeCommentThread` property with given key or `null`, if operation should remove property.

* `oldValue: CommentThread | null`

  Old value of the `activeCommentThread` property with given key or `null`, if property was not set before.

<a id="event-set:%7Bproperty%7D">

### `set:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property value is going to be set but is not set yet (before the `change` event is fired).

You can control the final value of the property by using the [event's `return` property](module_utils_eventinfo-EventInfo.md#member-return).

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
					 // -> 'Current property value is 1'
					 // -> 'Value has changed from 1 to 3'
```

**Note:** The event is fired even when the new value is the same as the old value.

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

<a id="event-submitCommentThread">

### `submitCommentThread( eventInfo, <anonymous> )`

Fired whenever a new comment thread is submitted and occurs after creating the first comment.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

```typescript
const channelId = 'foo';

commentsRepository.on( `submitCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: BaseCommentThread`

<a id="event-updateComment">

### `updateComment( eventInfo, <anonymous> )`

Fired whenever a comment is updated.

The event name includes `channelId` so it is possible to listen only to changes happening in the specified channel.

It is also possible to listen to events from the given thread ID by appending `:[threadId]` part to the event name

```typescript
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `updateComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: UpdateCommentEventData`

<a id="event-updateCommentThread">

### `updateCommentThread( eventInfo, <anonymous> )`

Fired whenever a comment thread is updated in comments repository.

The event name includes `channelId` so it is possible to listen only on changes happening in the specified channel.

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: UpdateCommentThreadEventData`

---

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