[This is preliminary documentation and is subject to change.]
Query a specific agent registered with this zone (a directed query)
and notify a MessagingListener.
Directed queries are used primarily when the source of data is known
because of a message previously received from that agent. For example,
if your agent receives a SIF_Event and you wish to query the author of
that event for additional data, a directed query is appropriate.
In addition, some kinds of SIF Data Objects in SIF 1.5 and later may be
designed to require agents to send directed queries if more than one
agent in a zone typically offers support for the object. This is necessary
because only one agent can be the authoritative provider of a given object
type in each zone.
| C# | Visual Basic | Visual C++ |
string Query( Query query, IMessagingListener listener, string destinationId, AdkQueryOptions queryOptions )
Function Query ( _ query As Query, _ listener As IMessagingListener, _ destinationId As String, _ queryOptions As AdkQueryOptions _ ) As String
String^ Query ( Query^ query, IMessagingListener^ listener, String^ destinationId, AdkQueryOptions queryOptions )
- query (Query)
- A Query object describing the parameters of the query, including optional conditions and field restrictions
- listener (IMessagingListener)
- A MessagingListener that will be notified when the SIF_Request message is sent to the zone. Any other MessagingListeners registered with the zone will also be called.
- destinationId (String)
- The SourceId of the agent to which the SIF Request will be routed by the zone integration server
- queryOptions (AdkQueryOptions)
- Reserved for future use
The SIF_MsgId of the SIF_Request that was sent to the zone.
@since Adk 1.5