Class SpaceSettings

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.SpaceSettings
@Generated("io.github.primelib.primecodegen") public class SpaceSettings extends Object
SpaceSettings

  • Field Details

    • routeOverrideEnabled

      protected Boolean routeOverrideEnabled
      Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

    • editor

      protected Editor editor

    • spaceKey

      protected String spaceKey

  • Constructor Details

    • SpaceSettings

      public SpaceSettings(Consumer<SpaceSettings> spec)
      Constructs a validated instance of SpaceSettings.
      Parameters:
      spec - the specification to process

    • SpaceSettings

      @Internal protected SpaceSettings()
      Protected no-args constructor for use by serialization frameworks.

    • SpaceSettings

      @Internal public SpaceSettings(Boolean routeOverrideEnabled, Editor editor, String spaceKey, Map<String,Object> additionalLinks)
      Constructs a validated instance of SpaceSettings.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using SpaceSettings(Consumer) instead.

      Parameters:
      routeOverrideEnabled - Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.
      editor - editor
      spaceKey - spaceKey
      additionalLinks - additionalLinks

  • Method Details

    • routeOverrideEnabled

      public Boolean routeOverrideEnabled()
      Fluent getter for routeOverrideEnabled.

      Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

      Returns:
      routeOverrideEnabled

    • routeOverrideEnabled

      public SpaceSettings routeOverrideEnabled(Boolean routeOverrideEnabled)
      Fluent setter for routeOverrideEnabled.

      Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

      Parameters:
      routeOverrideEnabled - routeOverrideEnabled
      Returns:
      this

    • getRouteOverrideEnabled

      public Boolean getRouteOverrideEnabled()
      Gets the value of routeOverrideEnabled.

      Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

      Returns:
      routeOverrideEnabled

    • setRouteOverrideEnabled

      public void setRouteOverrideEnabled(Boolean routeOverrideEnabled)
      Sets the value of routeOverrideEnabled.

      Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

      Parameters:
      routeOverrideEnabled - routeOverrideEnabled

    • editor

      public Editor editor()
      Fluent getter for editor.
      Returns:
      editor

    • editor

      public SpaceSettings editor(Editor editor)
      Fluent setter for editor.
      Parameters:
      editor - editor
      Returns:
      this

    • getEditor

      public Editor getEditor()
      Gets the value of editor.
      Returns:
      editor

    • setEditor

      public void setEditor(Editor editor)
      Sets the value of editor.
      Parameters:
      editor - editor

    • spaceKey

      public String spaceKey()
      Fluent getter for spaceKey.
      Returns:
      spaceKey

    • spaceKey

      public SpaceSettings spaceKey(String spaceKey)
      Fluent setter for spaceKey.
      Parameters:
      spaceKey - spaceKey
      Returns:
      this

    • getSpaceKey

      public String getSpaceKey()
      Gets the value of spaceKey.
      Returns:
      spaceKey

    • setSpaceKey

      public void setSpaceKey(String spaceKey)
      Sets the value of spaceKey.
      Parameters:
      spaceKey - spaceKey

    • additionalLinks

      public Map<String,Object> additionalLinks()
      Fluent getter for additionalLinks.
      Returns:
      additionalLinks

    • additionalLinks

      public SpaceSettings additionalLinks(Map<String,Object> additionalLinks)
      Fluent setter for additionalLinks.
      Parameters:
      additionalLinks - additionalLinks
      Returns:
      this

    • getAdditionalLinks

      public Map<String,Object> getAdditionalLinks()
      Gets the value of additionalLinks.
      Returns:
      additionalLinks

    • setAdditionalLinks

      public void setAdditionalLinks(Map<String,Object> additionalLinks)
      Sets the value of additionalLinks.
      Parameters:
      additionalLinks - additionalLinks

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object