CommentsRepository

class

Stores the list of CommentThread and provides event-driven API for managing them. It is also responsible for using the comments adapter to communicate with the data source.

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

Sample usage:

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

Properties

Methods

constructor( context )

Parameters
context : Editor | Context
addCommentThread( data ) → undefined | CommentThread
module:comments/comments/commentsrepository~CommentsRepository#addCommentThread
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 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:
```
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
} );
```
Copy code
See also setAttribute and removeAttribute.
Parameters
data : Partial<AddCommentThreadEventData>
The data of the comment thread to add.

Defaults to ...
Returns
undefined | CommentThread
The added comment thread.
Fires
- addCommentThread
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:comments/comments/commentsrepository~CommentsRepository#bind:MANY_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated 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:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
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.
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, CommentsRepository[ K1 ], K2, CommentsRepository[ K2 ]>
inherited
module:comments/comments/commentsrepository~CommentsRepository#bind:DUAL_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated 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:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
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.
bind( bindProperty ) → ObservableSingleBindChain<K, CommentsRepository[ K ]>
inherited
module:comments/comments/commentsrepository~CommentsRepository#bind:SINGLE_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated 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:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
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.
createCommentThreadController( commentThreadModel, commentThreadView ) → CommentThreadController

Create an instance of the CommentThreadController class.
Parameters
commentThreadModel : CommentThread
Comment thread model.
commentThreadView : BaseCommentThreadView
Comment thread view.
Returns
CommentThreadController
decorate( methodName ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#decorate
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 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:
```
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.
```
Copy code
Note: The high priority 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:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Copy code
Finally, it is possible to access and modify the arguments the method is called with:
```
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'
```
Copy code
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
delegate( events ) → EmitterMixinDelegateChain
inherited
module:comments/comments/commentsrepository~CommentsRepository#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
destroy() → void
inherited

Destroys the plugin.
Note: This method is optional. A plugin instance does not need to have it defined.
Returns
void
fetchCommentThread( __namedParameters ) → Promise<undefined | CommentThread>

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<undefined | CommentThread>
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 object, followed by the optional args provided in the fire() method call.
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
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's property (the event info is the first param of every callback).
getAnnotationForCommentThread( thread ) → null | Annotation

Returns the annotation associated with the given comment thread.
Parameters
thread : CommentThread
Returns
null | Annotation
getCommentThread( threadId ) → undefined | CommentThread

Returns comment thread of given id.
Parameters
threadId : string
Returns
undefined | CommentThread
getCommentThreadForAnnotation( annotation ) → null | CommentThread

Returns the comment thread associated with the given annotation.
Parameters
annotation : Annotation
Returns
null | CommentThread
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>
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>
getPermissions( channelId ) → CommentPermissionsConfig

Gets permissions set for repository (or default if permissions was not set).
Parameters
channelId : string | symbol
Defaults to noChannel
Returns
CommentPermissionsConfig
hasCommentThread( threadId ) → boolean

Checks if a comment thread with a given ID is added to the repository.
Parameters
threadId : string
Returns
boolean
init() → void

Returns
void
isReadOnly( channelId ) → boolean

Returns true if a given channel is set to read-only mode, returns false otherwise.
Parameters
channelId : string | symbol
Returns
boolean
listenTo( emitter, event, callback, [ options ] ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#listenTo:BASE_EMITTER
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.
```
// 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' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
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
off( event, callback ) → void
inherited

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).
Parameters
event : string
The name of the event.
callback : Function
The function to stop being called.
Returns
void
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 ) (it makes the emitter listen on itself).
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
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
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 followed by off in the callback.
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
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
openNewCommentThread( commentThreadData ) → null | CommentThread
module:comments/comments/commentsrepository~CommentsRepository#openNewCommentThread
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
null | CommentThread
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
set( values ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#set:OBJECT
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:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Copy code
Parameters
values : object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#set:KEY_VALUE
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:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Copy code
Type parameters
K
Parameters
name : K
The property's name.
value : CommentsRepository[ K ]
The property's value.
Returns
void
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 : null | string
Returns
void
stopDelegating( [ event ], [ emitter ] ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#stopDelegating
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
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#stopListening:BASE_STOP
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
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
unbind( unbindProperties ) → void
inherited
module:comments/comments/commentsrepository~CommentsRepository#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
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
updateCommentThread( data ) → CommentThread
module:comments/comments/commentsrepository~CommentsRepository#updateCommentThread
Updates an existing comment thread. See also setAttribute and removeAttribute.
Parameters
data : UpdateCommentThreadEventData
The data of the comment thread to add.
Returns
CommentThread
The updated comment thread.
Fires
- updateCommentThread

Events

addComment( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:addComment
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
```
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `addComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : CommentEventData
addCommentThread( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:addCommentThread
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.
```
const channelId = 'foo';

commentsRepository.on( `addCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : Required<AddCommentThreadEventData>
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<undefined | string | symbol>
New value of the _readOnlyChannels property with given key or null, if operation should remove property.
oldValue : Set<undefined | string | symbol>
Old value of the _readOnlyChannels property with given key or null, if property was not set before.
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 : null | CommentThread
New value of the activeCommentThread property with given key or null, if operation should remove property.
oldValue : null | CommentThread
Old value of the activeCommentThread property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited
module:comments/comments/commentsrepository~CommentsRepository#event:change:{property}
Fired when a property changed value.
```
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'
```
Copy code
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.
removeComment( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:removeComment
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
```
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `removeComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : BaseComment
removeCommentThread( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:removeCommentThread
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.
```
const channelId = 'foo';

commentsRepository.on( `removeCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : BaseCommentThread
reopenCommentThread( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:reopenCommentThread
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.
```
const channelId = 'foo';

commentsRepository.on( `reopenCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : BaseCommentThread
resolveCommentThread( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:resolveCommentThread
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.
```
const channelId = 'foo';

commentsRepository.on( `resolveCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : ResolveCommentThreadEventData
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<undefined | string | symbol>
New value of the _readOnlyChannels property with given key or null, if operation should remove property.
oldValue : Set<undefined | string | symbol>
Old value of the _readOnlyChannels property with given key or null, if property was not set before.
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 : null | CommentThread
New value of the activeCommentThread property with given key or null, if operation should remove property.
oldValue : null | CommentThread
Old value of the activeCommentThread property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited
module:comments/comments/commentsrepository~CommentsRepository#event:set:{property}
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.
```
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'
```
Copy code
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.
submitCommentThread( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:submitCommentThread
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.
```
const channelId = 'foo';

commentsRepository.on( `submitCommentThread:${ channelId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : BaseCommentThread
updateComment( eventInfo, <anonymous> )
module:comments/comments/commentsrepository~CommentsRepository#event:updateComment
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
```
const channelId = 'foo';
const threadId = '1234';

commentsRepository.on( `updateComment:${ channelId }:${ threadId }`, ( evt, data ) => {
	console.log( evt, data );
} );
```
Copy code
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : UpdateCommentEventData
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

CommentsRepository

Properties

activeCommentThread : null | CommentThread Eye iconobservable

adapter : CommentsAdapter

Parameters

context : ContextInterfacereadonlyinherited

Static properties

isContextPlugin : truereadonlyinheritedstatic

isOfficialPlugin : truereadonlystatic

isPremiumPlugin : truereadonlystatic

pluginName : 'CommentsRepository'readonlystatic

requires : readonly tuplereadonlystatic

Methods

constructor( context )

Parameters

addCommentThread( data ) → undefined | CommentThread

Parameters

Returns

Fires

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

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

Type parameters

Parameters

Returns

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

Type parameters

Parameters

Returns

createCommentThreadController( commentThreadModel, commentThreadView ) → CommentThreadController

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → voidinherited

Returns

fetchCommentThread( __namedParameters ) → Promise<undefined | CommentThread>

Parameters

Returns

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

Type parameters

Parameters

Returns

getAnnotationForCommentThread( thread ) → null | Annotation

Parameters

Returns

getCommentThread( threadId ) → undefined | CommentThread

Parameters

Returns

getCommentThreadForAnnotation( annotation ) → null | CommentThread

Parameters

Returns

getCommentThreads( data = { [data.channelId], [data.skipEmpty], [data.skipNotAttached], data.toJSON } ) → Array<CommentThreadDataJSON>

Parameters

Returns

getCommentThreads( [ data ] = { [data.channelId], [data.skipEmpty], [data.skipNotAttached], [data.toJSON] } ) → Array<CommentThread>

Parameters

Returns

getPermissions( channelId ) → CommentPermissionsConfig

Parameters

Returns

hasCommentThread( threadId ) → boolean

Parameters

Returns

init() → void

Returns

isReadOnly( channelId ) → boolean

Parameters

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

off( event, callback ) → voidinherited

Parameters

`activeCommentThread : null | CommentThread`
observable

`adapter : CommentsAdapter`

`context : ContextInterface`
readonlyinherited

`isContextPlugin : true`
readonlyinheritedstatic

`isOfficialPlugin : true`
readonlystatic

`isPremiumPlugin : true`
readonlystatic

`pluginName : 'CommentsRepository'`
readonlystatic

`requires : readonly tuple`
readonlystatic

`constructor( context )`

`addCommentThread( data ) → undefined | CommentThread`

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

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

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

`createCommentThreadController( commentThreadModel, commentThreadView ) → CommentThreadController`

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`
inherited

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

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

`getAnnotationForCommentThread( thread ) → null | Annotation`

`getCommentThread( threadId ) → undefined | CommentThread`

`getCommentThreadForAnnotation( annotation ) → null | CommentThread`

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

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

`getPermissions( channelId ) → CommentPermissionsConfig`

`hasCommentThread( threadId ) → boolean`

`init() → void`

`isReadOnly( channelId ) → boolean`

`listenTo( emitter, event, callback, [ options ] ) → void`
inherited

`off( event, callback ) → void`
inherited

`on( event, callback, [ options ] ) → void`
inherited

`once( event, callback, [ options ] ) → void`
inherited

`openNewCommentThread( commentThreadData ) → null | CommentThread`

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`setActiveCommentThread( threadId ) → void`

`stopDelegating( [ event ], [ emitter ] ) → void`
inherited

`stopListening( [ emitter ], [ event ], [ callback ] ) → void`
inherited

`switchReadOnly( value, [ channelId ] ) → void`

`unbind( unbindProperties ) → void`
inherited

`updateCommentThread( data ) → CommentThread`

`addComment( eventInfo, <anonymous> )`

`addCommentThread( eventInfo, <anonymous> )`

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

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

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

`removeComment( eventInfo, <anonymous> )`

`removeCommentThread( eventInfo, <anonymous> )`

`reopenCommentThread( eventInfo, <anonymous> )`

`resolveCommentThread( eventInfo, <anonymous> )`

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

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

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

`submitCommentThread( eventInfo, <anonymous> )`

`updateComment( eventInfo, <anonymous> )`

`updateCommentThread( eventInfo, <anonymous> )`