# flutter_tencent_captcha

**Repository Path**: leanflutter/flutter_tencent_captcha

## Basic Information

- **Project Name**: flutter_tencent_captcha
- **Description**: 适用于 Flutter 的腾讯云验证码插件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://pub.dev/packages/flutter_tencent_captcha
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-20
- **Last Updated**: 2023-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# flutter_tencent_captcha

适用于 Flutter 的腾讯云验证码插件

[![pub version][pub-image]][pub-url]

[pub-image]: https://img.shields.io/pub/v/flutter_tencent_captcha.svg
[pub-url]: https://pub.dev/packages/flutter_tencent_captcha

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [屏幕截图](#%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE)
- [快速开始](#%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
  - [安装](#%E5%AE%89%E8%A3%85)
  - [用法](#%E7%94%A8%E6%B3%95)
    - [获取 SDK 版本](#%E8%8E%B7%E5%8F%96-sdk-%E7%89%88%E6%9C%AC)
    - [初始化 SDK](#%E5%88%9D%E5%A7%8B%E5%8C%96-sdk)
    - [开始验证](#%E5%BC%80%E5%A7%8B%E9%AA%8C%E8%AF%81)
- [许可证](#%E8%AE%B8%E5%8F%AF%E8%AF%81)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## 屏幕截图

<div>
  <img src='./screenshots/flutter_tencent_captcha-android.jpeg' width=280>
  <img src='./screenshots/flutter_tencent_captcha-ios.png' width=280>
</div>

## 快速开始

### 安装

将此添加到包的 pubspec.yaml 文件中：

```yaml
dependencies:
  flutter_tencent_captcha: ^0.1.2
```

您可以从命令行安装软件包：

```bash
$ flutter packages get
```

### 用法

#### 获取 SDK 版本

```dart
String sdkVersion = await TencentCaptcha.sdkVersion;
```

#### 初始化 SDK

```dart
TencentCaptcha.init('<appId>');
```

#### 开始验证

> 详细参数请参见：https://cloud.tencent.com/document/product/1110/36841

```dart
TencentCaptchaConfig config = TencentCaptchaConfig(
  bizState: 'tencent-captcha',
  enableDarkMode: true,
);
await TencentCaptcha.verify(
  config: config,
  onLoaded: (dynamic data) {
    _addLog('onLoaded', data);
  },
  onSuccess: (dynamic data) {
    _addLog('onSuccess', data);
  },
  onFail: (dynamic data) {
    _addLog('onFail', data);
  },
);
```

## 许可证

[MIT](./LICENSE)