Flutter集成Venixs服务插件venixs_sdk的使用

Flutter集成Venixs服务插件venixs_sdk的使用

Venixs Flutter Wrapper

特性

此库实现了一个封装，通过该封装可以使用由Venixs提供的聊天SDK，从而促进您的客户与您的沟通。

开始使用

在您的pubspec.yaml文件中添加Venixs_SDK包：

dependencies:
  venixs_sdk: ^x.x.x

然后运行flutter pub get以安装依赖项。

设置

Android

要为Android项目设置此项目，请按照以下步骤操作：

1. 在您的gradle.properties文件中添加以下内容：

android.useAndroidX=true
android.enableJetifier=true

1. 如果之前minSdkVersion低于19，请将其设置为19或更高。在您的android/app/build.gradle文件中进行更改：

android {
  minSdkVersion 19 # 设置为19或更高

  ...
}

Dart/Flutter

1. 要初始化插件，请在您的main.dart文件中调用插件实例：

final Venixs venixSdk = Venixs.instance;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  SystemChrome.setPreferredOrientations([DeviceOrientation.portraitUp])
      .then((_) async {
    // TODO: 获取并在此处放置您的Venixs公共API密钥
    await Venixs.initializeInterface(publicKey: '<PUBLIC KEY HERE>');
    runApp(const MyApp());
  },
  );
}

...

1. 调用Venixs聊天视图方法并传递必要的数据：

venixSdk.initiate(
  context,
  email: 'example@email.com',
  firstName: 'John',
  lastName: 'Doe',
);

使用示例按钮

只需从您喜欢的任何按钮小部件中调用初始化方法：

ElevatedButton(
  onPressed: () => venixSdk.initiate(
    context,
    email: 'example@email.com',
    firstName: 'John',
    lastName: 'Doe',
  ),
  child: Text('呼叫SDK'),
),

问题

如果您有任何问题，请发送邮件至 <a href="mailto:support@venixs.com">support@venixs.com</a>。

发现问题或有建议？

请访问我们的网站 <a href="https://venixs.com" rel="ugc">https://venixs.com</a> 或发送邮件至 <a href="mailto:support@venixs.com">support@venixs.com</a>。

示例代码

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

import 'package:flutter/services.dart';
import 'package:venixs_sdk/venixs_sdk.dart';

final Venixs venixSdk = Venixs.instance;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  SystemChrome.setPreferredOrientations([DeviceOrientation.portraitUp])
      .then((_) async {
    // TODO: 获取并在此处放置您的Venixs公共API密钥
    await Venixs.initializeInterface(publicKey: '/*<Account Public Api Key Here>*/');
    runApp(const MyApp());
  },
  );
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> with SingleTickerProviderStateMixin {
  String _platformVersion = 'Unknown';
  late AnimationController _controller;

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

    _controller = AnimationController(
      vsync: this,
      duration: const Duration(seconds: 1),
    )..repeat();
  }

  // 平台消息是异步的，因此我们在异步方法中进行初始化。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能会失败，所以我们使用一个try/catch来处理PlatformException。
    // 我们还处理了消息可能返回null的情况。
    try {
      // platformVersion =
      //     await venixSdk.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;
  }

  [@override](/user/override)
  void dispose() {
    _controller.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Venixs AI Chat 测试'),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          Row(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () => venixSdk.initiate(
                  context,
                  email: 'example@gmail.com',
                  firstName: '测试',
                  lastName: '测试1',
                  /// TODO: 在设置`enableNotification`为true之前确保实现了firebase_messaging
                ),
                child: const Text('呼叫SDK'),
              ),
            ],
          ),
        ],
      ),
    );
  }
}