api - Documentation

api

Source:

src/convenientDiscussions.js, line 195

Script's publicly available API. Here there are some utilities that we believe should be accessible for external use.

If you need some internal method to be available publicly, contact the script's maintainer (or just make a relevant pull request).

Members

(static) pageRegistry :object

Source:

src/convenientDiscussions.js, line 206

See:

module:pageRegistry

If CD isn't loaded (on pages where CD clearly doesn't need to run), only module:pageRegistry.get and module:pageRegistry.Page#isProbablyTalkPage are guaranteed to run.

Type:

object

Methods

(static) buildEditSummary()

Source:

src/convenientDiscussions.js, line 232

See:

module:util.buildEditSummary

(static) generateCommentId()

Source:

src/convenientDiscussions.js, line 218

See:

CommentSkeleton.generateId

(static) getCommentByDtId()

Source:

src/init.js, line 802

See:

module:commentRegistry.getByDtId

(static) getCommentById()

Source:

src/init.js, line 795

See:

module:commentRegistry.getById

(static) getLastActiveAlteredCommentForm()

Source:

src/init.js, line 830

See:

module:commentFormRegistry.getLastActiveAltered

(static) getLastActiveCommentForm()

Source:

src/init.js, line 823

See:

module:commentFormRegistry.getLastActive

(static) getRootElement()

Source:

src/init.js, line 845

See:

module:controller.getRootElement

(static) getSectionById()

Source:

src/init.js, line 809

See:

module:sectionRegistry.getById

(static) getSectionsByHeadline()

Source:

src/init.js, line 816

See:

module:sectionRegistry.getByHeadline

(static) isPageOverlayOn()

Source:

src/convenientDiscussions.js, line 239

See:

module:controller.isPageOverlayOn

(static) parseCommentId()

Source:

src/convenientDiscussions.js, line 225

See:

module:Comment.parseId

(static) reloadPage()

Source:

src/init.js, line 838

See:

module:controller.reload

(static) wrapDiffBody()

Source:

src/convenientDiscussions.js, line 256

See:

module:util.wrapDiffBody

(static) wrapHtml()

Source:

src/convenientDiscussions.js, line 246

See:

module:util.wrapHtml