@veltdev/types 1.0.1

package/app/models/element/comment-element.model.d.ts

@@ -0,0 +1,808 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { CommentPinAnnotation } from "../data/comment-pin-annotation.data.model";
+import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
+export declare class CommentElement {
+  /**
+   * Subscribe to comments on the current document.
+   *
+   * Returns Observable<CommentPinAnnotation[] | null>.
+   */
+  getAllCommentAnnotations: (documentId?: string, documentParams?: object) => Observable<CommentPinAnnotation[] | null>;
+
+  /**
+   * To delete selected comments
+   */
+  deleteComment: () => any;
+
+  /**
+   * To enable text comment selection
+   */
+  enableTextComments: () => any;
+
+  /**
+   * To disable text comment selection
+   */
+  disableTextComments: () => any;
+
+  /**
+   * To allow text selection in specific elements only
+   * @param elementIds Element ids to be allowed for text selection
+   */
+  allowedElementIds: (elementIds: string[]) => any;
+
+  /**
+   * To enable floating comments
+   * @deprecated Use enableFloatingMode instead
+   */
+  enableFloatingComments: () => any;
+
+  /**
+   * To disable floating comments
+   * @deprecated Use disableFloatingMode instead
+   */
+  disableFloatingComments: () => any;
+
+  /**
+   * To enable floating mode
+   */
+  enableFloatingMode: () => any;
+
+  /**
+   * To disable floating mode
+   */
+  disableFloatingMode: () => any;
+
+  /**
+   * To add comments on specific elements
+   *
+   * @param elementId ID of html element
+   */
+  attachComment: (elementId: string) => any;
+
+  /**
+   * To open comment sidebar
+   */
+  openCommentSidebar: () => any;
+
+  /**
+  * To close comment sidebar
+  */
+  closeCommentSidebar: () => any;
+
+  /**
+   * To toggle comment sidebar
+   */
+  toggleCommentSidebar: () => any;
+
+  /**
+  * To enable moderator mode
+  */
+  enableModeratorMode: () => any;
+
+  /**
+   * To disable moderator mode
+   */
+  disableModeratorMode: () => any;
+
+  /**
+   * To enable stream mode
+   */
+  enableStreamMode: () => any;
+
+  /**
+   * To disable stream mode
+   */
+  disableStreamMode: () => any;
+
+  /**
+   * To show sign in button in comments if user is signed out
+   */
+  enableSignInButton: () => any;
+
+  /**
+   * To hide sign in button in comments if user is signed out
+   */
+  disableSignInButton: () => any;
+
+  /**
+   * @deprecated Use onCommentModeChange instead
+   * 
+   * Subscribe to add comment mode change.
+   *
+   * Returns Observable<boolean>.
+   */
+  addCommentModeChange: () => Observable<boolean>;
+
+  /**
+   * Subscribe to comment mode change.
+   * 
+   * Returns Observable<boolean>.
+   */
+  onCommentModeChange: () => Observable<boolean>;
+
+  /**
+   * Enable attachments feature in comments
+   * 
+   * @deprecated Use enableAttachments instead
+   */
+  enableAttachment: () => any;
+
+  /**
+   * Disable attachments feature in comments
+   * 
+   * @deprecated Use disableAttachments instead
+   */
+  disableAttachment: () => any;
+
+  /**
+   * Enable attachments feature in comments
+   */
+  enableAttachments: () => any;
+
+  /**
+   * Disable attachments feature in comments
+   */
+  disableAttachments: () => any;
+
+  /**
+   * Get if user is part of global contact or not.
+   */
+  isUserGlobalContact: () => Observable<boolean>;
+
+  /**
+   * Enable this feature to show device info in comments
+   *
+   * @param showInfo pass `true` to show info, `false` to hide it.
+   * 
+   * @deprecated Use enableDeviceInfo and disableDeviceInfo instead
+   */
+  showDeviceInfo: (showInfo: boolean) => any;
+
+  /**
+   * Enable device info in comments
+   */
+  enableDeviceInfo: () => any;
+
+  /**
+   * Disable device info in comments
+   */
+  disableDeviceInfo: () => any;
+
+  /**
+   * Enable comment mode to add comments.
+   */
+  public enableCommentMode: () => any;
+
+  /**
+   * Disable comment mode.
+   */
+  public disableCommentMode: () => any;
+
+  /**
+   * To show/hide comment number
+   * @param show pass `true` to show it, `false` to hide it.
+   * 
+   * @deprecated Use enableCommentIndex and disableCommentIndex instead
+   */
+  public showCommentIndex: (show: boolean) => any;
+
+  /**
+   * To show comment number
+   */
+  public enableCommentIndex: () => any;
+
+  /**
+   * To hide comment number
+   */
+  public disableCommentIndex: () => any;
+
+  /**
+   * To enable popover mode
+   */
+  public enablePopoverMode: () => any;
+
+  /**
+   * To disable popover mode
+   */
+  public disablePopoverMode: () => any;
+
+  /**
+   * To enable dialog on hover
+   */
+  public enableDialogOnHover: () => any;
+
+  /**
+   * To disable dialog on hover
+   */
+  public disableDialogOnHover: () => any;
+
+  /**
+   * To enable feature to show dialog on target element click
+   */
+  public enableDialogOnTargetElementClick: () => any;
+
+  /**
+   * To disable feature to show dialog on target element click
+   */
+  public disableDialogOnTargetElementClick: () => any;
+
+  /**
+   * To enable feature to set priority on comments
+   */
+  public enablePriority: () => any;
+
+  /**
+   * To disable feature to set priority on comments
+   */
+  public disablePriority: () => any;
+
+  /**
+   * To enable feature to set status on comments
+   */
+  public enableStatus: () => any;
+
+  /**
+   * To disable feature to set status on comments
+   */
+  public disableStatus: () => any;
+
+  /**
+   * To enable feature to resolve comments
+   * 
+   * @deprecated Use enableResolveButton instead
+   */
+  public enableResolve: () => any;
+
+  /**
+   * To disable feature to resolve comments
+   * 
+   * @deprecated Use disableResolveButton instead
+   */
+  public disableResolve: () => any;
+
+  /**
+   * To enable feature to show resolve button
+   */
+  public enableResolveButton: () => any;
+
+  /**
+   * To disable feature to show resolve button
+   */
+  public disableResolveButton: () => any;
+
+  /**
+   * To enable feature to show ghost comments
+   * 
+   * @deprecated Use enableGhostComments instead
+   */
+  public enableGhostCommentsInDOM: () => any;
+
+  /**
+   * To disable feature to show ghost comments
+   * 
+   * @deprecated Use disableGhostComments instead
+   */
+  public disableGhostCommentsInDOM: () => any;
+
+  /**
+   * To enable feature to show ghost comments
+   */
+  public enableGhostComments: () => any;
+
+  /**
+   * To disable feature to show ghost comments
+   */
+  public disableGhostComments: () => any;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   * 
+   * @deprecated Use enableGhostCommentsIndicator instead
+   */
+  public enableGhostCommentsMessage: () => any;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   * 
+   * @deprecated Use disableGhostCommentsIndicator instead
+   */
+  public disableGhostCommentsMessage: () => any;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  public enableGhostCommentsIndicator: () => any;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  public disableGhostCommentsIndicator: () => any;
+
+  /**
+   * @description Sets custom status filters
+   * @param statuses
+   * 
+   * @deprecated Use setCustomStatus instead
+   */
+  setCustomStatuses: (statuses: CustomStatus[]) => void;
+
+  /**
+   * @description Sets custom status filters
+   * @param statuses 
+   */
+  setCustomStatus: (statuses: CustomStatus[]) => void;
+
+  /**
+   * @description Sets custom priority filters
+   * @param priorities
+   * 
+   * @deprecated Use setCustomPriority instead
+   */
+  setCustomPriorities: (priorities: CustomPriority[]) => void;
+
+  /**
+   * @description Sets custom priority filters
+   * @param priorities
+   */
+  setCustomPriority: (priorities: CustomPriority[]) => void;
+
+  /**
+   * @description Sets custom categories filters
+   * @param categories
+   * 
+   * @deprecated Use setCustomCategory instead
+   */
+   setCustomCategories: (categories: CustomCategory[]) => void;
+
+  /**
+   * @description Sets custom categories filters
+   * @param categories
+   */
+   setCustomCategory: (categories: CustomCategory[]) => void;
+
+  /**
+   * To enable inbox mode
+   */
+  public enableInboxMode: () => any;
+
+  /**
+   * To disable inbox mode
+   */
+  public disableInboxMode: () => any;
+
+  /**
+   * To enable auto categorize feature
+   */
+  public enableAutoCategorize: () => any;
+
+  /**
+   * To disable auto categorize feature
+   */
+  public disableAutoCategorize: () => any;
+
+  /**
+   * To enable dark mode in comments
+   */
+  public enableDarkMode: () => any;
+
+  /**
+   * To disable dark mode in comments
+   */
+  public disableDarkMode: () => any;
+
+  /**
+   * @description Sets the comment context provider
+   * @param provider 
+   */
+  public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
+
+  /**
+   * To enable suggestion mode
+   */
+  public enableSuggestionMode: () => any;
+
+  /**
+   * To disable suggestion mode
+   */
+  public disableSuggestionMode: () => any;
+  constructor();
+  /**
+   * Subscribe to comments on the current document.
+   *
+   * Returns Observable<CommentPinAnnotation[] | null>.
+   */
+  private _getAllCommentAnnotations;
+
+  /**
+   * To delete selected comments
+   */
+  private _deleteComment;
+
+  /**
+  * To enable text comment selection
+  */
+  private _enableTextComments;
+
+  /**
+   * To disable text comment selection
+   */
+  private _disableTextComments;
+
+  /**
+   * To allow text selection in specific elements only
+   * @param elementIds Element ids to be allowed for text selection
+   */
+  private _allowedElementIds;
+
+  /**
+   * To enable floating comments
+   * @deprecated Use enableFloatingMode instead
+   */
+  private _enableFloatingComments;
+
+  /**
+   * To disable floating comments
+   * @deprecated Use disableFloatingMode instead
+   */
+  private _disableFloatingComments;
+
+  /**
+   * To enable floating mode
+   */
+  private _enableFloatingMode;
+
+  /**
+   * To disable floating mode
+   */
+  private _disableFloatingMode;
+
+  /**
+   * To add comments on specific elements
+   *
+   * @param elementId ID of html element
+   */
+  private _attachComment;
+
+  /**
+   * To open comment sidebar
+   */
+  private _openCommentSidebar;
+
+  /**
+  * To close comment sidebar
+  */
+  private _closeCommentSidebar;
+
+  /**
+   * To toggle comment sidebar
+   */
+  private _toggleCommentSidebar;
+
+  /**
+  * To enable moderator mode
+  */
+  private _enableModeratorMode;
+
+  /**
+   * To disable moderator mode
+   */
+  private _disableModeratorMode;
+
+  /**
+   * To enable stream mode
+   */
+  private _enableStreamMode;
+
+  /**
+   * To disable stream mode
+   */
+  private _disableStreamMode;
+
+  /**
+   * To show sign in button in comments if user is signed out
+   */
+  private _enableSignInButton;
+
+  /**
+   * To hide sign in button in comments if user is signed out
+   */
+  private _disableSignInButton;
+
+  /**
+   * @deprecated Use onCommentModeChange instead
+   * 
+   * Subscribe to add comment mode change.
+   *
+   * Returns Observable<boolean>.
+   */
+  private _addCommentModeChange;
+
+  /**
+   * Subscribe to comment mode change.
+   * 
+   * Returns Observable<boolean>.
+   */
+  private _onCommentModeChange;
+
+  /**
+   * Enable attachments feature in comments
+   * 
+   * @deprecated Use enableAttachments instead
+   */
+  private _enableAttachment;
+
+  /**
+   * Disable attachments feature in comments
+   * 
+   * @deprecated Use disableAttachments instead
+   */
+  private _disableAttachment;
+
+  /**
+   * To enable attachments feature in comments
+   */
+  private _enableAttachments;
+
+  /**
+   * To disable attachments feature in comments
+   */
+  private _disableAttachments;
+
+  /**
+   * Enable this feature to show device info in comments
+   *
+   * @param showInfo pass `true` to show info, `false` to hide it.
+   * 
+   * @deprecated Use enableDeviceInfo and disableDeviceInfo instead
+   */
+  private _showDeviceInfo;
+
+  /**
+   * Enable device info in comments
+   */
+  private _enableDeviceInfo;
+
+  /**
+   * Disable device info in comments
+   */
+  private _disableDeviceInfo;
+
+  /**
+   * Enable comment mode to add comments.
+   */
+  private _enableCommentMode;
+
+  /**
+   * Disable comment mode.
+   */
+  private _disableCommentMode;
+
+  /**
+   * To show/hide comment number
+   * @param show pass `true` to show it, `false` to hide it.
+   * 
+   * @deprecated Use enableCommentIndex and disableCommentIndex instead
+   */
+  private _showCommentIndex;
+
+  /**
+   * To enable comment number
+   */
+  private _enableCommentIndex;
+
+  /**
+   * To disable comment number
+   */
+  private _disableCommentIndex;
+
+  /**
+   * To enable popover mode
+   */
+  private _enablePopoverMode;
+
+  /**
+   * To disable popover mode
+   */
+  private _disablePopoverMode;
+
+  /**
+   * To enable dialog on hover
+   */
+  private _enableDialogOnHover;
+
+  /**
+   * To disable dialog on hover
+   */
+  private _disableDialogOnHover;
+
+  /**
+   * To enable feature to show dialog on target element click
+   */
+  private _enableDialogOnTargetElementClick;
+
+  /**
+   * To disable feature to show dialog on target element click
+   */
+  private _disableDialogOnTargetElementClick;
+
+  /**
+   * To enable feature to set priority on comments
+   */
+  private _enablePriority;
+
+  /**
+   * To disable feature to set priority on comments
+   */
+  private _disablePriority;
+
+  /**
+   * To enable feature to set status on comments
+   */
+  private _enableStatus;
+
+  /**
+   * To disable feature to set status on comments
+   */
+  private _disableStatus;
+
+  /**
+   * To enable feature to resolve comments
+   * 
+   * @deprecated Use enableResolveButton instead
+   */
+  private _enableResolve;
+
+  /**
+   * To disable feature to resolve comments
+   * 
+   * @deprecated Use disableResolveButton instead
+   */
+  private _disableResolve;
+
+  /**
+   * To enable feature to show resolve button
+   */
+  private _enableResolveButton;
+
+  /**
+   * To disable feature to show resolve button
+   */
+  private _disableResolveButton;
+
+  /**
+   * To enable feature to show ghost comments
+   * 
+   * @deprecated Use enableGhostComments instead
+   */
+  private _enableGhostCommentsInDOM;
+
+  /**
+   * To disable feature to show ghost comments
+   * 
+   * @deprecated Use disableGhostComments instead
+   */
+  private _disableGhostCommentsInDOM;
+
+  /**
+   * To enable feature to show ghost comments
+   */
+  private _enableGhostComments;
+
+  /**
+   * To disable feature to show ghost comments
+   */
+  private _disableGhostComments;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   * 
+   * @deprecated Use enableGhostCommentsIndicator instead
+   */
+  private _enableGhostCommentsMessage;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   * 
+   * @deprecated Use disableGhostCommentsIndicator instead
+   */
+  private _disableGhostCommentsMessage;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  private _enableGhostCommentsIndicator;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  private _disableGhostCommentsIndicator;
+
+  /**
+   * @description Sets custom status filters
+   * @param statuses
+   * 
+   * @deprecated Use setCustomStatus instead
+   */
+  private _setCustomStatuses;
+
+  /**
+   * @description Sets custom status filters
+   * @param statuses 
+   */
+  private _setCustomStatus;
+
+  /**
+   * @description Sets custom priority filters
+   * @param priorities
+   * 
+   * @deprecated Use setCustomPriority instead
+   */
+  private _setCustomPriorities;
+
+  /**
+   * @description Sets custom priority filters
+   * @param priorities
+   */
+  private _setCustomPriority;
+
+  /**
+   * @description Sets custom categories filters
+   * @param categories
+   * 
+   * @deprecated Use setCustomCategory instead
+   */
+  private _setCustomCategories;
+
+  /**
+   * @description Sets custom categories filters
+   * @param categories
+   */
+  private _setCustomCategory;
+
+  /**
+   * To enable inbox mode
+   */
+  private _enableInboxMode;
+
+  /**
+   * To disable inbox mode
+   */
+  private _disableInboxMode;
+
+  /**
+   * To enable auto categorize feature
+   */
+  private _enableAutoCategorize;
+
+  /**
+   * To disable auto categorize feature
+   */
+  private _disableAutoCategorize;
+
+  /**
+   * To enable dark mode in comments
+   */
+  private _enableDarkMode;
+
+  /**
+   * To disable dark mode in comments
+   */
+  private _disableDarkMode;
+
+  /**
+   * @description Sets the comment context provider
+   * @param provider 
+   */
+  private _setContextProvider;
+
+  /**
+   * To enable suggestion mode
+   */
+  private _enableSuggestionMode;
+
+  /**
+   * To disable suggestion mode
+   */
+  private _disableSuggestionMode;
+}