mesh_sdk_flutter 1.1.2

mesh_sdk_flutter: ^1.1.2 copied to clipboard

Flutter package for integrating with Mesh Connect.

Requirements #

• Dart >= 3.9.2
• Flutter >= 3.35.7

Getting started #

To use the Mesh SDK in your Flutter application, add the following dependency to your pubspec.yaml file:

dependencies:
  mesh_sdk_flutter: <latest_version>

Localization #

Mesh SDK uses the flutter_localizations package for localization.

For it to work, you need to add MeshLocalizations.localizationsDelegates to your MaterialApp.localizationsDelegates, like so:

import 'package:mesh_sdk_flutter/mesh_sdk_flutter.dart';

@override
Widget build(BuildContext context) {
  return MaterialApp(
    localizationsDelegates: [
      ...
      MeshLocalizations.localizationsDelegates,
    ],
  );
}

Get Link Token #

Link token should be obtained from the POST /api/v1/linktoken endpoint. API reference for this request is available here. The request must be performed from the server side because it requires the client's secret. You will get the response in the following format:

{
  "content": {
    "linkToken": "{linkToken}"
  },
  "status": "ok",
  "message": ""
}

Usage #

Future<void> _showMeshLinkPage(String linkToken) async {
  final result = await MeshSdk.show(
    context,
    configuration: MeshConfiguration(
      language: 'en',
      integrationAccessTokens: const [
        IntegrationAccessToken(
          accessToken: 'token',
          accountId: 'id',
          accountName: 'name',
          brokerName: 'broker',
          brokerType: 'type',
        ),
      ],
      linkToken: linkToken,
      onEvent: (event) {
        print('Mesh event: $event');
      },
      onError: (errorType) {
        print('Mesh exit: $errorType');
      },
      onIntegrationConnected: (integration) {
        print('Integration connected: $integration');
      },
      onTransferFinished: (transfer) {
        print('Transfer finished: $transfer');
      },
    ),
  );

  switch (result) {
    case MeshSuccess():
      print('Mesh link finished successfully');
    case MeshError():
      print('Mesh link error: ${result.type}');
  }
}

See full example app here.

Configuration #

Here's what you can configure in the MeshConfiguration:

Whitelist #

See the full list of whitelisted origins here.

To disable the whitelist check, set isDomainWhitelistEnabled: false in the MeshConfiguration.

System language and theme #

To adapt the Link UI to the user's device settings, use:

• language: 'system' — Uses the device/app locale for the Link UI (same behavior as the Web SDK).
• theme — e.g. ThemeMode.system to follow device light/dark mode (sent as th in the link URL).

These map to the same Link URL parameters (lng,th) as the Web SDK.