io.interop.instanceInstanceinterface
Each Interop application is identified by its Interop instance, which is a set of known key/value pairs.
Properties (13)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| api⚓︎ | string | x | x | API version |
| application⚓︎ | string | x | x | Unique application name. |
| applicationName⚓︎ | string | x | x | Application name |
| environment⚓︎ | string | x | x | Environment in which the application is running. |
| instance⚓︎ | string | x | x | (IOConnect Desktop) Unique string identifying the application. |
| isLocal⚓︎ | boolean | x | x | (IOConnect Desktop) A flag indicating whether the instance is running on a local machine or not. Taken into account when a Gateway mesh is present - local instances are preferred when invoking methods. |
| machine⚓︎ | string | x | x | Name of the machine the instance is running on. |
| peerId⚓︎ | string | x | x | (IOConnect Desktop) Gateway peer ID of the instance. |
| pid⚓︎ | number | x | x | Process ID of the instance. |
| region⚓︎ | string | x | x | Region in which the application is running. |
| service⚓︎ | string | x | x | Service string of the application. |
| user⚓︎ | string | x | x | Name of the user who has started the instance. |
| windowId⚓︎ | string | x | x | (IOConnect Desktop) Window ID of the instance. Only set if running in a IOConnect window. |