Package com.adobe.cq.wcm.core.components.models

Interface PWA

public interface PWA
Interface for reading progressive web apps configuration

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MANIFEST_NAME
    Name of the manifest file that provides information about the PWA
    static final String
    PN_PWA_ENABLED
    Name of the property that defines if PWA is enabled for the website.
    static final String
    PN_PWA_ICON_PATH
    Name of the property that defines the PWA icon
    static final String
    PN_PWA_START_URL
    Name of the property that defines the start URL of this PWA
    static final String
    PN_PWA_THEME_COLOR
    Name of the property that defines the theme color used.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getIconPath()
    The path to the icon of this PWA
    default String
    getManifestPath()
    The relative path to the web manifest
    default String
    getServiceWorkerPath()
    The relative path to the service worker
    default String
    getThemeColor()
    The theme color of the site sometimes used to color the address bar of the browser
    default boolean
    isEnabled()
    Returns true if PWA features are enabled false otherwise

  • Field Details

    • PN_PWA_ENABLED

      static final String PN_PWA_ENABLED
      Name of the property that defines if PWA is enabled for the website.
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0
      See Also:

    • PN_PWA_START_URL

      static final String PN_PWA_START_URL
      Name of the property that defines the start URL of this PWA
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0
      See Also:

    • PN_PWA_THEME_COLOR

      static final String PN_PWA_THEME_COLOR
      Name of the property that defines the theme color used.
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0
      See Also:

    • PN_PWA_ICON_PATH

      static final String PN_PWA_ICON_PATH
      Name of the property that defines the PWA icon
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0
      See Also:

    • MANIFEST_NAME

      static final String MANIFEST_NAME
      Name of the manifest file that provides information about the PWA
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0
      See Also:

  • Method Details

    • isEnabled

      default boolean isEnabled()
      Returns true if PWA features are enabled false otherwise
      Returns:
      whether PWA is enabled or not
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0

    • getThemeColor

      default String getThemeColor()
      The theme color of the site sometimes used to color the address bar of the browser
      Returns:
      A Hex String that represents the theme color for this site
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0

    • getIconPath

      default String getIconPath()
      The path to the icon of this PWA
      Returns:
      A String that represents the relative path to the icon of this site
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0

    • getManifestPath

      default String getManifestPath()
      The relative path to the web manifest
      Returns:
      A String that represents the relative path to the web manifest of this site
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0

    • getServiceWorkerPath

      default String getServiceWorkerPath()
      The relative path to the service worker
      Returns:
      A String that represents the path to the service worker used by this site
      Since:
      com.adobe.cq.wcm.core.components.models 12.19.0