dengage_flutter

Installation

a) Edit your project's pubspec.yaml file to include the dengage_flutter SDK:

dependencies:
1.1.1

b) Run flutter pub get to install the SDK.

Platform Specific Extra Steps

Following extra steps after the installation of the dengage_flutter SDK are required for it to work properly.

  target 'DengageNotificationServiceExtension' do
     pod 'Dengage', :git => 'https://github.com/dengage-tech/dengage-ios-sdk.git', :branch => 'version/x.y.z'
  end

override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
      self.contentHandler = contentHandler
      bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
      
      if let bestAttemptContent = bestAttemptContent {
          // Modify the notification content here...
          bestAttemptContent.title = "\(bestAttemptContent.title)"
          // add this line of code
          Dengage.didReceiveNotificationRequest(bestAttemptContent, withContentHandler: contentHandler)
          contentHandler(bestAttemptContent)
      }
  }

import UIKit
import Flutter
import dengage_flutter          // ADD THIS IN IMPORTS
@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    /************* FLutter Setup Code Starts here ********************/
    // please Node key here is the integeration Key received while registering your iOS Application on Dengage Dashboard.
    let coordinator = DengageCoordinator.staticInstance;
    coordinator.setupDengage(key: "INTEGRATION_KEY",launchOptions: launchOptions as NSDictionary?, application: application,askNotificaionPermission:true,disableOpenURL:false,badgeCountReset: false);
     /************* FLutter Setup Code Ends here ********************/
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
    override func application( _ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
            let coordinator = DengageCoordinator.staticInstance;
            coordinator.registerForPushToken(deviceToken:deviceToken)
    }
}

import UIKit
import Flutter
import dengage_flutter          // ADD THIS IN IMPORTS
@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    /************* FLutter Setup Code Starts here ********************/
    // please Node key here is the integeration Key received while registering your iOS Application on Dengage Dashboard.
    let coordinator = DengageCoordinator.staticInstance;
  For geofence:
      coordinator.setupDengage(key: "INTEGRATION KEY", enableGeoFence : true,launchOptions: launchOptions as NSDictionary?, application: application,askNotificaionPermission:true,disableOpenURL:false,badgeCountReset: false);
Without geofence:
    coordinator.setupDengage(key: "INTEGRATION_KEY",launchOptions: launchOptions as NSDictionary?, application: application,askNotificaionPermission:true,disableOpenURL:false,badgeCountReset: false);
     /************* FLutter Setup Code Ends here ********************/
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
    override func application( _ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
            let coordinator = DengageCoordinator.staticInstance;
            coordinator.registerForPushToken(deviceToken:deviceToken)
    }
}

pod 'Dengage', :git => 'https://github.com/dengage-tech/dengage-ios-sdk.git', :branch => 'version/5.81'
 pod 'DengageGeofence', :git => 'https://github.com/dengage-tech/dengage-ios-sdk.git', :branch => 'version/5.81'

// import statement
  import com.example.dengage_flutter.DengageCoordinator;
  // ...
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // Following line need to be added
    DengageCoordinator.sharedInstance.setupDengage(
              true,
              "INTEGRATION_KEY",
              "your-huawei-key-here",
              false,false,
              applicationContext
      )
  }

        // for prod
        <meta-data
            android:name="den_push_api_url"
            android:value="https://push.dengage.com" />

        // for dev
        <!--    android:value="https://pushdev.dengage.com" />-->  

      // for prod
      <meta-data
          android:name="den_event_api_url"
          android:value="https://event.dengage.com" />
      
      // for dev
      <!--      android:value="https://eventdev.dengage.com" />-->

<meta-data
  android:name="den_geofence_api_url"
    android:value="https://push.dengage.com/geoapi/" />

Now you can setContactKey like mentioned [here](#setting-contact-key)

useHmsSdk=false  
dengageSdkVersion=6.0.81  
useGeofenceSdk=false  

Supported Versions

Usage

Subscription

**Subscription is a process which is triggered by sending subscription event to D·engage. It contains necessary informations about application to send push notifications to clients.**

Subscriptions are self managed by D·engage SDK and subcription cycle starts with Prompting user permission. SDK will automaticlly send subscription events under following circumstances:

• Initialization
• Setting Contact key
• Setting Token
• Setting User Permission (if you have manual management of permission)

Asking User Permission for Notification

Note: Android doesn't require to ask for push notifications explicitly. Therefore, you can only ask for push notification's permissions on iOS.

IOS uses shared UNUserNotificationCenter by itself while asking user to send notification. D·engage SDK manager uses UNUserNotificationCenter to ask permission as well. [Apple Doc Reference](https://developer.apple.com/documentation/usernotifications/asking_permission_to_use_notifications)

If in your application, you want to get UserNotification permissions explicitly, you can do by calling one of the following methods:

// At the top import
import 'package:dengage_flutter/dengage_flutter.dart';

// somewhere in your javascript/typescript code
DengageFlutter.promptForPushNotifications()

OR

// At the top import
import 'package:dengage_flutter/dengage_flutter.dart';

// somewhere in your javascript/typescript code
Object result = await DengageFlutter.promptForPushNotificationsWitCallback()

Setting Contact Key

Contact Key represents user id in your system. There are two types of devices. Anonymous Devices and Contact Devices. Contact Devices contains Contact Key.

To track devices by their contacts you need to set contact key on SDK.

Note: It is recommended to call this method, if you have user information. You should call in every app open and on login, logout pages.

// import statement
import 'package:dengage_flutter/dengage_flutter.dart';

// in js/ts code
Object result = await DengageFlutter.setContactKey(userId: String)


// You may need getting current contact key from SDK. In that case you can use getContactKey
Object result = await DengageFlutter.getContactKey()

Manual Management of Tokens

If you need to get current token or if you are managing token subscription process manually, you can use setToken and getToken functions.

// At the top import
import 'package:dengage_flutter/dengage_flutter.dart';

// somewhere in your javascript/typescript code
Object result = await DengageFlutter.getToken()

// setting the token that is taken manually
DengageFlutter.setToken(token)

User Permission Management (optional)

If you manage your own user permission states on your application you may send user permission by using setUserPermission method.

// At the top import
import 'package:dengage_flutter/dengage_flutter.dart';

// somewhere in your javascript/typescript code
DengageFlutter.setUserPermission(true)

// For getting last permission set by user
Object result = await DengageFlutter.getUserPermission(true)

Logging

SDK can provide logs for debuging. It displays queries and payloads which are sent to REST API’s.

To validate your inputs you can enable SDK’s log by a method.

// isVisible is Boolean. By default isVisible set to false.
DengageFlutter.setLogStatus(isVisible)

Handling Notification Action using onNotificationClicked event

SDK provides a listener if you want to get and parse payload manually, whenever a push notification is clicked.

// declare as class level static variable
  static const EventChannel eventChannel = EventChannel("com.dengage.flutter/onNotificationClicked");

  @override
  void initState() {
    // rest of code here ...

    eventChannel.receiveBroadcastStream().listen(_onEvent, onError: _onError);

    super.initState();
  }

  void _onEvent(Object event) {
    print("in on Event object is: ");
    print(event);
  }

  void _onError(Object error) {
    print("in on Error Object is: ");
    print(error);
  }

DeepLinking

SDK supports URL schema deeplink. If target url has a valid link, it will redirect to the related link.
Please see related links below about deeplinking.

Rich Notifications

Rich Notifications is a notification type which supports image, gif, video content. D·engage SDK supports varieties of contents and handles notification.
Rich Notifications supports following media types:

• Image
• Video
• Gif

For further details about rich notification and its setup on iOS side please follow [this link](https://dev.dengage.com/mobile-sdk/ios/richnotification)

Note: on Android there is no special setup required for rich notifications.

Carousel Push

Carousel Push is a notification type which has a different UI than Rich Notification. SDK will handle notification payload and displays UI if it’s a carousel push. Carousel Push functionality allows you to show your notification with a slideshow.

Action Buttons

Android SDK allows you to put clickable buttons under the notification. Action buttons are supported in Android SDK 2.0.0+.
For further setup of Action Buttons, follow [this link](https://dev.dengage.com/mobile-sdk/android/action-buttons) .

Sync adjust id with dengage platform

You can sync adjust adid with dengage through the following method

DengageFlutter.setPartnerDeviceId('adid')

Event Collection

In order to collect android mobile events and use that data to create behavioral segments in D·engage you have to determine the type of events and data that needs to collected. Once you have determined that, you will need to create a “Big Data” table in D·engage. Collected events will be stored in this table. Multiple tables can be defined depending on your specific need.

Any type of event can be collected. The content and the structure of the events are completely flexible and can be changed according to unique business requirements. You will just need to define a table for events.

Once defined, all you have to do is to send the event data to these tables. D·engage SDK has only two functions for sending events: sendDeviceEvent and sendCustomEvent. Most of the time you will just need the sendDeviceEvent function.

1. Login / Logout Action

If the user loggs in or you have user information, this means you have contact_key for that user. You can set contact_key in order to match user with the browser. There are two functions for getting and setting contact_key.

1.a setContactKey

If user logged in set user id. This is important for identifying your users. You can put this function call in every page. It will not send unnecessary events.
[code example is here](#setting-contact-key)

1.b getContactKey

to get the current user information from SDK getContactKey method can be used.

// in imports
import 'package:dengage_flutter/dengage_flutter.dart';

// in the code, where user information required
Object result = await DengageFlutter.getContactKey()

2. Event Collection

If your D·engage account is an ecommerce account, you should use standard ecommerce events in the SDK. If you need some custom events or your account is not standard ecommerce account, you should use custom event functions.

2.1 Events for Ecommerce Accounts

There are standard ecommerce events in D·engage SDK.

• [Page View Events](#page-view-events-details)

  • Home page view
  • Product page view
  • Category page view
  • Promotion page view

• [Shopping Cart Events](#shopping-cart-events)

  • Add to cart
  • Remove from cart
  • View Cart
  • Begin Checkout

• [Order Events](#order-events)

  • Order
  • Cancel order

• [Wishlist Events](#wishlist-events)

  • Add to wishlist
  • Remove from wishlist

• [Search Event](#search-event)

For these event there are related tables in your account. Following are the details and sample codes for each of above events.

Page View Events
Page view events will be sent to page_view_events table. If you add new columns to this table. You can send these in the event data.

// import at top
import 'package:dengage_flutter/dengage_flutter.dart';
...


// Home page view
DengageFlutter.pageView({
      "page_type":"home",
      "page_title": "home",
      "app_type": "Mobile",
      "page_url": ""
      // ... extra columns in page_view_events table, can be added here
    });

// Category page view
DengageFlutter.pageView({
    "page_type":"category",
    "category_id":"1",
    "page_title": "",
    "app_type": "Mobile",
    "page_url": ""
    // ... extra columns in page_view_events table, can be added here
})

// Product page view
DengageFlutter.pageView({
    "page_type":"product",
    "product_id":"1",
    "page_title": "",
    "app_type": "Mobile",
    "page_url": ""
    // ... extra columns in page_view_events table, can be added here
})

//promotion page view
DengageFlutter.pageView({
    "page_type":"promotion",
    "promotion_id":"1",
    "page_title": "",
    "app_type": "Mobile",
    "page_url": ""
    // ... extra columns in page_view_events table, can be added here
})

//custom page view
DengageFlutter.pageView({
    "page_type":"custom"
    "page_title": "custom",
    "app_type": "Mobile",
    "page_url": ""
    // ... extra columns in page_view_events table, can be added here
})

// For other pages you can send anything as page_type

Shopping Cart Events

These events will be stored in shopping_cart_events and shopping_cart_events_detail. There are 4 shopping cart event functions. addToCart, removeFromCart, viewCart, beginCheckout

// import statement
import 'package:dengage_flutter/dengage_flutter.dart';

// Add to cart action
const addParams = {
    "product_id":1,
    "product_variant_id":1,
    "quantity":1,
    "unit_price":10.00,
    "discounted_price":9.99
}
DengageFlutter.addToCart(addParams)

// ....
// Remove from cart action
const removeParams = {
    "product_id":1,
    "product_variant_id":1,
    "quantity":1,
    "unit_price":10.00,
    "discounted_price":9.99
}
DengageFlutter.removeFromCart(removeParams)

Order Events

Orders events will be sent to order_events and order_events_detail tables.

// Ordered items or canceled items must be added to an array
// import statement
import 'package:dengage_flutter/dengage_flutter.dart';

// Place order action
const placeOrderParams = {
    "order_id":1,
    "item_count":1, // total ordered item count
    "total_amount":1, // total price
    "discounted_price":9.99, // use total price if there is no discount
    "payment_method":"card",
    "shipping":5,
    "coupon_code":""
}
DengageFlutter.placeOrder(placeOrderParams)

// Cancel order action
const cancelParams = {
    "order_id":1, // canceled order id
    "item_count":1, // canceled total item count
    "total_amount":1, // canceled item's total price
    "discounted_price":9.99, // use total price if there is no discount
}
DengageFlutter.cancelOrder(cancelParams)

Wishlist Event

These events will be stored in wishlist_events and wishlist_events_detail.
There are 2 wishlist event functions. addToWishlist, removeFromWishlist

  // import statement 
  import 'package:dengage_flutter/dengage_flutter.dart';

  // Add to wishlist action
  const params = [
      "product_id": 1
  ]
  DengageFlutter.addToWishList(params)

  // Remove from wishlist action
  const removeParams = [
      "product_id": 1,
  ]
  DengageFlutter.removeFromWishList(removeParams)

Search Event

Search events will be stored in search_events table.

  const params = {
      "keywords":"some product name", // text in the searchbox
      "result_count":12,
      "filters":"" //you can send extra filters selected by user here. Formating is not specified
      // ... extra columns in search_events table, can be added here
  }
  DengageFlutter.search(params)

2.1 Custom Events

Send device specific events

You can use sendDeviceEvent function for sending events for the device. Events are sent to a big data table defined in your D·engage account. That table must have relation to the master_device table. If you set contact_key for that device. Collected events will be associated for that user.

// for example if you have a table named "events"
// and events table has "key", "event_date", "event_name", "product_id" columns
// you just have to send the columns except "key" and "event_date", because those columns sent by the SDK
// methodSignature => dengage(‘sendDeviceEvent’, tableName: String, dataObject, callback);
  Map data = new HashMap<String, dynamic>();
  data["name"] = "Kamran Younis";
  await DengageFlutter.sendDeviceEvent("tableName", data);

App Inbox

App Inbox is a screen within a mobile app that stores persistent messages. It’s kind of like an email inbox, but it lives inside the app itself. App Inbox differs from other mobile channels such as push notifications or in-app messages. For both push and in-app messages, they’re gone once you open them.

In other words, D·engage admin panel lets you keep selected messages on the platform and Mobile SDK may retreive and display these messages when needed.

In order to save messages into App Inbox, you need to select “Save to Inbox” option when sending messages in D·engage admin panel by assigning an expire date to it.

Inbox messages are kept in the memory storage of the phone until app is completely closed or for a while and D·engage SDK provides functions for getting and managing these messages.

Requirements

• Android: D·engage SDK 3.2.3+
• iOS: D·engage SDK 2.5.21+

Methods

There are 3 methods to manage App Inbox Messages

• To get app inbox messages from the server

  List< dynamic>  result = await DengageFlutter.getInboxMessages(offset, limit).catch(err => err)
    // where offset: Int, limit: Int = 20
    // inboxMessages now either have array of Inbox messages or an error.

• To delete a specific message from the inbox.

    Object result = await DengageFlutter.deleteInboxMessage(id).catch(err => err)
    // where id: String
    // delMsgResponse now either have {success: true, id: "id-of-msg-deleted"} or an error

• to mark a specific message as clicked.

    Object result = await DengageFlutter.setInboxMessageAsClicked(id).catch(err => err)
    // where id: String &
    // msgSetAsClicked now either have {success: true, id: "id-of-msg-deleted"} or an error

In-App Messaging

In-app message is a type of mobile message where the notification is displayed within the app. It is not sent in a specific time but it is show to user when user are using the app. Examples include popups, yes/no prompts, banners, and more. In order to show in-app messages, there is no permission requirement.

Requirements

• iOS: D·engage SDK 3.2.3+
• android: D·engage SDK 3.2.3+

Methods

Created messages will be stored in D·engage backend and will be served to mobile SDKs. If you integrated mobile SDK correctly for push messages, for using in-app features you just have to add setNavigtion function to every page navigation.
If you want to use screen name filter, you should send screen name to setNavigation function in every page navigation.

Simple In App Messaging

  DengageFlutter.setNavigation()

In App Messaging with Screen Name

  DengageFlutter.setNavigation('cart')

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

Real Time In-App Messaging

You can use the real time in-app functionality by using the function.

Dengage.setNavigation()

Debgage.setNavigationWithName(“screen name”)

Dengage.showRealTimeInapp(“screen name”,{“cartItems”:1}