API:SCM - Revision history

Utf: Reverted edits by 94.233.241.205 (talk) to last revision by 178.34.160.137

2023-05-16T16:35:42Z

Reverted edits by 94.233.241.205 (talk) to last revision by 178.34.160.137

Show changes

94.233.241.205: SEXX

2023-05-16T06:57:50Z

SEXX

Show changes

178.34.160.137 at 21:36, 28 June 2022

2022-06-28T21:36:26Z

← Older revision		Revision as of 23:36, 28 June 2022
Line 140:		Line 140:
	return await WApplication.execAsync(new ListingProgramBasic(), this.boxedEnv.args);		return await WApplication.execAsync(new ListingProgramBasic(), this.boxedEnv.args);
	</syntaxhighlight>		</syntaxhighlight>
			[[Category:API]]

Ctrl: /* Object Listing */

2022-02-21T15:39:40Z

Object Listing

← Older revision		Revision as of 17:39, 21 February 2022
Line 101:		Line 101:
	=== Object Listing ===		=== Object Listing ===
	Basic GUI program listing all the objects in the specified path.<syntaxhighlight lang="javascript" line="1">		Basic GUI program listing all the objects in the specified path.<syntaxhighlight lang="javascript" line="1">
			//!wrt
	const { sysConf: SCM } = w96;		const { sysConf: SCM } = w96;
	const { Theme } = w96.ui;		const { Theme } = w96.ui;

Ctrl at 15:39, 21 February 2022

2022-02-21T15:39:21Z

@@ Line 68: / Line 68: @@
 === Basic CRUD ===
-Below is a simple program demonstrating simple CRUD operations.<syntaxhighlight lang="javascript">
+Below is a simple program demonstrating simple CRUD operations.<syntaxhighlight lang="javascript" line="1">
 const { sysConf: SCM } = w96;
@@ Line 97: / Line 97: @@
      console.log("There is no boolean.");
+}
 </syntaxhighlight>

Ctrl: Update SCM api

2022-02-21T15:28:13Z

Update SCM api

New page

This is the SCM API Reference, an API used to manipulate the current system configuration. Read more about SCM [[System Configuration Manager|here]].

== Function Table ==
All SCM functions are contained within the <code>w96.sysConf</code> namespace.
{| class="wikitable"
!Call
!Arguments
!Returns
!Description
|-
|loadAll
|None
|Promise<void>
|Loads the SCM configuration from disk. System reserved.
|-
|createRoot
|name:String, description:String
|None
|Creates a configuration root. System reserved.
|-
|syncAll
|None
|Promise<void>
|Synchronizes the current SCM configuration to disk.
|-
|syncRoot
|name:String
|Promise<void>
|Synchronizes changes to a configuration root to disk. This is recommended over syncAll(), if you know the specific roots you will be working on.
|-
|getIndex
|name:String
|Index Object
|Returns the index of the specified configuration root name.
|-
|get
|path: String
|Any
|Returns the value of the specified path.
|-
|set
|path: String, value: any
|None
|Sets the value for the specified path.
|-
|setAndSync
|path: String, value: any
|Promise<void>
|Same as set(), but synchronizes changes to root after set.
|-
|remove
|path: String
|Boolean
|Removes the specified path. Returns a boolean specifiying if the removal was successful.
|-
|removeAndSync
|path: String
|Promise<boolean>
|Same as remove(), but synchronizes changes to root after removal.
|-
|ls
|path: String
|List of keys
|Returns the keys in the specified path. If path is left empty, this will return a list of roots.
|}

== Examples ==

=== Basic CRUD ===
Below is a simple program demonstrating simple CRUD operations.<syntaxhighlight lang="javascript">
const { sysConf: SCM } = w96;

// Test if the key exists
// We use this conditional to set any default values
if(!SCM.get("Software/TestSoftware")) {
// Key does not exist, set some default values
SCM.set("Software/TestSoftware/Hello", "World");
SCM.set("Software/TestSoftware/Number", 2);
SCM.set("Software/TestSoftware/True", true);

// Commit changes
await SCM.syncRoot("Software");
}

// Echo back the configuration values
alert(`Hello = ${SCM.get("Software/TestSoftware/Hello")}<br>
Number = ${SCM.get("Software/TestSoftware/Number")}<br>
True = ${SCM.get("Software/TestSoftware/True")}`);

// Update the number
await SCM.setAndSync("Software/TestSoftware/Number", SCM.get("Software/TestSoftware/Number") + 1);

// Delete the boolean
if(await SCM.removeAndSync("Software/TestSoftware/True")) {
console.log("The boolean is gone.");
} else {
console.log("There is no boolean.");
}
</syntaxhighlight>