Query Directory Services (Asynchronously)

26 January 2021

C10 - added.

directoryquery (Commands)
Type	Corrade progressive command
Command	`directoryquery`
Description	This command starts a directory search and returns the request `UUID` to be matched later with the directory notification when retrieving data.
Permissions	`directory`
Parameters	`group`, `password`, `type`, `name` (The `name` parameter is optional for `classified` and `event` search `type` but required for all other search types.)
Last Changes	Release 7.62 - now returns a full list of matches.

This command starts a directory search and returns the request UUID to be matched later with the directory notification when retrieving data.

Command Required Parameters Required Corrade Permissions Example

directoryquery

group, password, type, name¹⁾

directory

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "directoryquery",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            "type", "event",
            "name", "hunt",
            "callback", wasURLEscape(URL)
        ]
    )
);

Parameter	Possible Values	Description
`type`	`classified`, `event`, `group`, `land`, `people`, `places`	The directory search type.

Parameter	Possible Values	Optional Parameter	Structure	Example
`type`	`classified`		Classified	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "classified", "name", "hunt", "callback", wasURLEscape(URL) ] ) );
	`classified`	`name`	A string to search the name by.
	`event`		Event Search Data	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "event", "name", "hunt", "callback", wasURLEscape(URL) ] ) );
	`event`	`name`	A string to search the name by.
	`group`	`data`	Group Search Data	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "group", "name", "Wizardry", "callback", wasURLEscape(URL) ] ) );
	`group`	`name`	A string to search the name by.
	`land`		Directory Parcel	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "land", "page", 1, "callback", wasURLEscape(URL) ] ) );
		`flags`	Optional land find flags. Assumed to be set to `SortAsc` if not supplied.
		`search`	Optional search type flags. Assumed to be set to `Any` if not supplied.
		`price`	An optional maximum price to search land parcels by.
		`area`	An optional minimum land area to search parcels by.
		`page`	A required parameter as the index of the data returned (please see the Notes section).
	`people`	`data`	Agent Search Data	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "people", "name", "Roger", callback", wasURLEscape(URL) ] ) );
	`people`	`name`	A string to search the name by.
	`places`		Directory Parcel	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "directoryquery", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), "type", "place", "name", "love", "callback", wasURLEscape(URL) ] ) );
	`places`	`name`	A string to search the name by.

The returned value is a query UUID that can be used to isolate the results returned by the directory notification.

Notes

This command is identical in parameters to the directorysearch command but the result of the command will be a query UUID.
This command is meant to be issued after the user has bound to the directory notification and is listening to the results.
The query UUID returned by the command can be used by the user while listening to the the directory notification in order to ensure that the query was initiated by the user.

¹⁾

The name parameter is optional for classified and event search type but required for all other search types.