find
- 30 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
find
- Updated on 30 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
Returns a specified app object.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tokenOrName | Text | Yes | Target object token or name |
Returns
Type: Object
Returns an object that represents your app object.
Read-only properties on this object include:
| Name | Type | Description |
|---|---|---|
| id | Text | Returns the id of the app object (i.e. 3) |
| token | Text | Returns the token of the app object (i.e. [3]) |
| name | Text | Returns the name of the app object |
| title | Text | Returns the display title of the app object |
| type | Text | Returns the type of the app object |
| hasValue | Boolean | Returns whether or not the app object currently has a value |
| value | Any | Returns the current value of the app object |
Examples
// get app object using token syntax
debug.log(app.find("[10]"));
// get app object using name
debug.log(app.find("myName"));
// get app object [10]
var item = app.find("[10]");
// display a few object properties in the debugger
debug.log(item.token);
debug.log(item.name);
debug.log(item.type);
debug.log(item.value);
Remarks
Token Syntax
This function uses the native app object token syntax, which refers to the ID of an object within your app that is enclosed in square brackets.
Example: [10]