new Search(opts)
Convenience class to simplify search commands
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | Constructor options |
- Source:
Methods
geofences()
Alias for Search#zones
- Source:
- See:
options(opts)
Set options
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | Options |
- Source:
retranslators(filter) → {Promise}
Search for retranslators using 'avl_retranslator' item type. Flags are
set to 0x00000301.
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
string | Search filter |
- Source:
Returns:
- Type
- Promise
search(type, filter, flags, forceopt) → {Promise}
Search items by property using 'core/search_items' command
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
string | Item type (itemsType) | |
filter |
string | Property search filter (propValueMask) | |
flags |
number | Search flags | |
force |
number |
<optional> |
Force a search (0 - if such search has been done, then return cached result, 1 - to do a new search ) |
- Source:
- See:
Returns:
- Type
- Promise
units(filter) → {Promise}
Search for units using 'avl_unit' item type
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
string | Search filter |
- Source:
Returns:
- Type
- Promise
zones(filter) → {Promise}
Search for zones using 'avl_resource' item type. Flags are set
to 0x00001001.
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
string | Search filter |
- Source:
Returns:
- Type
- Promise