homotechsual · 6349d3b5 · 6349d3b5 · 6349d3b5 · 6349d3b5 · 6349d3b5
--- a/docs/api/v4/architecture.md
+++ b/docs/api/v4/architecture.md
+   - The `$_entityName` and `$_actionName` vars are set when the Action object is constructed (by the Entity class factory fn, see above). The underscore makes them hidden parameters as they cannot be changed. 
+   - Adding a `protected` var to your Action named e.g. `$thing` will automatically:
+       - Provide a getter/setter (via `__call` MagicMethod) named `getThing()` and `setThing()`.
+       - Expose the param in the Api Explorer (be sure to add a doc-block as it displays in the help panel).
+       - Require a value for the param if you add the `@required` annotation.
+
+2.  Define a `_run()` function to execute the call and return the results.
+   - The `_run()` function is invoked by `execute()`
+   - It gets passed a `Result` object into which it places an array of values from whatever logic it executes.
+   
+## The Result Class
+
+An API [`Result`](https://github.com/civicrm/civicrm-core/blob/master/Civi/Api4/Generic/Result.php) is a PHP ArrayObject. It has three functions:
+
+1.  Store the results of the API call (accessible via ArrayAccess).
+
--- a/docs/api/v4/architecture.md
+++ b/docs/api/v4/architecture.md
+       - Expose the param in the Api Explorer (be sure to add a doc-block as it displays in the help panel).
+       - Require a value for the param if you add the `@required` annotation.
+
+2.  Define a `_run()` function to execute the call and return the results.
+   - The `_run()` function is invoked by `execute()`
+   - It gets passed a `Result` object into which it places an array of values from whatever logic it executes.
+   
+## The Result Class
+
+An API [`Result`](https://github.com/civicrm/civicrm-core/blob/master/Civi/Api4/Generic/Result.php) is a PHP ArrayObject. It has three functions:
+
+1.  Store the results of the API call (accessible via ArrayAccess).
+
+2.  Store metadata like the Entity & Action names.
+   - Some actions extend the Result object to store extra metadata. For example [`BasicReplaceAction`](https://github.com/civicrm/civicrm-core/blob/master/Civi/Api4/Generic/BasicReplaceAction.php) returns [`\Civi\Api4\Result\ReplaceResult`](https://github.com/civicrm/civicrm-core/blob/master/Civi/Api4/Result/ReplaceResult.php) which includes the additional `$deleted` property to list any items deleted by the operation.
+