org.zkoss.zk.au.out

Class AuClientInfo

java.lang.Object

org.zkoss.zk.au.AuResponse

org.zkoss.zk.au.out.AuClientInfo

public class AuClientInfo
extends AuResponse

A response to ask the browser to send back its information.

Since:

3.0.0

Author:

tomyeh

See Also:

ClientInfoEvent

Field Summary

Fields inherited from class org.zkoss.zk.au.AuResponse

_cmd, _data, SC_ACTIVATION_TIMEOUT, SC_OUT_OF_SEQUENCE

Constructor Summary

Constructors

Constructor and Description
AuClientInfo() Constructs a client-info response for all desktops of the same browser window.
AuClientInfo(Desktop desktop) Constructs a client-info response with the specified desktop.

Method Summary

Methods

Modifier and Type	Method and Description
String	getOverrideKey() Default: zk.clientInfo (i.e., only one response of this class will be sent to the client in an execution)

Methods inherited from class org.zkoss.zk.au.AuResponse

equals, getCommand, getDepends, getEncodedData, getRawData, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuClientInfo

public AuClientInfo(Desktop desktop)

Constructs a client-info response with the specified desktop.

Parameters:

desktop - the desktop to get the client info back. If null, the client info is sent back for each desktop in the same browser window.

Since:

3.0.0

AuClientInfo

public AuClientInfo()

Constructs a client-info response for all desktops of the same browser window.

Method Detail

getOverrideKey

public final String getOverrideKey()

Default: zk.clientInfo (i.e., only one response of this class will be sent to the client in an execution)

Overrides:

getOverrideKey in class AuResponse

Since:

5.0.2