- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
Class ::xo::Package
::xo::Packagecreate ... \
[ -context (default "::xo::cc") ] \
[ -force_refresh_login (default "false") ] \
[ -id:integer id:integer ] \
[ -package_url package_url ] \
[ -url url ]
Defined in
Class Relations
- class: ::xo::PackageMgr
- superclass: ::xo::db::Object
- subclass: ::xo::oauth::Package
, ::xowiki::Package
Methods (to be applied on instances)
initialize (scripted, public)
<instance of xo::Package> initialize
Hook for subclass-specific package initialization. The base method does nothing.
- Testcases:
- create_form_with_form_instance
reply_to_user (scripted, public)
<instance of xo::Package> reply_to_user text
Apply the HTTP caching policy and run any pending continuation. Otherwise, send the response through the package delivery handler.
- Parameters:
- text (required)
- Response body.
- Testcases:
- create_folder_with_page, create_workflow_with_instance, create_form_with_form_instance
require_root_folder (scripted, public)
<instance of xo::Package> require_root_folder \ [ -parent_id parent_id ] [ -content_types content_types ] \ -name name
Make sure, the root folder for the given package exists. If not, create it and register all allowed content types. Note that xowiki (and derived packages) define their own version of "require_root_folder" based on form pages. Therefore, this function is just for packages not based on xowiki.
- Switches:
- -parent_id (optional, defaults to
"-100")- -content_types (optional)
- -name (required)
- Returns:
- folder_id
- Testcases:
- xowiki_test_cases
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
![[i]](/resources/acs-subsite/ZoomIn16.gif)