About
WORK IN PROGRESS
This is Discord message system support for reference implementation of FTN22.
Author: Andrey Galkin
Installation for Node.js
Command line:
$ npm install @futoin/msgbot-discord --save
API documentation
Modules
Classes
- DiscordFace
-
Discord FTN22 Server Face implementation
- DiscordHelpers
-
Discord Server-specific helpers
- DiscordService
-
Discord Server Service
@futoin/ext-js-msgbot-discord
⏏
exports Add Discord system to FutoIn Message Bot
Kind: Exported member
Param | Type | Description |
---|---|---|
asi | AsyncSteps |
async steps interface |
app | ServiceApp |
message bot |
options | object |
additional parameters |
options.discord | object |
parameters to be passed to Discord.js |
options.discordToken | string |
bot token |
DiscordFace
Discord FTN22 Server Face implementation
Kind: global class
new DiscordFace(options)
C-tor
Param | Type | Description |
---|---|---|
options | object |
common options |
options.discordClient | object |
Discord client instance |
object
discordFace.systemIface() ⇒ Get native message system interface implementation
Kind: instance method of DiscordFace
Returns: object
- native implementation
DiscordHelpers
Discord Server-specific helpers
Kind: global class
-
DiscordHelpers
-
.bold(str) ⇒
string
-
.italic(str) ⇒
string
-
.color(str, hexcolor) ⇒
string
-
.imgUrl(url) ⇒
string
-
.emoji(name) ⇒
string
-
.line() ⇒
string
-
.menion(ext_id) ⇒
string
-
.bold(str) ⇒
string
discordHelpers.bold(str) ⇒ Get bold text
Kind: instance method of DiscordHelpers
Returns: string
- bold output
Param | Type | Description |
---|---|---|
str | string |
input |
string
discordHelpers.italic(str) ⇒ Get italic text
Kind: instance method of DiscordHelpers
Returns: string
- italic output
Param | Type | Description |
---|---|---|
str | string |
input |
string
discordHelpers.color(str, hexcolor) ⇒ Get colored text
Kind: instance method of DiscordHelpers
Returns: string
- colored output
Param | Type | Description |
---|---|---|
str | string |
input |
hexcolor | string |
color code |
string
discordHelpers.imgUrl(url) ⇒ Get image URL embedded into text
Kind: instance method of DiscordHelpers
Returns: string
- URL output
Param | Type | Description |
---|---|---|
url | string |
input |
string
discordHelpers.emoji(name) ⇒ Get emoji embedded into text
Kind: instance method of DiscordHelpers
Returns: string
- emoji output
Param | Type | Description |
---|---|---|
name | string |
input |
string
discordHelpers.line() ⇒ Get new line
Kind: instance method of DiscordHelpers
Returns: string
- new line
string
discordHelpers.menion(ext_id) ⇒ Get actor mention into text
Kind: instance method of DiscordHelpers
Returns: string
- mention output
Param | Type | Description |
---|---|---|
ext_id | string |
input actor ID |
DiscordService
Discord Server Service
new DiscordService(options)
C-tor
Param | Type | Description |
---|---|---|
options | object |
common options |
options.discordClient | object |
Discord client instance |
options.asModel | AsyncSteps |
AsyncSteps model to create threads |
options.ccm | AdvancedCCM |
CCM |
documented by jsdoc-to-markdown.