new AiObject(propsopt) → {AiObject}
The description of an object identified using Artificial Intelligence.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props | Object |
<optional> | Initializes a description of an object identified using Artificial Intelligence. using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- AiObject
Methods
aiClass(aiClassopt) → {string|Description}
the AI Class type of the AI object list of supported classes can be taken from AI.AiTypes.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
aiClass | string |
<optional> | When provided, this method acts as a setter and sets the aiClass value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored aiClass value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
text(textopt) → {string|Description}
The object's attached text.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
text | string |
<optional> | When provided, this method acts as a setter and sets the text value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
