Orb Methods
The methods defined in the Orb class are summarized in the following table.
| Method | Description |
|---|---|
| addDynamicTemplate |
Creates an instance of the specified class and associates it with the specified name in the Orb templating engine |
| addHeader | Adds an additional header to the request |
| addHtmlTemplate |
Loads the content at the specified path into the Orb templating engine and associates it with the specified template |
| addLiveRoute | Specifies a route that actions global live updates |
| addRoute |
Adds the specified class as a route with the specified HTTP method and URL path |
| addRouteWithParameters |
Adds the specified class as a route with the specified HTTP method and URL path, and specifies additional optional parameters that are passed in the URL path rather than the query string |
| addStylesheet | Loads cascading style sheet (CSS) content located at the specified path into the Orb templating engine and associates it with the specified template |
| addView |
Adds the specified class as a route with the GET and POST HTTP methods and URL path |
| addViewWithParameters |
Adds the specified class as a route with the GET and POST HTTP method and URL path, and specifies additional optional parameters that is passed in the URL path rather than the query string |
| addVirtualDirectory | Adds the specified directory as a virtual directory that is accessible from URLs starting with the specified path |
| bind | Invokes the Orb templating engine to expand the specified template with the specified object |
| bindCursor |
Invokes the Orb templating engine to bind the IOrbTemplateCursor specified by the cursor parameter with the specified object |
| bindRaw | Invokes the Orb templating engine to expand the specified template using the specified object (characters are not sanitized, however) |
| bindRawCursor |
Invokes the Orb templating engine to bind the IOrbTemplateCursor specified by the cursor parameter with the specified object (characters are not sanitized, however) |
| bindRawString | Invokes the Orb templating engine to expand the specified template content with the specified object (characters are not sanitized, however) |
| bindString | Invokes the Orb templating engine to expand the specified template content with the specified object |
| errorHandler | Specifies an object that implements the IOrbErrorHandler interface that is invoked to handle errors |
| liveUpdate | Starts live updates on the specified target (which can be any object or collection) |
| redirect | Instructs the requesting web browser to navigate to the specified path |
| sessionData | Retrieves the session data object associated with the current session |
| sessionDataCursor | Retrieves the session data object associated with the referenced session |
| sessionEnd | Terminates the active session and instructs the web browser to remove any cookies associated with it |
| sessionEndCursor | Terminates the referenced session |
| sessionStart | Starts a persistent session |
| setContentType |
Overrides the standard Content‑Type header for the request with the specified value |
| setDebug | Enables debug mode |
| setStatusCode |
Sets the HTTP status code of the response |
| setTitle |
Updates the title of a web page when called from an Orb trigger |
| strip |
Strips the specified prefix from any incoming requests when determining to which route to dispatch it |
| view | Responds to a request with an Orb view |
| wrap | Converts the specified value to a Binary representation suitable for being sent to the requesting web client to display |
