Flutter客户端SDK插件tembo_client_sdk的使用

Flutter客户端SDK插件tembo_client_sdk的使用

一个用于处理特定于TemboPlus要求的Flutter SDK。

获取SDK

当前SDK使用第三方服务提供商Smile Identity进行用户身份验证。内部包利用了smile_identity_plugin插件来处理所有移动原生实现。请确保在首次运行之前已经完成了该包所需的所有设置。

使用指南

SDK的入口点是startTemboVerification函数。

参数：

/// startTemboVerification 函数参数
startTemboVerification(
  BuildContext context, 
  { 
    TemboColorScheme? scheme, 
    Data? userData, 
    ThemeMode? themeMode, 
    TemboLocale locale = TemboLocale.en 
  }
);

scheme: TemboColorScheme?

一组颜色以自定义页面外观。

/// TemboColorScheme 构造函数
const TemboColorScheme({
  this.primary,
  this.onPrimary,
  this.border,
  this.hint,
  this.title,
  this.body,
  this.background,
  this.onBackground,
  this.surfaceContainer,
  this.onSurfaceContainer,
  this.error,
  this.onError,
});

userData: Data?

特定用户的详细数据。提供的用户数据将在打开特定页面时预先填充。

/// Data 构造函数
Data({
  this.country,
  this.firstName,
  this.lastName,
  this.dob,
  this.gender,
  this.document,
  required this.userId,
  this.environment,
});

themeMode: ThemeMode?

如果未定义scheme，则ThemeMode.light将使用默认浅色颜色方案，ThemeMode.dark将使用默认深色颜色方案。如果提供了scheme，则忽略themeMode。

locale: TemboLocale

定义要使用的语言。目前仅支持英语(TemboLocale.en)和斯瓦希里语(TemboLocale.sw)。

/// TemboLocale 声明
enum TemboLocale {
  sw,
  en,
}

SDK从调用startTemboVerification函数开始处理一切，并在完成后返回到调用前的应用程序页面。

遇到任何问题？

请发送电子邮件至support@temboplus.com或在我们的存储库中提交一个问题。

示例代码

以下是一个完整的示例代码，展示了如何使用tembo_client_sdk插件。

import 'package:flutter/material.dart';
import 'package:tembo_client_sdk/tembo_client_sdk.dart';

void main() {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData.dark(),
      home: Scaffold(
        appBar: AppBar(
          title: const Text("应用 1"),
        ),
        body: Builder(
          builder: (context) {
            return Center(
              child: TextButton(
                onPressed: () async {
                  startTemboVerification(context,
                      userData: TemboUserData(
                        userId: "user-3",
                        country: Country.tz(), // 国家代码
                        gender: Gender.female, // 性别
                        firstName: "Jane", // 名字
                        lastName: "Doe", // 姓氏
                        dob: DateTime(1995), // 出生日期
                        document: VerDocument(
                          type: VerDocumentType.nida, // 文档类型
                          issueDate: DateTime.now(), // 发行日期
                          expiryDate: DateTime.now(), // 到期日期
                          idNumber: "2836464744784", // 身份证号
                        ),
                      ),
                      locale: TemboLocale.sw, // 语言
                      fontFamily: "circular", // 字体
                      unmodifiableFields: [
                        Field.country,
                        Field.dob,
                        Field.docIssueDate,
                        Field.firstName,
                      ], // 不可修改的字段
                      scheme: const TemboColorScheme.dark() // 颜色方案
                      // skipUserInfoCollection: true, // 跳过用户信息收集
                      );
                },
                style: TextButton.styleFrom(
                    padding: const EdgeInsets.symmetric(
                      horizontal: 20,
                      vertical: 10,
                    ),
                    shape: const RoundedRectangleBorder(side: BorderSide())),
                child: const Text(
                  "开始",
                  style: TextStyle(fontSize: 18),
                ),
              ),
            );
          },
        ),
      ),
    );
  }
}