Flutter Move SDK

Flutter package for MOVE SDK - please see MOVE SDK Documentation for features and details about the MOVE SDK.

Installation

Add the Dolphin MOVE SDK package to your Flutter app using:

flutter pub add movesdk

Or, by adding it as a dependency to your pubspec.yaml file and running:

flutter pub get

See Flutter Package and Plugin Usage for further information regarding package use.

import 'package:movesdk/movesdk.dart';

Android

The SDK needs to be initialized at the start of the app by calling MoveSdk.init. It is recommended to put this in the Application’s onCreate method. This will load the persistent Move SDK state.

import io.dolphin.move.MoveSdk

class MainApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val sdk = MoveSdk.init(this)
        // Additional initialization code can go here
    }
}

iOS

Initialization happens automatically in appDidFinishLaunching.

Support

For support, contact info@dolph.in.

License

The contents of this repository are licensed under the Apache License, version 2.0.

Example

Dolphin MOVE SDK Flutter Example

Reference: MOVE SDK Documentation.

Example Project on GitHub

An example for the Dolphin Move SDK Flutter plugin.

App Cycle

On app initialization, the SDK will be initialized automatically and store its persisted state.

Toggle Activation Switch: ON

• Creates a user for you if no user already exists.
• The SDK will be in the ready state, and the app will automatically start SDK services using the startAutomaticDetection API.

Toggle Activation Switch: OFF

• Stops the SDK services using the stopAutomaticDetection API.
• As the sample app is using the stopAutomaticDetection API and not shutdown, the SDK state will only transition to the ready state and not shut down. Hence, future toggles will only start SDK services without re-creating a user or re-initializing the SDK.

The SDK activation toggling state is persisted for future initializations.

To Run This Project

1. Request a product API Key by contacting Dolphin MOVE.

2. Insert API key “Bearer <YOUR_API_KEY>” in the appropriate place in the code.

3. Launch a device such as the iOS Simulator.

4. Using the terminal, run:

   flutter run lib/io/dolphin/move/example/main.dart
   

Starting Point

SDK Setup

Authorization

After contacting us and getting a product API key, use it to fetch a MoveAuth from the Move Server. The MoveAuth object will be passed to the SDK on initialization and be used by the SDK to authenticate its services.

If the provided MoveAuth was invalid, the SDK will not try to fetch a new auth through the auth expiry listener. Check the documentation for details.

The setup is persisted for the SDK to automatically continue when the app is relaunched from the background.

To unregister the user with the SDK, use the shutdown method.

Configuration

MoveConfig allows host apps to configure which of the licensed Move services should be enabled. It could be based on each user preference or set from a remote server. Services which do not have the required permissions may not run or only collect incomplete data.

Support

For support, contact info@dolph.in.

License

The contents of this repository are licensed under the Apache License, version 2.0.

Complete Example Code

Here is a complete example of how to use the MOVE SDK in a Flutter application:

pubspec.yaml

name: move_example
description: A new Flutter project.

publish_to: 'none' # Remove this line if you wish to publish to pub.dev

version: 1.0.0+1

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter
  movesdk: ^1.0.0

dev_dependencies:
  flutter_test:
    sdk: flutter

flutter:
  uses-material-design: true

lib/main.dart

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

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'MOVE SDK Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MoveHomePage(),
    );
  }
}

class MoveHomePage extends StatefulWidget {
  @override
  _MoveHomePageState createState() => _MoveHomePageState();
}

class _MoveHomePageState extends State<MoveHomePage> {
  bool _isActivated = false;

  @override
  void initState() {
    super.initState();
    _initializeSDK();
  }

  Future<void> _initializeSDK() async {
    // Initialize the SDK with your API key
    final moveAuth = MoveAuth(apiKey: 'Bearer YOUR_API_KEY');
    await MoveSdk.init(moveAuth);
  }

  Future<void> _toggleActivation(bool value) async {
    setState(() {
      _isActivated = value;
    });

    if (value) {
      await MoveSdk.startAutomaticDetection();
    } else {
      await MoveSdk.stopAutomaticDetection();
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('MOVE SDK Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Toggle MOVE SDK Activation:',
            ),
            Switch(
              value: _isActivated,
              onChanged: _toggleActivation,
            ),
          ],
        ),
      ),
    );
  }
}

android/app/src/main/kotlin/com/example/move_example/MainApplication.kt

package com.example.move_example

import android.app.Application
import io.dolphin.move.MoveSdk

class MainApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val sdk = MoveSdk.init(this)
        // Additional initialization code can go here
    }
}

ios/Runner/AppDelegate.swift

Initialization happens automatically in appDidFinishLaunching.

import UIKit
import Flutter

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

This example demonstrates how to initialize the MOVE SDK, toggle its activation, and handle basic UI interactions in a Flutter application. Make sure to replace 'Bearer YOUR_API_KEY' with your actual API key.