net.java.sip.communicator.impl.protocol.jabber.extensions.inputevt
Class InputEvtIQ

java.lang.Object
  org.jivesoftware.smack.packet.Packet
      org.jivesoftware.smack.packet.IQ
          net.java.sip.communicator.impl.protocol.jabber.extensions.inputevt.InputEvtIQ

public class InputEvtIQ
extends org.jivesoftware.smack.packet.IQ

Input event IQ. It is used to transfer key and mouse events through XMPP.

Author:

Sebastien Vincent

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

org.jivesoftware.smack.packet.IQ.Type

Field Summary

static String	ACTION_ATTR_NAME The name of the argument that contains the input action value.
static String	ELEMENT_NAME The name of the element that contains the input event data.
static String	NAMESPACE The namespace that input event belongs to.

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

InputEvtIQ()
Constructor.

Method Summary

void	addRemoteControl(RemoteControlExtension item) Add a remote-control extension.
InputEvtAction	getAction() Returns the value of this element's action attribute.
String	getChildElementXML() Get the XML representation of the IQ.
List<RemoteControlExtension>	getRemoteControls() Get the RemoteControlExtension list of this IQ.
void	removeRemoteControl(RemoteControlExtension item) Remove a remote-control extension.
void	setAction(InputEvtAction action) Sets the value of this element's action attribute.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

The namespace that input event belongs to.

See Also:

Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

The name of the element that contains the input event data.

See Also:

Constant Field Values

ACTION_ATTR_NAME

public static final String ACTION_ATTR_NAME

The name of the argument that contains the input action value.

See Also:

Constant Field Values

Constructor Detail

InputEvtIQ

public InputEvtIQ()

Constructor.

Method Detail

getChildElementXML

public String getChildElementXML()

Get the XML representation of the IQ.

Specified by:

getChildElementXML in class org.jivesoftware.smack.packet.IQ

Returns:

XML representation of the IQ

setAction

public void setAction(InputEvtAction action)

Sets the value of this element's action attribute. The value of the 'action' attribute MUST be one of the values enumerated here. If an entity receives a value not defined here, it MUST ignore the attribute and MUST return a bad-request error to the sender. There is no default value for the 'action' attribute.

Parameters:

action - the value of the action attribute.

getAction

public InputEvtAction getAction()

Returns the value of this element's action attribute. The value of the 'action' attribute MUST be one of the values enumerated here. If an entity receives a value not defined here, it MUST ignore the attribute and MUST return a bad-request error to the sender. There is no default value for the 'action' attribute.

Returns:

the value of the action attribute.

addRemoteControl

public void addRemoteControl(RemoteControlExtension item)

Add a remote-control extension.

Parameters:

item - remote-control extension

removeRemoteControl

public void removeRemoteControl(RemoteControlExtension item)

Remove a remote-control extension.

Parameters:

item - remote-control extension

getRemoteControls

public List<RemoteControlExtension> getRemoteControls()

Get the RemoteControlExtension list of this IQ.

Returns:

list of RemoteControlExtension