Update Quick Reference
Automatic update system for OpenForum pages and AddOns from parent servers
Key Features
- Check for available updates
- Download and install updates
- Version tracking
- Dependency management
- Automatic update capability
- Release notes display
- Update history tracking
- Parent server synchronization
Server-Side Usage:
<![CDATA[
// Get the Update API
var Update = js.getObject("/OpenForum/AddOn/Update","Update.sjs");
// Check for updates
var updateInfo = Update.getUpdateInfo("/MyPage");
// Get update from parent server
Update.getUpdate("/MyPage");
// List available updates
var updates = Update.listAvailableUpdates();
// Install update
Update.installUpdate("/MyPage", "1.2.0");
// Check if update available
var isAvailable = Update.isUpdateAvailable("/MyPage");
]]>
Client-Side Usage:
<![CDATA[
// Get update info
JSON.get('/OpenForum/AddOn/Update/Info', null,
'pageName=/MyPage')
.onSuccess(function(info) {
console.log('Update info:', info);
console.log('Version:', info.version);
console.log('Release notes:', info.notes);
}).go();
// Download and install update
JSON.post('/OpenForum/AddOn/Update/Get', null,
'pageName=/MyPage')
.onSuccess(function(result) {
console.log('Update installed:', result);
}).go();
// List all available updates
JSON.get('/OpenForum/AddOn/Update/List')
.onSuccess(function(updates) {
console.log('Available updates:', updates);
}).go();
]]>
Update Info Format
<![CDATA[
{
pagename: "/MyPage",
version: "1.2.0",
releaseTime: "2025-01-15",
zipfilesize: 52341,
extra: {
notes: "Bug fixes and improvements",
requires: [
{pageName: "/OpenForum/Core", version: "2.0"}
]
},
autoUpdate: true
}
]]>
Configuration
- Parent host URL
- Auto-update settings
- Update check frequency
- Dependency resolution