I don't need to test my programs. I have an error-correcting modem.

UE3:IQueryHandler (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Interface >> IQueryHandler
Package: 
WebAdmin
Known implementing classes:
QHCurrent, QHDefaults

The query handler interface. The WebAdmin contains a collection of query handlers with handle most requests assigned to the WebAdmin application. During creating the query handler will receive a couple of set up calls: init(...) and registerMenuItems(...). The webadmin has to register all URLs it will handle (url without the webapp path prefix). It is also allowed to replace an existing menu item. When the WebAdmin is shut down the cleanup() method will be called. Use this to perform some clean up and to set all Actor references to none (in case the query handler extends Object).

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

Enums[edit]

EMessageType[edit]

MT_Information 
MT_Warning 
MT_Error 

Structs[edit]

KeyValuePair[edit]

string key 
string value 

Message[edit]

Used for the generic message processing in WebAdmin.addMessage();

EMessageType type 
string text 

WebAdminQuery[edit]

Struct contain current query information. Passed to the QueryHandlers.

WebRequest request 
WebResponse response 
ISession session 
IWebAdminUser user 
array<KeyValuePair> cookies 

Instance functions[edit]

cleanup[edit]

function cleanup ()

Cleanup (prepare for being destroyed). If the implementation extends Object it should set all actor references to none.

handleQuery[edit]

function bool handleQuery (WebAdminQuery q)

Called by the webadmin to request the query handler to handle this query.

Returns:

true when the query was handled.

init[edit]

function init (WebAdmin webapp)

Called when the WebAdmin creates and initializes this query handler.

registerMenuItems[edit]

function registerMenuItems (WebAdminMenu menu)

Called by the webadmin to request the query handler to add its menu items to the web admin menu. The menu is used to determine what query handler will be handle a given path. Paths not registered will be passed to all query handlers until one returns true.

unhandledQuery[edit]

function bool unhandledQuery (WebAdminQuery q)

Called in case of an unhandled path.

Returns:

true when the query was handled.