icq-bot-core's Introduction

ICQ Bot Core

Easy interface to ICQ Bot API powered by Kotlin.

Getting started

Create your own bot by sending the /newbot command to MegaBot and follow the instructions
Note a bot can only reply after the user has added it contact list, or if the user was the first to start a conversation

Usage

You can find latest release on Maven Central:

Maven:

<dependency>
  <groupId>su.nlq</groupId>
  <artifactId>icq-bot-core</artifactId>
  <version>1.2.1</version>
</dependency>

Gradle:

compile("su.nlq:icq-bot-core:1.2.1")

How-To

The only thing you should know to create a new bot is token:

val bot = Bot("001.1234567890.1234567890:123456789")

Contacts and messages

To be able to send a message you should create a conversation (no matter is it chat or dialogue):

val penpal = PenPal("42")
val conversation = bot.conversation(penpal)   
// not neccessary but looks nice to set typing status
conversation.typing()
conversation.message("Hi, how are you?")

It is possible to operate the contact list, for example:

bot.contacts().all().onSuccess { buddies ->
  buddies.find { it.name == "Adolf" }?.apply { remove() }
}

Chats

To get any chat information you want is neccessary to create a chat instance:

val chat = bot.chat("[email protected]")
chat.description().onSuccess {
  println("Chat \"${it.name}\" was created ${it.created} by ${it.creator}")
}

There are various actions you can do with chat members or history, e.g.:

chat.invite(listOf(PenPal("42")))

chat.members().onSuccess { members -> members.forEach { it.block() } }

chat.history(0, 10).onSuccess { history ->
  history.messages.forEach { println("${it.id}: $it") }
  val message = history.messages[0]
  if (message is Chat.Text) {
    message.pin()
  }
}

Files

It is possible to get the file info, upload or download the file:

val files = bot.files()

files.upload(File("myfile.txt")).map { URL(it) }.onSuccess { url ->
  files.download(url)
    .map { it.toInputStream() }
    .onSuccess { stream ->
      println(stream.use { String(it.readAllBytes()) })
    }
}

Recommend Projects