Skip to main content
Kinetic Community

Space Model

The form object represents the Space that is being accessed. Many of the properties and methods are accessible within the bundle.

Properties

afterLogoutPath

The route to redirect the user after logging out of the application from somewhere within the space.

${space.afterLogoutPath}

attributes

A list of all attributes applied to the space.

${space.attributes}

bridgeModels

A list of bridge models for the space.

${space.bridgeModels}

bridges

A list of bridges for the space.

${space.bridges}

displayType

Indicates the type of action that should happen when a user navigates to the home page of a Space. Possible actions are to display a JSP page, or to redirect to a URL.

  • Display Page
  • Redirect
${space.displayType}

displayValue

The value that corresponds to the displayType property. When Display Page is selected, it indicates the name of the JSP page to render within the Space bundle. The implicit default is space.jsp. When Redirect is selected, the application will redirect the user to the URL indicated by this value

${space.displayValue}

filestore

Returns the File Store object that includes information about how file attachments are stored for this space.

${space.filestore}

kapps

A list of kapps in the space.

${space.kapps}

loginPage

The name of the JSP to use when logging into the application while trying to access the Space. The application will search for this JSP file in the Space bundle path. If not provided, the application will search for the implicit default login.jsp within the bundle path. If that JSP does not exist, the built-in application login page will be rendered.

${space.loginPage}

name

The name of the Space.

${space.name}

resetPasswordPage

The name of the JSP to use for resetting a user’s password. The application will search for this JSP file in the space bundle path. If not provided, the application will search for the implicit default resetPassword.jsp within the space bundle path. If that JSP does not exist, the built-in application reset password page will be rendered.

${space.resetPasswordPage}

sessionInactiveLimitInSeconds

The number of seconds a user session remains valid before it times out. This is configurable per space.

${space.sessionInactiveLimitInSeconds}

slug

The slug value of the space. This value must be unique within the application.

${space.slug}

spaceAttributeDefinitions

A list of attribute definitions that apply to the Space.

${space.spaceAttributeDefinitions}

userAttributeDefinitions

A list of attribute definitions that apply to Users in the space.

${space.userAttributeDefinitions}

Methods

getAttribute(name)

Returns the attribute identified by the name parameter if it exists.

${space.getAttribute(name)}

getAttributeValue(name)

Returns the value of the attribute identified by the name parameter if it exists and if the attribute only supports a single value. This is a shortcut for ${space.getAttribute(name).value} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${space.getAttributeValue(name)}

getAttributeValues(name)

Returns a list of values of the attribute identified by the name parameter if it exists and if the attribute support multiple values. This is a shortcut for ${space.getAttribute(name).values} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${space.getAttributeValues(name)}

hasAttribute(name)

Tests if the attribute identified by the name parameter exists. Returns true if the attribute does exist, otherwise false.

${space.hasAttribute(name)}

hasAttributeValue(name, value)

Tests if the attribute identified by the name parameter has the value identified by the value parameter. Returns true if the attribute does have the value, otherwise false.

${space.hasAttributeValue(name, value)}

getBridgeModel(name)

Returns the Bridge Model object identified by the name parameter.

${space.getBridgeModel(name)}

getBridgeModelMapping(modelName, mappingName)

Returns the Bridge Model Mapping object that corresponds to the bridge model object identified by the modelName parameter, and the bridge model mapping object identified by the mappingName parameter.

${space.getBridgeModelMapping(modelName, mappingName)}

getBridge(name)

Returns the Bridge object identified by the name parameter.

${space.getBridge(name)}

getKapp(slug)

Returns the Kapp object identified by the slug parameter.

${space.getKapp(slug)}

getSpaceAttributeDefinition(name)

Returns the Attribute Definition object that corresponds to the name parameter, and is Space type.

${space.getSpaceAttributeDefinition(name)}

getUserAttributeDefinition(name)

Returns the Attribute Definition object that corresponds to the name parameter, and is User type.

${space.getUserAttributeDefinition(name)}

Related