npm 包 hip-chatbot 使用教程

阅读时长 5 分钟读完

前言

HipChat 是团队协作工具,它支持多种类型的消息提醒,让团队成员更快速地相互沟通、同步任务。本篇文章将介绍如何使用 npm 包 hip-chatbot 来创建一个自定义 HipChat 消息机器人。

环境准备

在使用 hip-chatbot 之前,我们需要先安装 Node.js 和 npm。安装完成后,我们就可以在命令行中通过以下命令来安装 hip-chatbot:

创建机器人

在安装完 hip-chatbot 之后,我们就可以开始创建机器人了。首先,我们需要引入 hip-chatbot 包:

然后,我们需要为机器人设置一些基本信息,例如机器人的 token、名称等等:

对于上述参数,我们需要去 HipChat 的网站上申请 API token,并将机器人添加到想要发送消息的房间中。在上方的代码中,rooms 代表机器人可以发送消息的房间 ID 数组。

接下来,我们就可以通过创建一个 HipChatBot 对象来启动机器人:

到此为止,机器人已经可以接收、解析和分发 HipChat 消息了。

发送消息

要让机器人发消息,我们可以使用 HipChatBot 对象的 send 方法来发送消息:

上述代码将发送一条消息 "Hello, world!" 到机器人所在的房间中。

当然,我们也可以在发送消息时指定更多的属性:

-- -------------------- ---- -------
----------
    -------- ------- ----------
    ------ --------
    ------- -----
    ----- -
        ------ --------------
        ------- ---------
        ------ --------
        ------------ ------- --------
    --
---
  • message:消息内容
  • color:消息背景颜色
  • notify:设置 True 以向人员发送提醒
  • card:发送消息卡片

接受消息

机器人并不是一直在发送消息,它也应该能够接收并处理来自其他人的消息。我们可以为机器人添加一个回调方法,用于处理接收到的消息:

-- -------------------- ---- -------
----------------- --------- --------- -- -
    -- ------------------- -
        ----- -------- - -----------------
        ----------
            --- --------------
            -------- ---------
        ---
    -
---

当机器人接收到消息时,将会回调该方法。在上述示例中,消息回调方法首先判断该消息是否来自私信,并将接收到的内容回显给消息发送者。

示例代码

完整的示例代码如下。

-- -------------------- ---- -------
----- ---------- - -----------------------

-- ---------
----- ---------- - -
    --------- -------- --- -------
    ----- --------------
    ------------ --------------
    ------ ------------
--

-- -------
----- --- - --- -----------------------

-- -----
------------

-- ----
----------
    -------- ------- --------
---

-- ----
----------------- --------- --------- -- -
    -- ------------------- -
        ----- -------- - -----------------
        ----------
            --- -------------- -- --
            -------- ---------
        ---
    -
---

总结

hip-chatbot 是一款方便易用的 HipChat 消息机器人工具包,支持发送和接收消息、处理卡片等功能,可用于实现个性化的 HipChat 机器人。在使用时,我们需要按照指引先获取 API token,并将机器人添加到需要发送消息的房间中。同时,我们也需要通过回调函数来处理接收到的消息,以满足实际需求。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600555c581e8991b448d2db3

纠错
反馈