References
System Keywords
General Keywords
Built-in keywords that are available in all scripting contexts.
| Name | Description |
|---|---|
applicationRootPath | Refers to the root path of the Structr application. |
applicationStore | Application-wide data store. |
baseUrl | Refers to the base URL for this Structr application. |
current | Refers to the object returned by URI Object Resolution, if available. |
host | Refers to the host name of the server that Structr runs on. |
ip | Refers to the IP address of the interface on which the request was received. |
locale | Refers to the current locale. |
me | Refers to the current user. |
now | Refers to the current timestamp. |
parameterMap | Refers to the HTTP request parameters of the current request. |
pathInfo | Refers to the HTTP path string of the current request. |
predicate | Refers to the set of query predicates for advanced find(). |
queryString | Refers to the HTTP query string of the current request. |
request | Refers to the current set of HTTP request parameters. |
session | Refers to the current HTTP session. |
tenantIdentifier | Refers to the tenant identifier configured in structr.conf. |
this | Refers to the enclosing object instance of the currently executing method or script. |
Markdown Rendering Hint: Children of Topic(General Keywords) not rendered because MarkdownTableFormatter prevents rendering of children.
Page Keywords
Built-in keywords that are available in page rendering contexts.
| Name | Description |
|---|---|
children | Refers to the child nodes of the current node. |
id | Refers to the id of the object returned by URI Object Resolution, if available. |
link | Refers to the linked filesystem element of an HTML element in a Page. |
page | Refers to the current page in a page rendering context. |
parent | Refers to the parent element of the current in a page rendering context. |
Markdown Rendering Hint: Children of Topic(Page Keywords) not rendered because MarkdownTableFormatter prevents rendering of children.
Special Keywords
Built-in keywords that are only available in special contexts.
| Name | Description |
|---|---|
data | Refers to the current element in an each() loop iteration or in a filter() expression. |
methodParameters | Refers to the arguments a method was called with. |
value | Refers to the input value in the write function of a Function property. |
Markdown Rendering Hint: Children of Topic(Special Keywords) not rendered because MarkdownTableFormatter prevents rendering of children.