Object Overview

This object defines a persistent network connection to the AOL Instant Messenger (AIM) service.

Bindings may be embedded within this Connection object to define processing and transformation steps for received instant messages. This is useful to create IM "bots" that process incoming IM messages.

The IMConnection object may also be used in conjunction with an IMOutputConnector to send messages to other AIM users. Using an IMOutputConnector allows AlchemyPoint to rate-limit outgoing IM messages. Multiple Connectors may even be associated with a single IMConnection, each with their own unique rate limiting options.

Example Object Definitions

... directly within the top-level ServerConfiguration object:

Minimal Configuration:

<IMConnection name="AIMConnection1"
              username="aimuser1" password="secret123"/>

Overview:

This object defines an AIM connection using the login "aimuser1" and password "secret123". AlchemyPoint will automatically log into this account upon starting up, and will stay connected (excluding network / AIM failures). This object does not define any input Bindings, therefore is only capable of being used in conjunction with an IMOutputConnector to send messages (not receive).

Complex Configuration (all possible attributes shown):

<IMConnection name="AIMConnection1" tags="aim connection"
              description="example AIM instant messenger connection"
              username="aimuser1" password="secret123">
   ... input bindings go here ...
</IMConnection>

Overview:

This object defines an AIM connection using the login "aimuser1" and password "secret123". AlchemyPoint will automatically log into this account upon starting up, and will stay connected (excluding network / AIM failures). IM messages received by this AIM session will be forwarded to any input Bindings embedded within the object.

Supported Attributes

General Attributes:

• name - (usage: required): Public name of the configuration object. This name must be globally-unique across the entire AlchemyPoint ServerConfiguration definition.

• description - (usage: optional): Textual description of the configuration object.

• tags - (usage: optional): Space-delimited list of one or more tags used to describe the configuration object.

Object Attributes:

• username - (usage: required): The username to utilize when logging into AOL's AIM messenger servers.

• password - (usage: required): The password to utilize when logging into AOL's AIM messenger servers.

Supported Child Configuration Elements

Bindings:

• Bindings - Bindings object, containing one or more IM Binding? configuration elements. These bindings define the actions that should be taken on IM messages received by this AIM connection.