• Release Notes
  • User
  • Admin
  • Developers
  • Integrations

›Flutter

General

  • Overview
  • LiveView / CoBrowsing / Session Recordings

JS API

  • Overview
  • CoBrowsing
  • LiveView / Session Recordings
  • WebChat
  • Web Calling
  • Video Conference
  • Logging
  • User
  • Team
  • API
  • Supported Browsers
  • Supported Technologies

Android

  • Overview
  • Installation
  • Usage
  • Reference
  • Licenses

iOS

  • Overview
  • Installation
  • Usage
  • Reference
  • Licenses

React Native

  • Overview
  • Installation
  • Usage
  • Reference

Cordova/Capacitor

  • Overview
  • Installation
  • Usage

Xamarin

  • Overview
  • Installation
  • Usage
  • Reference

Flutter

  • Overview
  • Installation
  • Usage
  • Reference

Usage

Import it

import 'package:engage_plugin/engage_plugin.dart';

Initialization

final _engagePlugin = EngagePlugin();
var initConfig = InitConfig(
      "TenantId", "Token", "ServerUrl(optional)", "cdnServerUrl(optional)", chatOverlayVisibility: Bool(optional, default value is true), deeplinkUrls: List<String>(optional));

You may initialize the library any time during the life of your application.

_engagePlugin.init(initConfig)

To start co-browsing you should use

_engagePlugin.startCoBrowsing()

To stop co-browsing you should use

_engagePlugin.stopCoBrowsing()

To tag a user you must enter the user info first

var tagUserInfo =
      TagUserInfo(["Labels", "list"], "Email", "FirstName", "LastName", "ID", "AssignedUser", "ExternalToken", {"AdditionalTagging":"Data"};
_engagePlugin.tagUser(tagUserInfo)

To clear a user you should use

_engagePlugin.clear()

For a better reference on how to use the plugin you can check this example.

← InstallationReference →
  • Import it
  • Initialization
MANUALS
User Manual: Sales Suite
Admin Manual: Sales Suite
User Manual: Support Suite
Admin Manual: Support Suite
DEVELOPERS
Integrations
REST API
SDK API
LEGAL
Privacy Policy
Terms and Conditions
Imprint
Engage
Copyright © 2023 Chatvisor GmbH