Function: object.Query

Returns the Objects available in the third-party system. Should return all existing child Objects of the specified parent. The strategy of determining these depends on the third-party system (e.g., query via active connection to the system, importing a config file, etc). The function is called from the data supply dialog.

Syntax

{
	"method": "ext.deviceadapter.object.Query",
	"params": {
		"url": "...",
		"params": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<std::vector<StaticExtObject>> ObjectQuery( AdvString url, AdvObject params );
public Task<IList<StaticExtObject>> ObjectQueryAsync(string url,
		IDictionary<string,
		object?> @params,
		CancellationToken ct = default);
objectQuery(url: string, params: Map<string, Object>): Promise<StaticExtObject[]>;

Parameters

url : string

The parameter value is AopUrl.

The URL of the parent Object to query. Can be the URL of the whole Extension (e.g., ’ext[CODE]:’) or of the Object whose children are requested. In the latter case, the parent Object should also be part of the result.

params : value{}

The parameter key is SymbolPath.

User-defined parameters for the query. These are declared in the Module XML and shown in the data supply dialog.

Result : StaticExtObject[]