If a client's gateway takes longer than its specified timeout to connect successfully, the connection attempt is canceled, and the gateway is disconnected. If a timeout is not specified (connectTimeout <= 0), the gateway is allowed to take any amount of time to complete.

The default value is 0.

Type:	bot:timeValue
Use:	optional
Defined:	locally, within bot:client complexType

description

Sets this client's description.

This is an informational value, and is not used by the bot engine.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

displayName

Sets this client's display name.

This is normally visible to other users in messages or their buddy lists.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

gatewayClass

Sets this client's BotGateway class. The value must be the fully-qualified class name of an BotGateway implementation.

If not specified, gateway support is provided internally by the JBuddy SDK. A custom gateway implementation should be provided if necessary features are not already provided by the default gateway (such as custom protocols, message types, or status types).

For more information, consult the javadocs included with the framework.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

host

Sets this client's host address.

This is the address of the server the client should connect to.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

Sets this client's identifier, which can be used to reference this client.

If not specified, the default value is name#protocol. For example, if a client's name is somebot and its protocol is AIM, its default identifier is somebot#AIM.

Client identifiers are used with routes to reference sender clients.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

name

Sets this client's unique name.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

password

Sets this client's password.

If passwordEncrypted is true, this value must be the encrypted password string, obtained from the EncryptPassword utility included with the framework.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

passwordEncrypted

Sets whether the password is encrypted.

If true, the password value must be the encrypted password string, obtained from the EncryptPassword utility included with the framework.

Type:	boolean
Use:	optional
Defined:	locally, within bot:client complexType

permitMode

Sets this client's permit mode.

View the available permit modes here.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

port

Sets this client's port.

This is the port number of the server the client should connect to.

Type:	embedded (restriction of positiveInteger)
Use:	optional
Defined:	locally, within bot:client complexType

protocol

Sets this client's protocol.

View the available protocols here.

Type:	string
Use:	required
Defined:	locally, within bot:client complexType

status

Sets this client's status.

View the available status types here.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

statusMessage

Sets this client's status message.

Type:	string
Use:	optional
Defined:	locally, within bot:client complexType

Content Element Detail

bot:property

Sets a system property that pertains to this client.

This property is loaded into the Java system properties when this client gateway is in the process of connecting to its host. After connecting, the previous values of any system properties that were modified are restored.

Type:	bot:property, empty content
Defined:	locally, within bot:client complexType

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.0

DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!

Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!

Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com