getAllCommentAnnotations()

Subscribe to comments on the current document.

Signature:
getAllCommentAnnotations(documentId?: string, documentParams?: object)

Params:
documentId?: string, documentParams?: object

Returns:
Observable<CommentAnnotation[] | null>

deleteSelectedComment()

To delete selected comments

Signature:
deleteSelectedComment()

Params:
none

Returns:
Promise<any>

enableTextComments()

To enable text comment selection

Signature:
enableTextComments()

Params:
none

Returns:
any

disableTextComments()

To disable text comment selection

Signature:
disableTextComments()

Params:
none

Returns:
any

allowedElementIds()

To allow text selection in specific elements only

Signature:
allowedElementIds(elementIds: string[])

Params:
elementIds: string[]

Returns:
any

allowedElementClassNames()

To allow adding comments in specific elements only

Signature:
allowedElementClassNames(classNames: string[])

Params:
classNames: string[]

Returns:
any

allowedElementQuerySelectors()

To allow adding comments in specific elements only

Signature:
allowedElementQuerySelectors(querySelectors: string[])

Params:
querySelectors: string[]

Returns:
any

enableFloatingCommentDialog()

To enable floating comment dialog

Signature:
enableFloatingCommentDialog()

Params:
none

Returns:
any

disableFloatingCommentDialog()

To disable floating comment dialog

Signature:
disableFloatingCommentDialog()

Params:
none

Returns:
any

attachComment()

To add comments on specific elements

Signature:
attachComment(elementId: string)

Params:
elementId: string

Returns:
any

openCommentSidebar()

To open comment sidebar

Signature:
openCommentSidebar()

Params:
none

Returns:
any

closeCommentSidebar()

To close comment sidebar

Signature:
closeCommentSidebar()

Params:
none

Returns:
any

toggleCommentSidebar()

To toggle comment sidebar

Signature:
toggleCommentSidebar()

Params:
none

Returns:
any

enableModeratorMode()

To enable moderator mode

Signature:
enableModeratorMode()

Params:
none

Returns:
any

disableModeratorMode()

To disable moderator mode

Signature:
disableModeratorMode()

Params:
none

Returns:
any

enableStreamMode()

To enable stream mode

Signature:
enableStreamMode()

Params:
none

Returns:
any

disableStreamMode()

To disable stream mode

Signature:
disableStreamMode()

Params:
none

Returns:
any

enableSignInButton()

To show sign in button in comments if user is signed out

Signature:
enableSignInButton()

Params:
none

Returns:
any

disableSignInButton()

To hide sign in button in comments if user is signed out

Signature:
disableSignInButton()

Params:
none

Returns:
any

enableUpgradeButton()

To enable upgrade button in comments when plan is expired

Signature:
enableUpgradeButton()

Params:
none

Returns:
any

disableUpgradeButton()

To disable upgrade button in comments when plan is expired

Signature:
disableUpgradeButton()

Params:
none

Returns:
any

onCommentModeChange()

Subscribe to comment mode change.

Signature:
onCommentModeChange()

Params:
none

Returns:
Observable<boolean>

enableAttachments()

Enable attachments feature in comments

Signature:
enableAttachments()

Params:
none

Returns:
any

disableAttachments()

Disable attachments feature in comments

Signature:
disableAttachments()

Params:
none

Returns:
any

isUserGlobalContact()

Get if user is part of global contact or not.

Signature:
isUserGlobalContact()

Params:
none

Returns:
Observable<boolean>

enableDeviceInfo()

Enable device info in comments

Signature:
enableDeviceInfo()

Params:
none

Returns:
any

disableDeviceInfo()

Disable device info in comments

Signature:
disableDeviceInfo()

Params:
none

Returns:
any

enableCommentMode()

Enable comment mode to add comments.

Signature:
enableCommentMode()

Params:
none

Returns:
any

disableCommentMode()

Disable comment mode.

Signature:
disableCommentMode()

Params:
none

Returns:
any

enablePersistentCommentMode()

Enable persistent comment mode.

Signature:
enablePersistentCommentMode()

Params:
none

Returns:
any

disablePersistentCommentMode()

Disable persistent comment mode.

Signature:
disablePersistentCommentMode()

Params:
none

Returns:
any

enableCommentIndex()

To show comment number

Signature:
enableCommentIndex()

Params:
none

Returns:
any

disableCommentIndex()

To hide comment number

Signature:
disableCommentIndex()

Params:
none

Returns:
any

enablePopoverMode()

To enable popover mode

Signature:
enablePopoverMode()

Params:
none

Returns:
any

disablePopoverMode()

To disable popover mode

Signature:
disablePopoverMode()

Params:
none

Returns:
any

enablePopoverTriangleComponent()

To show triangle in popover mode

Signature:
enablePopoverTriangleComponent()

Params:
none

Returns:
any

disablePopoverTriangleComponent()

To hide triangle in popover mode

Signature:
disablePopoverTriangleComponent()

Params:
none

Returns:
any

enableDialogOnHover()

To enable dialog on hover

Signature:
enableDialogOnHover()

Params:
none

Returns:
any

disableDialogOnHover()

To disable dialog on hover

Signature:
disableDialogOnHover()

Params:
none

Returns:
any

enableDialogOnTargetElementClick()

To enable feature to show dialog on target element click

Signature:
enableDialogOnTargetElementClick()

Params:
none

Returns:
any

disableDialogOnTargetElementClick()

To disable feature to show dialog on target element click

Signature:
disableDialogOnTargetElementClick()

Params:
none

Returns:
any

enablePriority()

To enable feature to set priority on comments

Signature:
enablePriority()

Params:
none

Returns:
any

disablePriority()

To disable feature to set priority on comments

Signature:
disablePriority()

Params:
none

Returns:
any

enableStatus()

To enable feature to set status on comments

Signature:
enableStatus()

Params:
none

Returns:
any

disableStatus()

To disable feature to set status on comments

Signature:
disableStatus()

Params:
none

Returns:
any

enableResolveButton()

To enable feature to show resolve button

Signature:
enableResolveButton()

Params:
none

Returns:
any

disableResolveButton()

To disable feature to show resolve button

Signature:
disableResolveButton()

Params:
none

Returns:
any

enableGhostComments()

To enable feature to show ghost comments

Signature:
enableGhostComments()

Params:
none

Returns:
any

disableGhostComments()

To disable feature to show ghost comments

Signature:
disableGhostComments()

Params:
none

Returns:
any

enableGhostCommentsIndicator()

To enable feature to show ghost comments message in comment dialog and comment sidebar

Signature:
enableGhostCommentsIndicator()

Params:
none

Returns:
any

disableGhostCommentsIndicator()

To disable feature to show ghost comments message in comment dialog and comment sidebar

Signature:
disableGhostCommentsIndicator()

Params:
none

Returns:
any

setCustomStatus()

Sets custom status filters

Signature:
setCustomStatus(statuses: CustomStatus[])

Params:
statuses: CustomStatus[]

Returns:
void

setCustomPriority()

Sets custom priority filters

Signature:
setCustomPriority(priorities: CustomPriority[])

Params:
priorities: CustomPriority[]

Returns:
void

setCustomCategory()

Sets custom categories filters

Signature:
setCustomCategory(categories: CustomCategory[])

Params:
categories: CustomCategory[]

Returns:
void

enableInboxMode()

To enable inbox mode

Signature:
enableInboxMode()

Params:
none

Returns:
any

disableInboxMode()

To disable inbox mode

Signature:
disableInboxMode()

Params:
none

Returns:
any

enableAutoCategorize()

To enable auto categorize feature

Signature:
enableAutoCategorize()

Params:
none

Returns:
any

disableAutoCategorize()

To disable auto categorize feature

Signature:
disableAutoCategorize()

Params:
none

Returns:
any

enableDarkMode()

To enable dark mode in comments

Signature:
enableDarkMode()

Params:
none

Returns:
any

disableDarkMode()

To disable dark mode in comments

Signature:
disableDarkMode()

Params:
none

Returns:
any

setContextProvider()

Sets the comment context provider

Signature:
setContextProvider(provider: (documentId: string, location?: any) => any)

Params:
provider: (documentId: string, location?: any) => any

Returns:
void

enableSuggestionMode()

To enable suggestion mode

Signature:
enableSuggestionMode()

Params:
none

Returns:
any

disableSuggestionMode()

To disable suggestion mode

Signature:
disableSuggestionMode()

Params:
none

Returns:
any

enableMobileMode()

To enable mobile mode

Signature:
enableMobileMode()

Params:
none

Returns:
any

disableMobileMode()

To disable mobile mode

Signature:
disableMobileMode()

Params:
none

Returns:
any

enableInlineCommentMode()

To enable inline comment mode

Signature:
enableInlineCommentMode()

Params:
none

Returns:
any

disableInlineCommentMode()

To disable inline comment mode

Signature:
disableInlineCommentMode()

Params:
none

Returns:
any

enableMinimap()

To enable minimap

Signature:
enableMinimap()

Params:
none

Returns:
any

disableMinimap()

To disable minimap

Signature:
disableMinimap()

Params:
none

Returns:
any

showCommentsOnDom()

To show comments on DOM

Signature:
showCommentsOnDom()

Params:
none

Returns:
any

hideCommentsOnDom()

To hide comments on DOM

Signature:
hideCommentsOnDom()

Params:
none

Returns:
any

enableCommentTool()

To enable comment tool

Signature:
enableCommentTool()

Params:
none

Returns:
any

disableCommentTool()

To disable comment tool

Signature:
disableCommentTool()

Params:
none

Returns:
any

setTotalMediaLength()

To set total media length.

Signature:
setTotalMediaLength(totalMediaLength: number)

Params:
totalMediaLength: number

Returns:
void

onCommentAdd()

To get documentId, location and set context data when comment is added.

Signature:
onCommentAdd()

Params:
none

Returns:
Observable<any>

onCommentUpdate()

To get data when comment is updated.

Signature:
onCommentUpdate()

Params:
none

Returns:
Observable<any>

addCommentOnSelectedText()

To add comment on selected text.

Signature:
addCommentOnSelectedText()

Params:
none

Returns:
void

enableSidebarUrlNavigation()

To enable navigation when comment is clicked in sidebar.

Signature:
enableSidebarUrlNavigation()

Params:
none

Returns:
void

disableSidebarUrlNavigation()

To disable navigation when comment is clicked in sidebar.

Signature:
disableSidebarUrlNavigation()

Params:
none

Returns:
void

enableSidebarButtonOnCommentDialog()

To enable sidebar button on comment dialog.

Signature:
enableSidebarButtonOnCommentDialog()

Params:
none

Returns:
void

disableSidebarButtonOnCommentDialog()

To disable sidebar button on comment dialog.

Signature:
disableSidebarButtonOnCommentDialog()

Params:
none

Returns:
void

onSidebarButtonOnCommentDialogClick()

To detect click on sidebar button on comment dialog.

Signature:
onSidebarButtonOnCommentDialogClick()

Params:
none

Returns:
Observable<any>

enableReactions()

To enable reactions in comments

Signature:
enableReactions()

Params:
none

Returns:
void

disableReactions()

To disable reactions in comments

Signature:
disableReactions()

Params:
none

Returns:
void

setRecordings()

To set allowed recordings in comments

Signature:
setRecordings(allowedRecordings: string | string[])

Params:
allowedRecordings: string | string[]

Returns:
void

addCommentOnElement()

To manually add comment on element.

Signature:
addCommentOnElement(data: CommentOnElementConfig)

Params:
data: CommentOnElementConfig

Returns:
void

enablePrivateCommentMode()

To enable private comment mode to add private comments. This mode can be enabled for admin users only.

Signature:
enablePrivateCommentMode()

Params:
none

Returns:
void

disablePrivateCommentMode()

To disable private comment mode.

Signature:
disablePrivateCommentMode()

Params:
none

Returns:
void

enableScrollToComment()

To enable scroll to comment.

Signature:
enableScrollToComment()

Params:
none

Returns:
void

disableScrollToComment()

To disable scroll to comment.

Signature:
disableScrollToComment()

Params:
none

Returns:
void

enableUserMentions()

To enable user mentions in comments

Signature:
enableUserMentions()

Params:
none

Returns:
void

disableUserMentions()

To disable user mentions in comments

Signature:
disableUserMentions()

Params:
none

Returns:
void

setCommentSidebarFilters()

To apply filters on comment sidebar.

Signature:
setCommentSidebarFilters(filters: any)

Params:
filters: any

Returns:
void

enableCommentPinHighlighter()

To enable comment pin highlighter.

Signature:
enableCommentPinHighlighter()

Params:
none

Returns:
void

disableCommentPinHighlighter()

To disable comment pin highlighter.

Signature:
disableCommentPinHighlighter()

Params:
none

Returns:
void

enableDeleteOnBackspace()

To enable deleting comment on backspace.

Signature:
enableDeleteOnBackspace()

Params:
none

Returns:
void

disableDeleteOnBackspace()

To disable deleting comment on backspace.

Signature:
disableDeleteOnBackspace()

Params:
none

Returns:
void

enableHotkey()

To enable hotkey.

Signature:
enableHotkey()

Params:
none

Returns:
void

disableHotkey()

To disable hotkey.

Signature:
disableHotkey()

Params:
none

Returns:
void