Home/CKEditor 5/API

CommentThread (comments/comments)

@ckeditor/ckeditor5-comments/src/comments/commentsrepository

class

Comment thread representation. Stores a list of Comments.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

observable
archivedAt : null | Date

Date when the comment thread has been archived.

Comment threads become archived after they are resolved or unlinked. If the comment thread is resolved and/or unlinked, this value is set to the earliest of the dates. Otherwise, it is null.
observable
attributes : Record<string, unknown>

Custom comment thread attributes. See also setAttribute and removeAttribute.
observable
canComment : boolean

Informs if a user has permission to add a new comment to the comment thread.
channelId : string | symbol

The channel where the comment thread was created.
readonly
comments : Collection<Comment>

A collection of Comments belonging to this thread.
id : string

The comment thread ID.
readonly
isAttached : boolean

Informs if the comment thread is attached to any target at the moment.
observable
isReadOnly : boolean

Informs if the comment thread is in read-only state (true) or not (false).
observable
isRemovable : boolean

Informs if the comment thread can be removed by the local user.
readonly observable
isResolved : boolean

Informs if the comment thread is resolved.
readonly
isSubmitted : boolean

Informs if the comment thread has been submitted.
readonly
length : number

The number of comments in the comment thread.
observable
resolvedAt : null | Date

Date when the comment thread has been resolved.
observable
resolvedBy : null | User

User id which resolved the comment thread.
observable
unlinkedAt : null | Date

The date when the content related to the comment thread was lost (usually, the commented content was removed from the document).
readonly
weight : number

Sum of weights of all comments in this thread.

Methods

constructor( commentsRepository, data = { data.attributes, data.channelId, data.context, data.id, data.isResolvable, data.isSubmitted, data.resolvedAt, data.resolvedBy, data.unlinkedAt } )

Parameters

commentsRepository : CommentsRepository

data : object

Properties

data.attributes : Record<string, unknown>

data.channelId : string | symbol

data.context : CommentThreadContext

data.id : string

data.isResolvable : boolean

data.isSubmitted : boolean

data.resolvedAt : null | Date

data.resolvedBy : null | User

data.unlinkedAt : null | Date
addComment( data ) → void
Creates a new comment inside the comment thread.

Note This method is event-driven. It means it fires an event then a normal priority listener catches it and executes an action. It makes it possible to add some actions before and after method will be executed.

Parameters

data : CommentData

Data object.

Returns

void

Fires
- addComment
attachTo( target ) → Annotation

Creates comment annotations and displays it attached to the given target.

Parameters

target : AnnotationTarget

Returns

Annotation

Created annotation.
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CommentThread[ K1 ], K2, CommentThread[ K2 ]>
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' );
```
or even shorter:
```
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.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
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:
```
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:
```
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:
```
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

DualBindChain<K1, CommentThread[ K1 ], K2, CommentThread[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
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' );
```
or even shorter:
```
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.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
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:
```
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:
```
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:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Parameters

bindProperties : Array<'length' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'submit' | 'id' | 'remove' | 'attributes' | 'isReadOnly' | 'isAttached' | '_remove' | 'toJSON' | 'removeAttribute' | 'context' | '_isAttached' | 'attachTo' | 'comments' | 'setAttribute' | 'channelId' | 'isRemovable' | 'resolvedAt' | 'weight' | 'addComment' | 'canComment' | 'archivedAt' | 'unlinkedAt' | 'resolvedBy' | 'isResolved' | 'isResolvable' | '_hasTargetInContent' | '_isSubmitted' | 'isSubmitted' | 'setUnlinkedAt' | 'resolve' | 'reopen' | 'setContext' | 'getComment' | '_add' | '_update' | '_findOptimalIndex'>

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

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, CommentThread[ K ]>
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' );
```
or even shorter:
```
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.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
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:
```
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:
```
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:
```
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

SingleBindChain<K, CommentThread[ K ]>

The bind chain with the to() and toMany() methods.
inherited
decorate( methodName ) → void
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.
```
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'
```
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'
```
Parameters

methodName : 'length' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'submit' | 'id' | 'remove' | 'attributes' | 'isReadOnly' | 'isAttached' | '_remove' | 'toJSON' | 'removeAttribute' | 'context' | '_isAttached' | 'attachTo' | 'comments' | 'setAttribute' | 'channelId' | 'isRemovable' | 'resolvedAt' | 'weight' | 'addComment' | 'canComment' | 'archivedAt' | 'unlinkedAt' | 'resolvedBy' | 'isResolved' | 'isResolvable' | '_hasTargetInContent' | '_isSubmitted' | 'isSubmitted' | 'setUnlinkedAt' | 'resolve' | 'reopen' | 'setContext' | 'getComment' | '_add' | '_update' | '_findOptimalIndex'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

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

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).
getComment( commentId ) → null | Comment

Returns comment of given id.

Parameters

commentId : string

Returns

null | Comment
inherited
listenTo( emitter, event, callback, [ options ] ) → void
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' );
```
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
inherited
off( event, callback ) → void

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
inherited
on( event, callback, [ options ] ) → void

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
inherited
once( event, callback, [ options ] ) → void

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
remove( __namedParameters = { __namedParameters.isFromAdapter } ) → void
Removes comment thread.

Note This method is event-driven. It means it fires an event then a normal priority listener catches it and executes an action. It makes it possible to add some actions before and after method will be executed.

Parameters

__namedParameters : object

Properties

__namedParameters.isFromAdapter : undefined | boolean

Defaults to {}

Returns

void

Fires
- RemoveCommentThreadEvent
removeAttribute( name ) → void
Removes a comment attribute.

See also setAttribute.

Parameters

name : string

The attribute name.

Returns

void

Fires
- updateCommentThread
reopen( __namedParameters = { __namedParameters.isFromAdapter } ) → void

Reopens the resolved comment thread.

Parameters

__namedParameters : object

Properties

__namedParameters.isFromAdapter : undefined | boolean

Defaults to {}

Returns

void
resolve( __namedParameters = { __namedParameters.isFromAdapter, __namedParameters.resolvedAt, __namedParameters.resolvedBy } ) → void

Resolves the comment thread.

Parameters

__namedParameters : object

Properties

__namedParameters.isFromAdapter : undefined | boolean

__namedParameters.resolvedAt : undefined | Date

__namedParameters.resolvedBy : undefined | null

Defaults to {}

Returns

void
inherited
set( values ) → void
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'
	} );
}
```
Parameters

values : object

An object with name=>value pairs.

Returns

void
inherited
set( name, value ) → void
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 );
}
```
Type parameters

K

Parameters

name : K

The property's name.

value : CommentThread[ K ]

The property's value.

Returns

void
setAttribute( name, value ) → void
Adds attribute to the comment thread.

Comment thread attributes are custom data that can be set and used by features built around comments. Use it to store your feature data with other comment thread data. You can also group multiple values in an object, using dot notation:
```
	commentThread.setAttribute( 'customData.isImportant', true );
```
Attributes set on the comment can be accessed through the attribute property:
```
	const isImportant = commentThread.attributes.customData.isImportant;
```
You can also observe the attributes property or bind other properties to it:
```
	myObj.bind( 'customData' ).to( commentThread, 'attributes', attributes => attributes.customData );
```
Whenever setAttribute() or removeAttribute() is called, the attributes property is re-set and observables are refreshed.

Parameters

name : string

Attribute name.

value : unknown

Attribute value.

Returns

void

Fires
- updateCommentThread
setContext( context ) → void

Set the context on the comment thread. This method should be called only when the context has been not set during initialization.

Parameters

context : CommentThreadContext

Text context of comment thread.

Returns

void
setUnlinkedAt( unlinkedAt ) → void

Updates the unlinked date.

Parameters

unlinkedAt : null | Date

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
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
submit() → void

Submits the locally created comment thread draft.

Returns

void
toJSON() → CommentThreadDataJSON

Returns

CommentThreadDataJSON
inherited
unbind( unbindProperties ) → void
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

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

unbindProperties : Array<'length' | 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'submit' | 'id' | 'remove' | 'attributes' | 'isReadOnly' | 'isAttached' | '_remove' | 'toJSON' | 'removeAttribute' | 'context' | '_isAttached' | 'attachTo' | 'comments' | 'setAttribute' | 'channelId' | 'isRemovable' | 'resolvedAt' | 'weight' | 'addComment' | 'canComment' | 'archivedAt' | 'unlinkedAt' | 'resolvedBy' | 'isResolved' | 'isResolvable' | '_hasTargetInContent' | '_isSubmitted' | 'isSubmitted' | 'setUnlinkedAt' | 'resolve' | 'reopen' | 'setContext' | 'getComment' | '_add' | '_update' | '_findOptimalIndex'>

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

Returns

void

Events

change:_hasTargetInContent( eventInfo, name, value, oldValue )

Fired when the _hasTargetInContent property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_hasTargetInContent).

value : boolean

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

oldValue : boolean

Old value of the _hasTargetInContent property with given key or null, if property was not set before.
change:archivedAt( eventInfo, name, value, oldValue )

Fired when the archivedAt property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (archivedAt).

value : null | Date

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

oldValue : null | Date

Old value of the archivedAt property with given key or null, if property was not set before.
change:attributes( eventInfo, name, value, oldValue )

Fired when the attributes property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (attributes).

value : Record<string, unknown>

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

oldValue : Record<string, unknown>

Old value of the attributes property with given key or null, if property was not set before.
change:canComment( eventInfo, name, value, oldValue )

Fired when the canComment property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (canComment).

value : boolean

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

oldValue : boolean

Old value of the canComment property with given key or null, if property was not set before.
change:context( eventInfo, name, value, oldValue )

Fired when the context property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (context).

value : CommentThreadContext

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

oldValue : CommentThreadContext

Old value of the context property with given key or null, if property was not set before.
change:isReadOnly( eventInfo, name, value, oldValue )

Fired when the isReadOnly property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isReadOnly).

value : boolean

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

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
change:isRemovable( eventInfo, name, value, oldValue )

Fired when the isRemovable property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isRemovable).

value : boolean

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

oldValue : boolean

Old value of the isRemovable property with given key or null, if property was not set before.
change:isResolvable( eventInfo, name, value, oldValue )

Fired when the isResolvable property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isResolvable).

value : boolean

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

oldValue : boolean

Old value of the isResolvable property with given key or null, if property was not set before.
change:isResolved( eventInfo, name, value, oldValue )

Fired when the isResolved property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isResolved).

value : boolean

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

oldValue : boolean

Old value of the isResolved property with given key or null, if property was not set before.
change:resolvedAt( eventInfo, name, value, oldValue )

Fired when the resolvedAt property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (resolvedAt).

value : null | Date

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

oldValue : null | Date

Old value of the resolvedAt property with given key or null, if property was not set before.
change:resolvedBy( eventInfo, name, value, oldValue )

Fired when the resolvedBy property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (resolvedBy).

value : null | User

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

oldValue : null | User

Old value of the resolvedBy property with given key or null, if property was not set before.
change:unlinkedAt( eventInfo, name, value, oldValue )

Fired when the unlinkedAt property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (unlinkedAt).

value : null | Date

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

oldValue : null | Date

Old value of the unlinkedAt property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
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'
```
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.
set:_hasTargetInContent( eventInfo, name, value, oldValue )

Fired when the _hasTargetInContent 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 (_hasTargetInContent).

value : boolean

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

oldValue : boolean

Old value of the _hasTargetInContent property with given key or null, if property was not set before.
set:archivedAt( eventInfo, name, value, oldValue )

Fired when the archivedAt 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 (archivedAt).

value : null | Date

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

oldValue : null | Date

Old value of the archivedAt property with given key or null, if property was not set before.
set:attributes( eventInfo, name, value, oldValue )

Fired when the attributes 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 (attributes).

value : Record<string, unknown>

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

oldValue : Record<string, unknown>

Old value of the attributes property with given key or null, if property was not set before.
set:canComment( eventInfo, name, value, oldValue )

Fired when the canComment 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 (canComment).

value : boolean

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

oldValue : boolean

Old value of the canComment property with given key or null, if property was not set before.
set:context( eventInfo, name, value, oldValue )

Fired when the context 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 (context).

value : CommentThreadContext

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

oldValue : CommentThreadContext

Old value of the context property with given key or null, if property was not set before.
set:isReadOnly( eventInfo, name, value, oldValue )

Fired when the isReadOnly 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 (isReadOnly).

value : boolean

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

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
set:isRemovable( eventInfo, name, value, oldValue )

Fired when the isRemovable 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 (isRemovable).

value : boolean

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

oldValue : boolean

Old value of the isRemovable property with given key or null, if property was not set before.
set:isResolvable( eventInfo, name, value, oldValue )

Fired when the isResolvable 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 (isResolvable).

value : boolean

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

oldValue : boolean

Old value of the isResolvable property with given key or null, if property was not set before.
set:isResolved( eventInfo, name, value, oldValue )

Fired when the isResolved 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 (isResolved).

value : boolean

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

oldValue : boolean

Old value of the isResolved property with given key or null, if property was not set before.
set:resolvedAt( eventInfo, name, value, oldValue )

Fired when the resolvedAt 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 (resolvedAt).

value : null | Date

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

oldValue : null | Date

Old value of the resolvedAt property with given key or null, if property was not set before.
set:resolvedBy( eventInfo, name, value, oldValue )

Fired when the resolvedBy 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 (resolvedBy).

value : null | User

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

oldValue : null | User

Old value of the resolvedBy property with given key or null, if property was not set before.
set:unlinkedAt( eventInfo, name, value, oldValue )

Fired when the unlinkedAt 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 (unlinkedAt).

value : null | Date

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

oldValue : null | Date

Old value of the unlinkedAt property with given key or null, if property was not set before.
inherited
set:{property}( eventInfo, name, value, oldValue )
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'
```
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.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

CommentThread (comments/comments)

Filtering

Properties

observable archivedAt : null | Datemodule:comments/comments/commentsrepository~CommentThread#archivedAt

observable attributes : Record<string, unknown>module:comments/comments/commentsrepository~CommentThread#attributes

observable canComment : booleanmodule:comments/comments/commentsrepository~CommentThread#canComment

channelId : string | symbolmodule:comments/comments/commentsrepository~CommentThread#channelId

readonly comments : Collection<Comment>module:comments/comments/commentsrepository~CommentThread#comments

id : stringmodule:comments/comments/commentsrepository~CommentThread#id

readonly isAttached : booleanmodule:comments/comments/commentsrepository~CommentThread#isAttached

observable isReadOnly : booleanmodule:comments/comments/commentsrepository~CommentThread#isReadOnly

observable isRemovable : booleanmodule:comments/comments/commentsrepository~CommentThread#isRemovable

readonly observable isResolved : booleanmodule:comments/comments/commentsrepository~CommentThread#isResolved

readonly isSubmitted : booleanmodule:comments/comments/commentsrepository~CommentThread#isSubmitted

readonly length : numbermodule:comments/comments/commentsrepository~CommentThread#length

observable resolvedAt : null | Datemodule:comments/comments/commentsrepository~CommentThread#resolvedAt

observable resolvedBy : null | Usermodule:comments/comments/commentsrepository~CommentThread#resolvedBy

observable unlinkedAt : null | Datemodule:comments/comments/commentsrepository~CommentThread#unlinkedAt

readonly weight : numbermodule:comments/comments/commentsrepository~CommentThread#weight

Methods

constructor( commentsRepository, data = { data.attributes, data.channelId, data.context, data.id, data.isResolvable, data.isSubmitted, data.resolvedAt, data.resolvedBy, data.unlinkedAt } )module:comments/comments/commentsrepository~CommentThread#constructor

Parameters

addComment( data ) → voidmodule:comments/comments/commentsrepository~CommentThread#addComment

Parameters

Returns

Fires

attachTo( target ) → Annotationmodule:comments/comments/commentsrepository~CommentThread#attachTo

Parameters

Returns

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CommentThread[ K1 ], K2, CommentThread[ K2 ]>module:comments/comments/commentsrepository~CommentThread#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:comments/comments/commentsrepository~CommentThread#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, CommentThread[ K ]>module:comments/comments/commentsrepository~CommentThread#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:comments/comments/commentsrepository~CommentThread#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:comments/comments/commentsrepository~CommentThread#delegate

Parameters

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:comments/comments/commentsrepository~CommentThread#fire

Type parameters

Parameters

Returns

getComment( commentId ) → null | Commentmodule:comments/comments/commentsrepository~CommentThread#getComment

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:comments/comments/commentsrepository~CommentThread#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:comments/comments/commentsrepository~CommentThread#off

Parameters

Returns

inherited on( event, callback, [ options ] ) → voidmodule:comments/comments/commentsrepository~CommentThread#on

Type parameters

Parameters

Returns

inherited once( event, callback, [ options ] ) → voidmodule:comments/comments/commentsrepository~CommentThread#once

Type parameters

Parameters

Returns

remove( __namedParameters = { __namedParameters.isFromAdapter } ) → voidmodule:comments/comments/commentsrepository~CommentThread#remove

Parameters

Returns

Fires

removeAttribute( name ) → voidmodule:comments/comments/commentsrepository~CommentThread#removeAttribute

Parameters

Returns

Fires

reopen( __namedParameters = { __namedParameters.isFromAdapter } ) → voidmodule:comments/comments/commentsrepository~CommentThread#reopen

Parameters

Returns

resolve( __namedParameters = { __namedParameters.isFromAdapter, __namedParameters.resolvedAt, __namedParameters.resolvedBy } ) → voidmodule:comments/comments/commentsrepository~CommentThread#resolve

observable
`archivedAt : null | Date`

observable
`attributes : Record<string, unknown>`

observable
`canComment : boolean`

`channelId : string | symbol`

readonly
`comments : Collection<Comment>`

`id : string`

readonly
`isAttached : boolean`

observable
`isReadOnly : boolean`

observable
`isRemovable : boolean`

readonly observable
`isResolved : boolean`

readonly
`isSubmitted : boolean`

readonly
`length : number`

observable
`resolvedAt : null | Date`

observable
`resolvedBy : null | User`

observable
`unlinkedAt : null | Date`

readonly
`weight : number`

`constructor( commentsRepository, data = { data.attributes, data.channelId, data.context, data.id, data.isResolvable, data.isSubmitted, data.resolvedAt, data.resolvedBy, data.unlinkedAt } )`

`addComment( data ) → void`

`attachTo( target ) → Annotation`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CommentThread[ K1 ], K2, CommentThread[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, CommentThread[ K ]>`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

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

`getComment( commentId ) → null | Comment`

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

inherited
`off( event, callback ) → void`

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

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

`remove( namedParameters = { namedParameters.isFromAdapter } ) → void`

`removeAttribute( name ) → void`

`reopen( namedParameters = { namedParameters.isFromAdapter } ) → void`

`resolve( namedParameters = { namedParameters.isFromAdapter, namedParameters.resolvedAt, namedParameters.resolvedBy } ) → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

`setAttribute( name, value ) → void`

`setContext( context ) → void`

`setUnlinkedAt( unlinkedAt ) → void`

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

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

`submit() → void`

`toJSON() → CommentThreadDataJSON`

inherited
`unbind( unbindProperties ) → void`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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