Skip to content
Botyo API - The API for developing modules for Botyo
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
.gitignore
.npmignore
LICENSE
README.md
package.json
tsconfig.json

README.md

Botyo API

npm npm npm

The Botyo API module is a collection of types, interfaces and classes for developing modules for Botyo.

Requirements

  • Node.js >= 8.3.0

Install

npm install --save botyo-api

Documentation

The documentation for the Botyo API is available here:

Example

TypeScript

import { AbstractCommandModule, Message } from "botyo-api";

export default class HelloCommand extends AbstractCommandModule
{
    getCommand(): string
    {
        return "hello";
    }

    getDescription(): string
    {
        return "Responds to the hello";
    }

    getUsage(): string
    {
        return "";
    }

    validate(msg: Message, args: string): boolean
    {
        return true;
    }

    async execute(msg: Message, args: string): Promise<any>
    {
        return this.getRuntime().getChatApi().sendMessage("Hello world!", msg.threadID);
    }
}

JavaScript

const AbstractCommandModule = require('botyo-api').AbstractCommandModule;

class HelloCommand extends AbstractCommandModule
{
    getCommand() {
        return "hello";
    }

    getDescription() {
        return "Responds to the hello";
    }

    getUsage() {
        return "";
    }

    validate(msg, args) {
        return true;
    }

    async execute(msg, args) {
        return this.getRuntime().getChatApi().sendMessage("Hello world!", msg.threadID);
    }
}

module.exports = HelloCommand;
You can’t perform that action at this time.