Add Datastream override feature to Edge plugin.

README.md

@@ -15,6 +15,9 @@ This repository is a monorepo. It contains a collection of Adobe Experience Plat
 | [UserProfile](plugins/flutter_aepuserprofile/README.md) | [![pub package](https://img.shields.io/pub/v/flutter_aepuserprofile.svg)](https://pub.dartlang.org/packages/flutter_aepuserprofile) |
 | [Messaging](plugins/flutter_aepmessaging/README.md) | [![pub package](https://img.shields.io/pub/v/flutter_aepmessaging.svg)](https://pub.dartlang.org/packages/flutter_aepmessaging) |
 
+> [!NOTE]  
+> The Flutter plugins within this repository are specifically designed to support the Android and iOS platforms only.
+
 ## iOS Privacy Manifest
 
 > [!IMPORTANT]  

example/lib/edge.dart

@@ -51,13 +51,144 @@ class _MyAppState extends State<EdgePage> {
     });
   }
 
-  Future<void> sendEvent([datasetId]) async {
+  //Using Dictionaries method
+  Future<void> sendEventWithDictionaryDatasetId([datasetId]) async {
     late List<EventHandle> result;
     Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
     Map<String, dynamic> data = {"free": "form", "data": "example"};
 
     final ExperienceEvent experienceEvent = ExperienceEvent(
-        {"xdmData": xdmData, "data": data, "datasetIdentifier": datasetId});
+        {"xdmData": xdmData, "data": data, "datasetIdentifier": datasetId,"datastreamIdOverride": "sampleDatastreamID",});
+
+    result = await Edge.sendEvent(experienceEvent);
+
+    if (!mounted) {
+      log('Failed to setState, widget is not mounted');
+      return;
+    }
+
+    setState(() {
+      _edgeEventHandleResponse = result;
+      print("result info " + result.toString());
+    });
+  }
+
+  Future<void> sendEventWithDictionaryDatastreamIdOverride() async {
+    late List<EventHandle> result;
+    Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+    Map<String, dynamic> data = {"free": "form", "data": "example"};
+
+    final ExperienceEvent experienceEvent = ExperienceEvent(
+      {
+        "xdmData": xdmData,
+        "data": data,
+        "datastreamIdOverride": "sampleDatastreamID",
+      });
+
+    result = await Edge.sendEvent(experienceEvent);
+
+    if (!mounted) {
+      log('Failed to setState, widget is not mounted');
+      return;
+    }
+
+    setState(() {
+      _edgeEventHandleResponse = result;
+      print("result info " + result.toString());
+    });
+  }
+
+  Future<void> sendEventWithDictionaryDatastreamConfigOverride() async {
+    late List<EventHandle> result;
+    Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+    Map<String, dynamic> data = {"free": "form", "data": "example"};
+    Map<String, dynamic> configOverrides = {"config": {
+      "com_adobe_experience_platform": {
+        "datasets": {
+          "event": {
+            "datasetId": "sampleDatasetID"
+          }
+        }
+      }
+    }};
+
+    final ExperienceEvent experienceEvent = ExperienceEvent(
+      {
+        "xdmData": xdmData,
+        "data": data,
+        "datastreamConfigOverride": configOverrides,
+      });
+
+    result = await Edge.sendEvent(experienceEvent);
+
+    if (!mounted) {
+      log('Failed to setState, widget is not mounted');
+      return;
+    }
+
+    setState(() {
+      _edgeEventHandleResponse = result;
+      print("result info " + result.toString());
+    });
+  }
+
+  //Using Constructors
+  Future<void> sendEventWithConstructorDatasetId([datasetId]) async {
+    late List<EventHandle> result;
+    Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+    Map<String, dynamic> data = {"free": "form", "data": "example"};
+
+    final ExperienceEvent experienceEvent = ExperienceEvent.createEvent(xdmData, data, datasetId);
+
+    result = await Edge.sendEvent(experienceEvent);
+
+    if (!mounted) {
+      log('Failed to setState, widget is not mounted');
+      return;
+    }
+
+    setState(() {
+      _edgeEventHandleResponse = result;
+      print("result info " + result.toString());
+    });
+  }
+
+  Future<void> sendEventWithConstructorDatastreamIdOverride() async {
+    late List<EventHandle> result;
+    Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+    Map<String, dynamic> data = {"free": "form", "data": "example"};
+
+    final ExperienceEvent experienceEvent = ExperienceEvent.createEventWithOverrides(xdmData, data, "sampleDatastreamID");
+
+    result = await Edge.sendEvent(experienceEvent);
+
+    if (!mounted) {
+      log('Failed to setState, widget is not mounted');
+      return;
+    }
+
+    setState(() {
+      _edgeEventHandleResponse = result;
+      print("result info " + result.toString());
+    });
+  }
+
+  Future<void> sendEventWithConstructorDatastreamConfigOverride() async {
+    late List<EventHandle> result;
+    Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+    Map<String, dynamic> data = {"free": "form", "data": "example"};
+    //To override eventDataset using datastream config overrides
+    Map<String, dynamic> configOverrides = {"config": {
+      "com_adobe_experience_platform": {
+        "datasets": {
+          "event": {
+            "datasetId": "sampleDatasetID"
+          }
+        }
+      }
+    }};
+
+    final ExperienceEvent experienceEvent = ExperienceEvent.createEventWithOverrides(xdmData, data, null, configOverrides);
 
     result = await Edge.sendEvent(experienceEvent);
 
@@ -96,14 +227,34 @@ class _MyAppState extends State<EdgePage> {
       appBar: AppBar(title: Text("Edge Screen")),
       body: Center(
         child: ListView(shrinkWrap: true, children: <Widget>[
-          getRichText('AEPEdge extension version: ', '$_edgeVersion\n'),
+          getRichText('AEPEdge extension version: ', '$_edgeVersion\n'), 
+          ElevatedButton(
+            child: Text("sendEventWithDictionary"),
+            onPressed: () => sendEventWithDictionaryDatasetId(),
+          ),
+          ElevatedButton(
+            child: Text("sendEventWithDictionary to Dataset"),
+            onPressed: () => sendEventWithDictionaryDatasetId('datasetId_example'),
+          ),
+          ElevatedButton(
+            child: Text("sendEventWithDictionary datastreamIdOverride"),
+            onPressed: () => sendEventWithDictionaryDatastreamIdOverride(),
+          ),
+          ElevatedButton(
+            child: Text("sendEventWithDictionary datastreamConfigOverride"),
+            onPressed: () => sendEventWithDictionaryDatastreamConfigOverride(),
+          ),
+           ElevatedButton(
+            child: Text("sendEventWithConstructor to Dataset"),
+            onPressed: () => sendEventWithConstructorDatasetId('datasetId_example'),
+          ),
           ElevatedButton(
-            child: Text("sentEvent(...)"),
-            onPressed: () => sendEvent(),
+            child: Text("sendEventWithConstructor datastreamIdOverride"),
+            onPressed: () => sendEventWithConstructorDatastreamIdOverride(),
           ),
           ElevatedButton(
-            child: Text("sentEvent to Dataset"),
-            onPressed: () => sendEvent('datasetIdExample'),
+            child: Text("sendEventWithConstructor datastreamConfigOverride"),
+            onPressed: () => sendEventWithConstructorDatastreamConfigOverride(),
           ),
           getRichText(
               'Response event handles: = ', '$_edgeEventHandleResponse\n'),

plugins/flutter_aepedge/README.md

@@ -174,23 +174,101 @@ final ExperienceEvent experienceEvent = ExperienceEvent({
 });
 List<EventHandle> result = await Edge.sendEvent(experienceEvent);
 ```
+
+**Example with Datastream ID override**
+```dart
+Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+final ExperienceEvent experienceEvent = ExperienceEvent({
+  "xdmData": xdmData,
+  "datastreamIdOverride": "SampleDatastreamId"
+});
+List<EventHandle> result = await Edge.sendEvent(experienceEvent);
+```
+
+**Example with Datastream confg override**
+```dart
+Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+Map<String, dynamic> configOverrides = {"config": {
+      "com_adobe_experience_platform": {
+        "datasets": {
+          "event": {
+            "datasetId": "sampleDatasetID"
+          }
+        }
+      }
+    }};
+final ExperienceEvent experienceEvent = ExperienceEvent({
+  "xdmData": xdmData,
+  "datastreamConfigOverride": configOverrides
+});
+List<EventHandle> result = await Edge.sendEvent(experienceEvent);
+```
 ------
 ### Public classes
 #### ExperienceEvent
 Experience Event is the event to be sent to Adobe Experience Platform Edge Network. The XDM data is required for any Experience Event being sent using the Edge extension.
 
-##### Create Experience Event from Dictionary:
+You can create Experience Event either by using dictionaries or by utilizing convenience constructors.
 
+**Syntax**
 ```dart
-Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
+//Create Experience Event from Dictionary
+ExperienceEvent(this.eventData) 
+
+//Create Experience event using convenience constructor
+ExperienceEvent.createEventWithOverrides(final Map<String, dynamic> xdmData,
+    [final Map<String, dynamic>? data, final String? datastreamIdOverride, final Map<String, dynamic>? datastreamConfigOverride])
+
+```
+
+**Usage**
+##### Create Experience Event from Dictionaries:
+```dart
+// set free form data to the Experience event:
 final ExperienceEvent experienceEvent = ExperienceEvent({
-  "xdmData": xdmData
+  "xdmData": xdmData,
+  "data": data
+});
+
+// Set free form data and datastream id override to the current Experience event:
+final ExperienceEvent experienceEvent = ExperienceEvent({
+  "xdmData": xdmData,
+  "data": data,
+  "datastreamIdOverride": "sampleDatastreamId"
+});
+
+// Set free form data and datastream config override to the current Experience event:
+final ExperienceEvent experienceEvent = ExperienceEvent({
+  "xdmData": xdmData,
+  "data": data,
+  "datastreamConfigOverride": configOverrides
 });
 ```
 
-##### Add free form data to the Experience event:
+##### Create Experience event using convenience constructors:
+```dart
+// set free form data to the Experience event:
+final ExperienceEvent experienceEvent =
+      ExperienceEvent.createEventWithOverrides(xdmData, data);
+
+// Set free form data and datastream id override to the current Experience event:
+final ExperienceEvent experienceEvent =
+      ExperienceEvent.createEventWithOverrides(xdmData, data, "sampleDatastreamId");
+
+// Set free form data and datastream config override to the current Experience event:
+final ExperienceEvent experienceEvent =
+      ExperienceEvent.createEventWithOverrides(xdmData, data, null, configOverrides);
+
+
+```
+
+**Example**
+
+Examples of Creating Experience Event Using Dictionaries.
 
 ```dart
+// example 1
+// set free form data to the Experience event:
 Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
 Map<String, dynamic> data = {"free": "form", "data": "example"};
 final ExperienceEvent experienceEvent = ExperienceEvent({
@@ -199,27 +277,36 @@ final ExperienceEvent experienceEvent = ExperienceEvent({
 });
 ```
 
-##### Set the destination Dataset identifier to the current Experience event:
-
 ```dart
+// example 2
+// Set free form data and datastream id override to the current Experience event:
 Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
-final ExperienceEvent experienceevent = ExperienceEvent({
+Map<String, dynamic> data = {"free": "form", "data": "example"};
+final ExperienceEvent experienceEvent = ExperienceEvent({
   "xdmData": xdmData,
-  "data": null,
-  "datasetIdentifier": "datasetIdExample"
+  "data": data,
+  "datastreamIdOverride": "sampleDatastreamId"
 });
 ```
 
-##### Create Experience Event with xdmdata, free form data and the destination Dataset identifier:
-
 ```dart
+// example 3
+// Set datastream config override to the current Experience event:
 Map<String, dynamic> xdmData = {"eventType": "SampleEventType"};
-Map<String, dynamic> data = {"free": "form", "data": "example"};
+Map<String, dynamic> configOverrides = {"config": {
+      "com_adobe_experience_platform": {
+        "datasets": {
+          "event": {
+            "datasetId": "sampleDatasetID"
+          }
+        }
+      }
+   } 
+}
 
 final ExperienceEvent experienceEvent = ExperienceEvent({
   "xdmData": xdmData,
-  "data": data,
-  "datasetIdentifier": "datasetIdExample"
+  "datastreamConfigOverride": configOverrides
 });
 ```
 #### EventHandle
@@ -229,6 +316,8 @@ The EventHandle is a response fragment from Adobe Experience Platform Edge Netwo
 static const String _type = 'type';
 static const String _payload = 'payload';
 ```
+## Next steps - Schemas setup and validation with Assurance
+For examples on XDM schemas and datasets setup and tips on validating with Assurance, refer to the [Edge Network tutorial](https://github.com/adobe/aepsdk-edge-ios/blob/main/Documentation/Tutorials).
 
 ## Contributing
 See [CONTRIBUTING](https://github.com/adobe/aepsdk_flutter/blob/main/CONTRIBUTING.md)