Flutter客户端插件spect8_client的使用

Flutter客户端插件spect8_client的使用

简介

Spect8-chat SDK for Flutter，通过实现实时消息传递、轮询、商品销售等功能，为Flutter跨平台应用（包括iOS、Android和Web）提供了强大的功能。该平台的服务具有高可靠性、低延迟和高效性能。

Spect8_Client

此包包含将实时消息传递功能集成到您的应用程序所需的所有功能。它不尝试提供业务逻辑。

安装

添加依赖

在pubspec.yaml文件中添加以下依赖项：

dependencies:
  spect8_client: ^1.0.1

下载依赖

从命令行安装包：

$ flutter pub get

访问包

导入以下命令以访问包：

import 'package:spect8_client/spect8_client.dart';

初始化Chat SDK

为了使用聊天客户端，必须进行身份验证，因此初始化客户端是必要的。

final spect8Client = Spect8Client();

用户身份验证

成功身份验证后，返回一个TenantManager对象，用于除身份验证之外的所有操作。

Future<void> main() async {
  final spect8Client = Spect8Client();
  TenantManager tenantManager = await spect8Client.connectDemoUser(
    demoUserId: 'some-user-id',
    tenantId: 'id-of-tenant',
  );
}

管理器流程图

为了完成各种操作，我们提供了一些方便的管理器。

• TenantManager
• BroadcastManager
• ShopCategoryManager
• DisclaimerManager
• ReportManager
• ChannelManager
• PollManager
• ShopItemManager

示例代码

import 'package:spect8_client/spect8_client.dart';

Future<void> main() async {
  final spect8Client = Spect8Client();

  /// 连接用户
  TenantManager tenantManager = await spect8Client.connectDemoUser(
    demoUserId: 'some-user-id',
    tenantId: 'id-of-tenant',
  );

  /// Tenant Manager:

  /// 获取所有可用广播。
  await tenantManager.getAllBroadcasts();

  /// 创建新的广播
  await tenantManager.createBroadcast(broadcastName: 'test name');

  /// 获取具有特定广播名称的广播。
  await tenantManager.getBroadcast(broadcastName: 'test name');

  /// Broadcast Manager:

  /// 获取广播管理器，用于与特定广播相关的操作。
  BroadcastManager broadcastManager =
      tenantManager.getBroadcastManager(broadcastId: 'id-of-broadcast');

  /// 获取所有广播中的所有频道。
  await tenantManager.getAllChannels();

  /// 获取租户中所有已钉住的消息。
  await tenantManager.getAllPinnedMessages();

  /// Channel Manager:

  /// 获取频道管理器，用于与特定频道相关的操作。
  ChannelManager channelManager =
      broadcastManager.getChannelManager(channelId: 'id-of-channel');

  /// 获取此频道中所有已钉住的消息。
  await channelManager.getPinnedMessages();

  /// 获取频道上的活跃用户数。
  await channelManager.getActiveUserCount();

  /// 获取频道上的活跃用户列表。
  await channelManager.getActiveUsers();

  /// 获取频道的动作流，可以用来更新消息列表。
  await channelManager.subscribeUser();

  /// 从特定频道取消订阅用户。
  await channelManager.unSubscribeUser();

  /// 向后端发送保持活动信号。
  await channelManager.keepAlive();

  /// 发送消息到频道。
  await channelManager.sendMessage(content: 'your message');

  /// Poll Manager:

  /// 获取用于与特定投票相关的操作的投票管理器。
  PollManager pollManager =
      broadcastManager.getPollManager(pollId: 'id-of-poll');

  /// 保存投票。
  var pollAnswer = PollAnswer(
    userSubmission: true,
    answerId: null,
    voteCount: 0,
    value: 'value',
    image: null,
    authorDisplayName: null,
  );

  PollVoteRequest(pollAnswer: pollAnswer);

  /// 通过投票ID删除投票。
  await pollManager.deletePollVoteById(voteId: 'id-of-vote');

  /// 获取特定用户的投票。
  await pollManager.getPollVotes(userId: 'id-of-user');

  /// Disclaimer Manager

  /// 获取用于与特定免责声明相关的操作的免责声明管理器。
  DisclaimerManager disclaimerManager =
      tenantManager.getDisclaimerManager(disclaimerId: 'id-of-disclaimer');

  /// 删除免责声明。
  await disclaimerManager.deleteDisclaimer();

  /// 广告管理器
  AdManager adManager = tenantManager.getAdManager(adId: 'id-of-ad');

  /// 获取广告。
  await adManager.getAd();

  /// 报告管理器
  ReportManager reportManager =
      tenantManager.getReportManager(reportId: 'id-of-report');

  /// 删除报告。
  await reportManager.deleteReport();

  /// 商店分类管理器
  ShopCategoryManager shopCategoriesManager =
      tenantManager.getShopCategoryManager(categoryId: 'id-of-category');

  /// 获取商店分类中的所有项目。
  List<ShopItem> items = await shopCategoriesManager.getItems();

  /// 商店项目管理器
  ShopItemManager shopItemManager =
      shopCategoriesManager.getItemManager(itemId: items[0].id);
  shopItemManager.categoryId;

  /// 当前用户管理器
  CurrentUserManager currentUserManager = tenantManager.getCurrentUserManager();

  /// 获取被屏蔽的用户列表。
  List<BlockedUser> blockedUsers = await currentUserManager.getBlockedUsers();
  blockedUsers.length;

  /// 获取当前用户的主题配置。
  ThemeConfigData themeConfigData =
      await currentUserManager.getThemeConfigOfCurrentUser();
  themeConfigData.id;
}