Class

CommentsRepository (comments/comments)

@ckeditor/ckeditor5-comments/src/comments/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.

Filtering

Properties

  • observable

    activeCommentThread : null | CommentThread

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

  • adapter : CommentsAdapter

    Parameters

    adapter : CommentsAdapter
  • readonly inherited

    context : ContextInterface

    The context or editor instance.

  • licenseKey : string

Static properties

  • readonly inherited static

    isContextPlugin : true

  • readonly static

    pluginName : 'CommentsRepository'

  • readonly static

    requires : readonly tuple

Methods

  • constructor( context )

    Parameters

    context : Editor | Context
  • addCommentThread( commentThreadData ) → undefined | CommentThread

    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
    } );
    

    Parameters

    commentThreadData : AddCommentThreadEventData

    The data of the comment thread to add.

    Defaults to ...

    Returns

    undefined | CommentThread

    The added comment thread.

    Fires

  • afterInit() → void

    Returns

    void
  • inherited

    bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CommentsRepository[ K1 ], K2, CommentsRepository[ 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, CommentsRepository[ K1 ], K2, CommentsRepository[ 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<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'licenseKey' | 'afterInit' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'setPermissions' | 'getPermissions' | '_attachCommentThread' | '_bindAnnotationToEditors' | '_unbindEditors' | '_removeCommentThread' | '_detachCommentThread' | '_updateComment' | '_removeComment'>

    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, CommentsRepository[ 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, 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
  • 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 : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'licenseKey' | 'afterInit' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'setPermissions' | 'getPermissions' | '_attachCommentThread' | '_bindAnnotationToEditors' | '_unbindEditors' | '_removeCommentThread' | '_detachCommentThread' | '_updateComment' | '_removeComment'

    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

    destroy() → void

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

  • getCommentThread( threadId ) → undefined | CommentThread

    Returns comment thread of given id.

    Parameters

    threadId : string

    Returns

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

    Returns a list of comment threads added to the repository.

    You can provide a set of filtering options to narrow down the results set.

    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>

    Returns a list of comment threads added to the repository.

    You can provide a set of filtering options to narrow down the results set.

    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
  • 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
  • openNewCommentThread( __namedParameters ) → null | CommentThread

    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

    __namedParameters : AddCommentThreadEventData

    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

  • 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 : 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
  • 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
  • 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
  • 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<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isReadOnly' | 'context' | 'init' | 'licenseKey' | 'afterInit' | 'adapter' | '_permissions' | 'activeCommentThread' | '_adapter' | '_threads' | '_threadToController' | '_viewToController' | '_readOnlyChannels' | 'addCommentThread' | 'openNewCommentThread' | 'hasCommentThread' | 'updateCommentThread' | 'getCommentThread' | 'fetchCommentThread' | 'getCommentThreads' | 'setActiveCommentThread' | 'switchReadOnly' | 'createCommentThreadController' | 'setPermissions' | '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

    Updates existing comment thread.

    Parameters

    data : UpdateCommentThreadEventData

    The data of the comment thread to add.

    Returns

    CommentThread

    The updated comment thread.

    Fires

Events

  • 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

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

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

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

  • 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

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

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

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

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

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

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

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

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