npm 包 scribblelivefeed 使用教程

简介

ScribbleLiveFeed 是一个基于 ScribbleLive 实时更新的 API 封装库，它可以方便地打包 ScribbleLive 初始化代码并提供对其 API 的简单封装。这个包使得 ScribbleLive 网站的使用变得更加简单和方便。

安装

你可以通过 npm 直接安装 scribblelivefeed，使用以下命令：

npm install scribblelivefeed

使用

在安装完成 ScribbleLiveFeed 后，你可以使用以下语句导入它：

import ScribbleLiveFeed from 'scribblelivefeed';

接下来，你需要一个 ScribbleLive 活动 ID，这个活动必须是一个 ScribbleLive 数据流类型的活动。你可以将其添加为网站中任何位置的 div 块。

<div id="my-scribblelive"></div>

使用以下初始化代码初始化 ScribbleLiveFeed。

const livefeed = new ScribbleLiveFeed({ livefeedid: '<ScribbleLive ID>', elementid: 'my-scribblelive', maxitems: 20 });

一旦 ScribbleLiveFeed 初始化成功，你就可以对它进行以下操作：

获取数据流 ID

const dataStreamId = livefeed.getDataStreamId();

发送带有图片或视频的消息

livefeed.sendRichTextMessage('My Rich Text Message', {'type':'image','thumburl':'My Thumb Image URL','url':'My Image URL'});
livefeed.sendRichTextMessage('My Rich Text Message', {'type':'video','thumburl':'My Thumb Video URL','url':'My Video URL'});

发送文本消息

livefeed.sendTextMessage('My Text Message');

获取活动列表

const activityList = livefeed.getActivityList();

获取参与者列表

const participantList = livefeed.getParticipantList();

获取所有的消息

const messageList = livefeed.getMessageList();

获取 ID 为messageId的消息

const message = livefeed.getMessage(messageId);

总结

通过 ScribbleLiveFeed，我们可以方便地管理 ScribbleLive 网站的相关操作，这样可以减少代码量并提高代码的可读性和可维护性。同时，此包可以帮助前端开发者更好地适应实时更新的数据流类型活动。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005682e81e8991b448e4482