@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.0

package/server/LandingPageUtil/index.d.ts

@@ -1,103 +1,100 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**
- * Gets the error page (404) of current site.
- * @return the error page, or null if current site has no such page specified.
+ * Utility interface for getting landing pages.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getLandingPageUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.5.1
  */
-export function getErrorPage(): Node;
+export interface LandingPageUtil {
+  /**
+   * Gets the error page (404) of current site.
+   * @return the error page, or null if current site has no such page specified.
+   */
+  getErrorPage(): Node;
 
-/**
- * Gets the login page (401) of current site.
- * @return the login page, or null if current site has no such page specified.
- */
-export function getLoginPage(): Node;
+  /**
+   * Gets the login page (401) of current site.
+   * @return the login page, or null if current site has no such page specified.
+   */
+  getLoginPage(): Node;
 
-/**
- * Gets the profile page (information about current/specified user identity) of current site.
- * @return the profile page, or null if current site has no such page specified.
- */
-export function getProfilePage(): Node;
+  /**
+   * Gets the profile page (information about current/specified user identity) of current site.
+   * @return the profile page, or null if current site has no such page specified.
+   */
+  getProfilePage(): Node;
 
-/**
- * Gets the contacts page (information about the contacts of current/specified user identity) of current site.
- * @return the contact page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getContactsPage(): Node;
+  /**
+   * Gets the contacts page (information about the contacts of current/specified user identity) of current site.
+   * @return the contact page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getContactsPage(): Node;
 
-/**
- * Gets the user identity search result page of current site.
- * @return the user identity search result page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getUserIdentitySearchResultPage(): Node;
+  /**
+   * Gets the user identity search result page of current site.
+   * @return the user identity search result page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getUserIdentitySearchResultPage(): Node;
 
-/**
- * Gets the files page (information about the files of a collaboration group) of current site.
- * @return the files page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getFilesPage(): Node;
+  /**
+   * Gets the files page (information about the files of a collaboration group) of current site.
+   * @return the files page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getFilesPage(): Node;
 
-/**
- * Gets the collaboration groups page (lists all accessible collaboration groups) of current site.
- * @return the collaboration groups page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getCollaborationGroupsPage(): Node;
+  /**
+   * Gets the collaboration groups page (lists all accessible collaboration groups) of current site.
+   * @return the collaboration groups page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getCollaborationGroupsPage(): Node;
 
-/**
- * Gets the members page (lists all members of a specified collaboration group) of current site.
- * @return the members page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getMembersPage(): Node;
+  /**
+   * Gets the members page (lists all members of a specified collaboration group) of current site.
+   * @return the members page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getMembersPage(): Node;
 
-/**
- * Gets the tag timeline page (displays the timeline for a specified tag) of current site.
- * @return the tag timeline page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getTagTimelinePage(): Node;
+  /**
+   * Gets the messages page of current site.
+   * @return the messages page, or null if current site has no such page specified.
+   * @since Sitevision 2023.1.1
+   */
+  getMessagesPage(): Node;
 
-/**
- * Gets the timeline entry page (displays a single timeline entry) of current site.
- * @return the timeline entry page, or null if current site has no such page specified.
- * @since Sitevision 6.0.1
- */
-export function getTimelineEntryPage(): Node;
+  /**
+   * Gets the tag timeline page (displays the timeline for a specified tag) of current site.
+   * @return the tag timeline page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getTagTimelinePage(): Node;
 
-/**
- * Gets the topic timeline page of current site.
- * @return the topic timeline page, or null if current site has no such page specified.
- * @since Sitevision 7.0
- */
-export function getTopicTimelinePage(): Node;
+  /**
+   * Gets the timeline entry page (displays a single timeline entry) of current site.
+   * @return the timeline entry page, or null if current site has no such page specified.
+   * @since Sitevision 6.0.1
+   */
+  getTimelineEntryPage(): Node;
 
-/**
- * Utility interface for getting landing pages.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getLandingPageUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.5.1
- */
-declare namespace landingPageUtil {
-  export {
-    getErrorPage,
-    getLoginPage,
-    getProfilePage,
-    getContactsPage,
-    getUserIdentitySearchResultPage,
-    getFilesPage,
-    getCollaborationGroupsPage,
-    getMembersPage,
-    getTagTimelinePage,
-    getTimelineEntryPage,
-    getTopicTimelinePage,
-  };
+  /**
+   * Gets the topic timeline page of current site.
+   * @return the topic timeline page, or null if current site has no such page specified.
+   * @since Sitevision 7.0
+   */
+  getTopicTimelinePage(): Node;
 }
 
+declare namespace LandingPageUtil {}
+
+declare var landingPageUtil: LandingPageUtil;
+
 export default landingPageUtil;

package/server/LandingPageUtil/index.js

@@ -13,6 +13,7 @@ var _default = {
   getFilesPage: function getFilesPage() {},
   getCollaborationGroupsPage: function getCollaborationGroupsPage() {},
   getMembersPage: function getMembersPage() {},
+  getMessagesPage: function getMessagesPage() {},
   getTagTimelinePage: function getTagTimelinePage() {},
   getTimelineEntryPage: function getTimelineEntryPage() {},
   getTopicTimelinePage: function getTopicTimelinePage() {}