Flutter文档签名插件docu_sign_flutter_sdk的使用

docusign_sdk

一个用于DocuSign SDK的Flutter插件。

由于DocuSign SDK目前仅支持iOS平台，因此此插件也仅支持iOS平台。

支持的平台

• iOS 9+

开始使用

DocuSign集成指南

在获取集成密钥和账户后，通常需要先登录：

DocusignSdk.loginWithEmail(
  email: 'myamolane@outlook.com',
  password: 'password',
  host: 'https://demo.docusign.net/restapi',
  integratorKey: 'your-integration-key'
);

然后可以调用renderWithTemplateId来弹出签署视图：

DocusignSdk.renderWithTemplateId(
  templateId,
  signingMode: DocuSignSigningMode.online,
  envelopeDefaults:
    EnvelopeDefaults(recipientDefaults: [recip])
);

在线模式

以下是一个完整的在线模式示例代码：

import 'package:docusign_sdk/docusign_sdk.dart';
import 'package:docusign_sdk/model.dart';

ElevatedButton(
  child: Text('sign'),
  onPressed: () async {
    RecipientDefault recip = RecipientDefault(
      recipientRoleName: 'Visitor',
      recipientEmail: 'myamolane@outlook.com',
      recipientName: 'myamo lane',
      inPersonSignerName: 'Test Customer',
      recipientType: RecipientType.recipientTypeInPersonSigner,
    );

    await DocusignSdk.renderWithTemplateId(
      templateId,
      signingMode: DocuSignSigningMode.online,
      envelopeDefaults:
        EnvelopeDefaults(recipientDefaults: [recip])
    );
  },
)

离线模式

由于在使用在线模式签署文件时，需要良好的网络连接并且等待时间较长，因此如果希望有更好的用户体验，建议使用离线签署模式。

首先，你需要在开始签署之前缓存模板：

await DocusignSdk.cacheTemplateWithId(templateId);

然后，在调用renderWithTemplateId时，将signingMode设置为DocuSignSigningMode.offline：

await DocusignSdk.renderWithTemplateId(
  templateId,
  signingMode: DocuSignSigningMode.offline,
  envelopeDefaults:
    EnvelopeDefaults(recipientDefaults: [recip])
);

签署完成后，由于信封是由本地生成的，你需要在适当的时候同步到服务器：

await DocusignSdk.syncEnvelopes();

完整示例代码

以下是一个完整的示例代码，展示了如何使用docu_sign_flutter_sdk插件进行文档签署：

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

import 'package:flutter/services.dart';
import 'package:docu_sign_flutter_sdk/docusign_sdk.dart';
import 'package:docu_sign_flutter_sdk/model.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息异步初始化
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await DocusignSdk.platformVersion;
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    String templateId = "fa94302b-0049-4362-a074-19e8b371de84";

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('DocuSign 插件示例'),
        ),
        body: Column(
          children: <Widget>[
            ElevatedButton(
              child: Text('移除缓存信封'),
              onPressed: () async {
                await DocusignSdk.removeCachedEnvelopes();
              },
            ),
            ElevatedButton(
              child: Text('监听信封通知'),
              onPressed: () async {
                await DocusignSdk.starListenEnvelopNotification();
              },
            ),
            ElevatedButton(
              child: Text('同步信封'),
              onPressed: () async {
                await DocusignSdk.syncEnvelopes();
              },
            ),
            ElevatedButton(
              child: Text('登录'),
              onPressed: () async {
                print('开始登录');
                await DocusignSdk.loginWithEmail(
                    email: 'myamolane@outlook.com',
                    password: 'password',
                    host: 'https://demo.docusign.net/restapi',
                    integratorKey: '768d67d9-dd18-4973-979c-376b23799fea');
              },
            ),
            ElevatedButton(
              child: Text('缓存模板'),
              onPressed: () async {
                await DocusignSdk.cacheTemplateWithId(templateId);
              },
            ),
            ElevatedButton(
              child: Text('移除缓存模板'),
              onPressed: () async {
                await DocusignSdk.removeCachedTemplateWithId(templateId);
              },
            ),
            ElevatedButton(
              child: Text('移除缓存信封（通过ID）'),
              onPressed: () async {
                await DocusignSdk.removeCachedEnvelopeWithId(
                    "9FED9521-0ECF-48C7-9863-923A3981E412");
                print('已移除');
              },
            ),
            ElevatedButton(
              child: Text('签署文件'),
              onPressed: () async {
                RecipientDefault recip = RecipientDefault(
                  recipientId: '123',
                  recipientRoleName: 'Visitor',
                  recipientEmail: 'enigmae@gmail.com',
                  recipientName: 'lucas test',
                  inPersonSignerName: 'Lucas K',
                  recipientType: RecipientType.recipientTypeInPersonSigner,
                );

                dynamic r = await DocusignSdk.renderWithTemplateId(templateId,
                    signingMode: DocuSignSigningMode.offline,
                    envelopeDefaults: EnvelopeDefaults(
                        emailSubject: '测试',
                        envelopeTitle: '测试信封',
                        tabValueDefaults: {'1': '2'},
                        emailBlurb: '',
                        recipientDefaults: [recip]));
                print('已签署');
                print(r);
              },
            ),
            ElevatedButton(
              child: Text('获取缓存信封ID列表'),
              onPressed: () async {
                await DocusignSdk.cachedEnvelopeIds();
              },
            ),
          ],
        ),
      ),
    );
  }
}