Skip to content

xatkit-bot-platform/xatkit-discord-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Xatkit Discord Platform

License Badge Wiki Badge

⚠ This platform is outdated and not actively supported anymore.

Receive and send messages from Discord.

The Discord platform is a concrete implementation of the ChatPlatform.

Providers

The Discord platform defines the following providers:

Provider Type Context Parameters Description
ChatProvider Intent - chat.channel: the identifier of the channel that sent the message
- chat.username: the name of the user that sent the message
- chat.rawMessage: the raw message sent by the user (before NLP processing)
Receive messages from a communication channel and translate them into Xatkit-compatible intents (inherited from ChatPlatform)
DiscordIntentProvider Intent - discord.channel: the identifier of the Discord channel that sent the message
- discord.username: the name of the Discord user that sent the message
- discord.rawMessage: the raw message sent by the user (before NLP processing)
Receive messages from Discord and translates them into Xatkit-compatible intents. Note that discord.channel, discord.username, and discord.rawMessage contain the same values as chat.channel, chat.username, and chat.rawMessage

Actions

Action Parameters Return Return Type Description
PostMessage - message(String): the message to post
- channel (String): the identfier of the Discord channel to post the message to
The posted message String Posts the provided message to the given Discord channel (inherited from ChatPlatform)
Reply - message (String): the message to post as a reply The posted message String Posts the provided message as a reply to a received message (inherited from ChatPlatform)

Options

The discord platform supports the following configuration options

Key Values Description Constraint
xatkit.discord.token String The Discord token used by Xatkit to deploy the bot Mandatory

Note: if the Discord platform is used as a concrete implementation of the ChatPlatform the following property must be set in the Xatkit configuration:

xatkit.platforms.abstract.ChatPlatform = com.xatkit.plugins.discord.platform.DiscordPlatform