@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/StructureUtil/index.d.ts

@@ -3,90 +3,172 @@ import type { Node } from "../../types/javax/jcr/Node";
 /**
  * Utility interface for alterations of the node structure.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getStructureUtil()}. See {@link senselogic.sitevision.api.Utils}
- *    for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     <strong>Note!</strong> Use {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to
+ *     <em>"move a Node to the Trashcan"</em> or <em>"restore a Node from the Trashcan".</em>
+ *  </p>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getStructureUtil()}. See {@link senselogic.sitevision.api.Utils}
+ *     for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
 export interface StructureUtil {
   /**
    * <p>
-   *    Moves a node from the current parent to another in the node structure.
-   * </p>
-   * <p>
-   *    Currently supported node types are:
-   * </p>
-   * <ul>
-   *    <li><code>sv:article</code></li>
-   *    <li><code>sv:archive</code></li>
-   *    <li><code>sv:file</code></li>
-   *    <li><code>sv:folder</code></li>
-   *    <li><code>sv:image</code></li>
-   *    <li><code>sv:link</code></li>
-   *    <li><code>sv:page</code></li>
-   *    <li><code>sv:template</code></li>
-   * </ul>
+   *     Moves a node from the current parent to another in the node structure.
+   *  </p>
    *
-   * <p>
-   *    The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
-   * </p>
+   *  <p>
+   *     <strong>Trashcan note!</strong> A Node that resides in the Trashcan can <em>not</em> be moved.
+   *     Also, a Node can <em>not</em> be moved to the Trashcan (or to any Node that resides in the Trashcan).
+   *     Use {@link TrashcanUtil} to move a Node to the Trashcan or restore a Node from the Trashcan.
+   *  </p>
    *
-   * <pre>
-   *    Node        - allowed parents
-   *    ------------------------------------------------------------------------------------------------------
-   *    sv:article  - sv:archive
-   *    sv:archive  - sv:sitePage, sv:page, sv:folder, sv:article
-   *    sv:file     - sv:folder, *fileRepos
-   *    sv:folder   - sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, *fileRepos
-   *    sv:image    - sv:folder, *fileRepos
-   *    sv:link     - sv:sitePage, sv:page, sv:folder, sv:article
-   *    sv:page     - sv:sitePage, sv:page, sv:folder, sv:article
-   *    sv:template - sv:folder, sv:templateRepository
+   *  <p>
+   *     Currently supported node types are:
+   *  </p>
+   *  <ul>
+   *     <li><code>sv:article</code></li>
+   *     <li><code>sv:archive</code></li>
+   *     <li><code>sv:collaborationGroupPage</code> <em>(since Sitevision 2023.02.1)</em></li>
+   *     <li><code>sv:file</code></li>
+   *     <li><code>sv:folder</code></li>
+   *     <li><code>sv:image</code></li>
+   *     <li><code>sv:link</code></li>
+   *     <li><code>sv:page</code></li>
+   *     <li><code>sv:template</code></li>
+   *  </ul>
    *
-   *    Node        - allowed root nodes
-   *    ------------------------------------------------------------------------------------------------------
-   *    sv:archive  - sv:sitePage
-   *    sv:article  - sv:sitePage
-   *    sv:file     - *fileRepos
-   *    sv:folder   - sv:sitePage, sv:templateRepository, *fileRepos
-   *    sv:image    - *fileRepos
-   *    sv:link     - sv:sitePage
-   *    sv:page     - sv:sitePage
-   *    sv:template - sv:templateRepository
+   *  <p>
+   *     The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
+   *  </p>
    *
-   *    *fileRepos corresponds to sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository
-   * </pre>
+   *  <p>
+   *     <strong>Parent restrictions</strong>
+   *  </p>
+   *  <table summary="Parent restrictions">
+   *     <tr>
+   *        <th scope="col">Node</th>
+   *        <th scope="col">Allowed parents</th>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:article</code></td>
+   *        <td><code>sv:archive</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:archive</code></td>
+   *        <td><code>sv:sitePage, sv:page, sv:folder, sv:article</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:collaborationGroupPage</code></td>
+   *        <td><code>sv:collaborationGroupFolder</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:file</code></td>
+   *        <td><code>sv:folder, <em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:folder</code></td>
+   *        <td><code>sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, <em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:image</code></td>
+   *        <td><code>sv:folder, <em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:link</code></td>
+   *        <td><code>sv:sitePage, sv:page, sv:folder, sv:article</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:page</code></td>
+   *        <td><code>sv:sitePage, sv:page, sv:folder, sv:article</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:template</code></td>
+   *        <td><code>sv:folder, sv:templateRepository</code></td>
+   *     </tr>
+   *  </table>
    *
-   * <p>
-   *    If the node or the parent is null a <code>NullPointerException</code> is thrown.
-   * </p>
+   *  <p>
+   *     <strong>Root restrictions</strong>
+   *  </p>
+   *  <table summary="Root restrictions">
+   *     <tr>
+   *        <th scope="col">Node</th>
+   *        <th scope="col">Allowed root nodes</th>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:article</code></td>
+   *        <td><code>sv:sitePage</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:archive</code></td>
+   *        <td><code>sv:sitePage</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:collaborationGroupPage</code></td>
+   *        <td><code>sv:sitePage</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:file</code></td>
+   *        <td><code>sv:folder, <em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:folder</code></td>
+   *        <td><code>sv:sitePage, sv:templateRepository, <em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:image</code></td>
+   *        <td><code><em>*fileRepos</em></code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:link</code></td>
+   *        <td><code>sv:sitePage</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:page</code></td>
+   *        <td><code>sv:sitePage</code></td>
+   *     </tr>
+   *     <tr>
+   *        <td><code>sv:template</code></td>
+   *        <td><code>sv:templateRepository</code></td>
+   *     </tr>
+   *  </table>
+   *  <p>
+   *     <em>(*fileRepos corresponds to <code>sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository</code>)</em>
+   *  </p>
    *
-   * <p>
-   *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
-   *    If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If the node or the parent is null a <code>NullPointerException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
-   *    If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *  <p>
+   *     Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
+   *     If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *  <p>
+   *     Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
+   *     If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    <em>
-   *       Note! The move operation will be ignored if the node is already a child of the parent.
-   *    </em>
-   * </p>
+   *  <p>
+   *     If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     <em>
+   *        Note! The move operation will be silently ignored if the node is already a child of the parent.
+   *     </em>
+   *  </p>
    * @param aNode the node that is to be moved. May not be <code>null</code>
    * @param aParent the new parent node. May not be <code>null</code>
-   * @throws ConstraintViolationException if current user is not authorized to move aNode to aParent or if an invalid structure would be result of the operation
+   * @throws ConstraintViolationException if current user is not authorized to move aNode to aParent&#xA; or if an invalid structure would be result of the operation
    * @throws RepositoryException if something else goes wrong
    */
   moveNode(aNode: Node, aParent: Node): void;

package/server/SubscriberUtil/index.d.ts

@@ -1,31 +1,33 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { Set } from "../../types/java/util/Set";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * <p>
- *    Subscriber utility interface.
- * </p>
+ *     Subscriber utility interface.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getSubscriberUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getSubscriberUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  *
- * <p>
- *    To find an active subscription, use the property <code>isActiveSubscription</code> or the convenience method
- *    {@link SubscriptionUtil#getActiveSubscription}. An active subscription is either <code>sv:site</code>, <code>sv:page</code>,
- *    <code>sv:archive</code> or <code>sv:article</code> where the subscription functionality has been activated.
- *    More information about subscriptions can be found in the Sitevision help pages.
- * </p>
+ *  <p>
+ *     To find an active subscription, use the property <code>isActiveSubscription</code> or the convenience method
+ *     {@link SubscriptionUtil#getActiveSubscription}. An active subscription is either <code>sv:site</code>, <code>sv:page</code>,
+ *     <code>sv:archive</code> or <code>sv:article</code> where the subscription functionality has been activated.
+ *     More information about subscriptions can be found in the Sitevision help pages.
+ *  </p>
  *
- * <p>
- *    A subscriber is either an e-mail or a phone number. Phone number is only available if the Sitevision licence
- *    contains the feature "sms".
- * </p>
+ *  <p>
+ *     A subscriber is either an e-mail or a phone number. Phone number is only available if the Sitevision licence
+ *     contains the feature "sms".
+ *  </p>
  *
- * <p>
- *    The write methods are fully synchronized and will never throw <code>ConcurrentModificationExceptions</code>.
- * </p>
+ *  <p>
+ *     The write methods are fully synchronized and will never throw <code>ConcurrentModificationExceptions</code>.
+ *  </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_10
  */
@@ -33,56 +35,65 @@ export interface SubscriberUtil {
   /**
    * <p>Access to a <code>Set</code> of subscribers (i.e. e-mail and / or phone numbers) for an active subscription.</p>
    *
-   * <p>This method will never throw exceptions.</p>
+   *  <p>This method will never throw exceptions.</p>
    * @param anActiveSubscription the active subscription <code>Node</code>
    * @return a <code>Set</code> of <code>String</code> with the subscribers. Will never return <code>null</code>
    */
-  getSubscribers(anActiveSubscription: Node): unknown;
+  getSubscribers(anActiveSubscription: Node): Set;
 
   /**
    * <p>
-   *    Method used to add an e-mail or phone number as a subscriber to the active subscription.
-   *    If the subscriber is already a subscriber nothing will be done.
-   * </p>
+   *     Method used to add an e-mail or phone number as a subscriber to the active subscription.
+   *     If the subscriber is already a subscriber nothing will be done.
+   *  </p>
    *
-   * <p>
-   *    This method will not throw exceptions.
-   * </p>
+   *  <p>
+   *     This method will not throw exceptions.
+   *  </p>
    * @param anActiveSubscription the active subscription <code>Node</code>
    * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
    * @return indicates that the subscriber is available as a subscriber after the operation
    */
-  addSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
+  addSubscriber(
+    anActiveSubscription: Node,
+    aSubscriber: String | string
+  ): boolean;
 
   /**
    * <p>
-   *    Removes an e-mail or phone number from the subscribers of the active subscription.
-   *    If the subscriber is not a subscriber nothing will be done.
-   * </p>
+   *     Removes an e-mail or phone number from the subscribers of the active subscription.
+   *     If the subscriber is not a subscriber nothing will be done.
+   *  </p>
    *
-   * <p>
-   *    This method will not throw exceptions.
-   * </p>
+   *  <p>
+   *     This method will not throw exceptions.
+   *  </p>
    * @param anActiveSubscription the active subscription <code>Node</code>
    * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
    * @return indicates that the subscriber is not available as a subscriber after the operation
    */
-  removeSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
+  removeSubscriber(
+    anActiveSubscription: Node,
+    aSubscriber: String | string
+  ): boolean;
 
   /**
    * <p>
-   *    Finds out if an e-mail of phone number is already a subscriber to the active subscription.
-   *    Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
-   * </p>
+   *     Finds out if an e-mail of phone number is already a subscriber to the active subscription.
+   *     Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
+   *  </p>
    *
-   * <p>
-   *    This method will not throw exceptions.
-   * </p>
+   *  <p>
+   *     This method will not throw exceptions.
+   *  </p>
    * @param anActiveSubscription the active subscription <code>Node</code>
    * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
    * @return indicates that the subscriber already is a subscriber to the active subscription
    */
-  isSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
+  isSubscriber(
+    anActiveSubscription: Node,
+    aSubscriber: String | string
+  ): boolean;
 }
 
 declare namespace SubscriberUtil {}

package/server/SubscriptionUtil/index.d.ts

@@ -1,48 +1,50 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
+import type { String } from "../../types/java/lang/String";
+
 /**
  * <p>
- *    Subscription utility interface.
- * </p>
+ *     Subscription utility interface.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getSubscriptionUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getSubscriptionUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_10
  */
 export interface SubscriptionUtil {
   /**
    * <p>Returns the active subscription <code>Node</code> of a <code>Node</code>. An active subscription
-   * is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
-   * the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
+   *  is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
+   *  the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
    *
-   * <p>
-   * <code>
-   * ex: from the sitevision navigator <br>
-   * - server <br>
-   * ---site A (subscription activated, including all children) <br>
-   * -----page 1 <br>
-   * -------archive X (subscription activated, including all children) <br>
-   * ---------article V <br>
-   * -----page 2 (subscription activated) <br>
-   * -------page 21 <br>
-   * <br>
-   * getActiveSubscription(site A) -&gt; site A <br>
-   * getActiveSubscription(page 1) -&gt; site A <br>
-   * getActiveSubscription(archive X) -&gt; archive X <br>
-   * getActiveSubscription(article V) -&gt; archive X <br>
-   * getActiveSubscription(page 2) -&gt; page 2 <br>
-   * getActiveSubscription(page 21) -&gt; null <br>
-   * </code>
-   * </p>
+   *  <p>
+   *  <code>
+   *  ex: from the sitevision navigator <br>
+   *  - server <br>
+   *  ---site A (subscription activated, including all children) <br>
+   *  -----page 1 <br>
+   *  -------archive X (subscription activated, including all children) <br>
+   *  ---------article V <br>
+   *  -----page 2 (subscription activated) <br>
+   *  -------page 21 <br>
+   *  <br>
+   *  getActiveSubscription(site A) -&gt; site A <br>
+   *  getActiveSubscription(page 1) -&gt; site A <br>
+   *  getActiveSubscription(archive X) -&gt; archive X <br>
+   *  getActiveSubscription(article V) -&gt; archive X <br>
+   *  getActiveSubscription(page 2) -&gt; page 2 <br>
+   *  getActiveSubscription(page 21) -&gt; null <br>
+   *  </code>
+   *  </p>
    *
-   * <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
-   * method is simply convenience to find the active <code>Node</code>.</p>
+   *  <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
+   *  method is simply convenience to find the active <code>Node</code>.</p>
    *
-   * <p>This method will never throw exceptions</p>
+   *  <p>This method will never throw exceptions</p>
    * @param aNode a <code>Node</code> in the navigation (e.g. a sv:page or an sv:article)
    * @return a <code>Node</code> with activated subscription or <code>null</code> if not available
    */
@@ -51,13 +53,13 @@ export interface SubscriptionUtil {
   /**
    * <p>Activates a subscription for the given <code>Node</code>.</p>
    *
-   * <p>The current user must have write subscription permission to activate subscriptions.</p>
+   *  <p>The current user must have write subscription permission to activate subscriptions.</p>
    * @param aNode the <code>Node</code> to activate a subscription for.
    * @param subtreeScope true if activation should include subnodes, false otherwise.
    * @param title the subscription title.
    * @param description the subscription description.
    * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
-   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a&#xA; subscriptionable node.
    * @throws RepositoryException if something else goes wrong.
    * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
    * @since Sitevision 2.6.2_05
@@ -65,17 +67,17 @@ export interface SubscriptionUtil {
   activateSubscription(
     aNode: Node,
     subtreeScope: boolean,
-    title: string,
-    description: string
+    title: String | string,
+    description: String | string
   ): void;
 
   /**
    * <p>Deactivates the subscription for the given <code>Node</code>.</p>
    *
-   * <p>The current user must have write subscription permission to deactivate subscriptions.</p>
+   *  <p>The current user must have write subscription permission to deactivate subscriptions.</p>
    * @param aNode the <code>Node</code> to deactivate the subscription for.
    * @throws RepositoryException if the current user isn't allowed to modify subscriptions.
-   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't&#xA; a subscriptionable node.
    * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
    * @since Sitevision 2.6.2_05
    */
@@ -84,52 +86,52 @@ export interface SubscriptionUtil {
   /**
    * <p>Configures email properties for the subscription on the given node.</p>
    *
-   * <p>The current user must have write subscription permission to configure subscription email.</p>
+   *  <p>The current user must have write subscription permission to configure subscription email.</p>
    * @param aNode the <code>Node</code> to configure.
    * @param from name of the sender.
    * @param fromAddress email address of the sender.
    * @param subject the email subject.
    * @param footer the email footer
    * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
-   * @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't a subscriptionable node, if <code>fromAddress</code> is null or not a valid email adress.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't&#xA; a subscriptionable node, if <code>fromAddress</code> is null or not a&#xA; valid email adress.
    * @throws RepositoryException if something else goes wrong.
    * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
    * @since Sitevision 2.6.2_05
    */
   configureSubscriptionEmail(
     aNode: Node,
-    from: string,
-    fromAddress: string,
-    subject: string,
-    footer: string
+    from: String | string,
+    fromAddress: String | string,
+    subject: String | string,
+    footer: String | string
   ): void;
 
   /**
    * Notifies the subscribers of a given node with an active subscription.
    *
-   * <p>
-   *    This method will use the settings of the active subscription to send mail notifications to all subscribers.
-   *    A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
-   *    <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
-   *    used to create the actual <em>body</em> of the notification. The mail template for an active subscription
-   *    will typically include something like this:
-   * </p>
-   * <ol>
-   *    <li>A <em>notification</em> text</li>
-   *    <li>The <em>URL</em> of the node</li>
-   *    <li>The mail <em>footer</em></li>
-   * </ol>
-   * <p>
-   *    The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
-   *    In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
-   *    contain the <em>URL</em> and the <em>footer</em> only.
-   * </p>
+   *  <p>
+   *     This method will use the settings of the active subscription to send mail notifications to all subscribers.
+   *     A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
+   *     <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
+   *     used to create the actual <em>body</em> of the notification. The mail template for an active subscription
+   *     will typically include something like this:
+   *  </p>
+   *  <ol>
+   *     <li>A <em>notification</em> text</li>
+   *     <li>The <em>URL</em> of the node</li>
+   *     <li>The mail <em>footer</em></li>
+   *  </ol>
+   *  <p>
+   *     The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
+   *     In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
+   *     contain the <em>URL</em> and the <em>footer</em> only.
+   *  </p>
    * @param aNode a <code>Node</code> that has an active subscription, typically a sv:page or sv:article
    * @param aNotificationText the notification text
-   * @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
+   * @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise&#xA; (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
    * @since Sitevision 3.6.3
    */
-  notifySubscribersOf(aNode: Node, aNotificationText: string): boolean;
+  notifySubscribersOf(aNode: Node, aNotificationText: String | string): boolean;
 }
 
 declare namespace SubscriptionUtil {}