Chat Room Robot

org.eclipse.ecf.presence.bot.chatRoomRobot

1.0.0 milestone 6

This extension point allows implementers to define a chat room bot.

<!ELEMENT extension (chatRoomRobot)+>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT chatRoomRobot (chatRooms+)>

<!ATTLIST chatRoomRobot

id                   CDATA #REQUIRED

containerFactoryName CDATA #REQUIRED

connectId            CDATA #REQUIRED

connectPassword      CDATA #IMPLIED

name                 CDATA #IMPLIED>

The chatRoomRobot extension point.



<!ELEMENT chatRooms EMPTY>

<!ATTLIST chatRooms

name     CDATA #REQUIRED

password CDATA #IMPLIED>


   

<extension point=

"org.eclipse.ecf.presence.bot.chatRoomRobot"

>

<chatRoomRobot connectId=

"irc://slewis2_@irc.freenode.net"

containerFactoryName=

"ecf.irc.irclib"

id=

"org.eclipse.ecf.presence.bot.defaultbot"

>

<chatRooms name=

"#eclipse-ecf"

>

</chatRooms>

<chatRooms name=

"#secret-channel"

password=

"secret-password"

>

</chatRooms>

</chatRoomRobot>

</extension>

Note that to have the chatRoomRobot receive chat room messages and process them, that the chatRoomMessageHandler should also be defined using the id for the chatRoomRobot given above. For example:
   

<extension point=

"org.eclipse.ecf.presence.bot.chatRoomMessageHandler"

>

<handler chatRoomRobotId=

"org.eclipse.ecf.presence.bot.defaultbot"

class=

"org.eclipse.ecf.presence.bot.DefaultChatRoomMessageHandler"

>

</handler>

</extension>

See the API information for the chatRoomMessageHandler

No supplied implementation.