Hamibot

运行在 Hamibot 的脚本,可以使用额外的环境信息和功能。

env

const { APP_ENV } = hamibot.env;
名称类型描述
APP_ENVstring运行模式,可以是下列值之一:
  • development
  • production

示例

if (APP_ENV === 'development') {
  log('💻 开发模式');
}

plan

脚本的定价计划信息,可用来区分版本。

const { name, model, onFreeTrial } = hamibot.plan;
名称类型描述
namestring计划名称,默认 免费
modelstring定价模式,可以是下列值之一:
  • free
  • flatRate
默认 free
onFreeTrialboolean是否处于免费试用期,默认 false

postMessage(text[, opts])

将信息发送到控制台的脚本消息,实现远程查看。

需要在设置中启用

参数

名称类型描述
textstring消息内容
optsobject选项

示例

hamibot.postMessage('hamibot');
hamibot.exit();

发送报告

可以让用户发送使用数据和错误报告,了解使用情况,帮助改进脚本。

使用步骤:

(1). 在脚本配置模式中添加选项

{
  "name": "TELEMETRY",
  "type": "checkbox",
  "label": "发送使用数据和错误报告",
  "help": "帮助开发者改进脚本,这个报告会被认为是机密的,匿名的。"
}

(2). 在脚本代码中进行调用

hamibot.postMessage(Date.now().toString(), {
  telemetry: true,
  data: {
    title: '标题',
    attachments: [
      // 支持 text, json, image 三种类型,根据实际需要选择使用
      {
        type: 'text',
        data: '文字内容',
      },
      {
        type: 'json',
        data: JSON.stringify({
          currentActivity: currentActivity(),
        }),
      },
      {
        type: 'image',
        data: 'data:image/png;base64,iVB...', // base64
      },
    ],
  },
});
hamibot.exit();

(3). 查看报告

访问 议题

exit()

确保 hamibot.postMessage() 发送成功后再退出,可在任何时候使用,作用与 exit() 一致。