Constructor that creates a ComponentsRuleEngine instance.
The UUID of the locally running Instance.
The UUID of the local device Device.
An object with the set of restrictions that must met when ditributing the UI components automatically. If no restrictions are provided, an empty restrictions object is assumed.
The proxemic information and capabilities of a device, i.e., if a device is present in the environment this object should contain a key with its UUID that points to an object that represents the device capabilities. If no proxemics are provided, an empty proxemics object is assumed.
An array of the instances that the user currently has access to. If no instance are provided, an empty array of instances is assumed.
Infer additional device capabilities from the ones that are known.
Matches a certain components agains all the information about devices, restrictions and proxemics to determine whether it should be shown (true) or not (false).
"Getter" and "setter" for the internal 'node-rules' engine.
"Getter" and "setter" for the internal 'node-rules' engine.
"Getter" and "setter" of an object representing the distribution of components of the local instance where the keys represent the name of the components and the boolean values represent whether the components is shown (true) or not (false).
"Getter" and "setter" of an object representing the distribution of components of the local instance where the keys represent the name of the components and the boolean values represent whether the components is shown (true) or not (false).
"Getter" and "setter" of the array of instances that the user currently has access to.
"Getter" and "setter" of the array of instances that the user currently has access to.
"Getter" and "setter" of the proxemic information and capabilities of a device, i.e., if a device is present in the environment this object should contain a key with its UUID that points to an object that represents the device capabilities.
"Getter" and "setter" of the proxemic information and capabilities of a device, i.e., if a device is present in the environment this object should contain a key with its UUID that points to an object that represents the device capabilities.
"Getter" and "setter" of the object with the set of restrictions that must met when ditributing the UI components automatically.
"Getter" and "setter" of the object with the set of restrictions that must met when ditributing the UI components automatically.
Runs the distribution algorithm using the information currently stored on the ComponentsRuleEngine properties.
Whether it shoud ignore the manual distribution, forcing automatic distribtution to be performed anyway (true). By default the indication whether the current distribution is ignored is false.
A Promise that once resolved contains information about the facts and inference steps that were taken to reach a result.
The value that a developer should most likely be interested in is data of componentsConfig
which contain a { [component: string]: boolean }
object
with information whether a component with a certain key should be shown (true) or hidden (false).
If an error occurs the Promise will be rejected.
Infer additional device capabilities from the ones that are known. Unmemoized private version of ComponentsRuleEngine.expandDeviceCapabilities.
The UUID of the Device that should have its capabilities expanded.
The initial capabilities of the device.
Matches a certain components agains all the information about devices, restrictions and proxemics to determine whether it should be shown (true) or not (false). Unmemorized version of ComponentsRuleEngine.matchComponentAndRestrictions
true if the component should be shown, false otherwise.
Generated using TypeDoc
A helper class that runs a decision engine that decides what is the correct distribution of UI components given the information about proxemics, device capabilities, and whether the user has selected to use automatic or manual distribution of the components.