Edge Network API reference

data-slots=heading, code

data-repeat=2

Syntax

public static String extensionVersion();

Example

String extensionVersion = Edge.extensionVersion();

data-slots=heading, code

data-repeat=1

Example

val extensionVersion = EdgeBridge.extensionVersion()

data-slots=heading, code

data-repeat=2

Syntax

static let extensionVersion

Example

let extensionVersion = Edge.extensionVersion

data-slots=heading, code

data-repeat=2

Syntax

+ (nonnull NSString*) extensionVersion;

Example

NSString *extensionVersion = [AEPMobileEdge extensionVersion];

data-slots=heading, code

data-repeat=2

Syntax

public static void getLocationHint(final AdobeCallback<String> callback)

Example

Edge.getLocationHint(new AdobeCallbackWithError<String>() {
    @Override
    public void call(final String hint) {
        // Handle the hint here
    }

    @Override
    public void fail(AdobeError adobeError) {
        // Handle the error here
    }
});

data-slots=heading, code

data-repeat=1

Example

Edge.getLocationHint(object: AdobeCallbackWithError<String> {
    override fun call(hint: String) {
      // Handle the hint here
    }
    override fun fail(error: AdobeError?) {
      // Handle the error here
    }
})

data-slots=heading, code

data-repeat=2

Syntax

static func getLocationHint(completion: @escaping (String?, Error?) -> Void)

Example

Edge.getLocationHint { (hint, error) in
  if let error = error {
    // Handle the error here
  } else {
    // Handle the location hint here
  }
}

data-slots=heading, code

data-repeat=2

Syntax

+ (void) getLocationHint:^(NSString * _Nullable hint, NSError * _Nullable error)completion

Example

[AEPMobileEdge getLocationHint:^(NSString *hint, NSError *error) {
    // handle the error and the hint here
}];

data-slots=heading, code

data-repeat=2

Syntax

public static void registerExtension();

Example

Edge.registerExtension();

data-slots=heading, code

data-repeat=6

Syntax

public static void sendEvent(final ExperienceEvent experienceEvent,
                             final EdgeCallback callback);

Example

// Create Experience Event from map
Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "SampleXDMEvent");
xdmData.put("sample", "data");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .build();

Example 1

// Example 1 - send the Experience Event without handling the Edge Network response
Edge.sendEvent(experienceEvent, null);

Example 2

// Example 2 - send the Experience Event and handle the Edge Network response onComplete
Edge.sendEvent(experienceEvent, new EdgeCallback() {
  @Override
  public void onComplete(final List<EdgeEventHandle> handles) {
        // Handle the Edge Network response
  }
});

Example with Datastream ID override

// Create experience event from Map
Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "SampleXDMEvent");
xdmData.put("sample", "data");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .setDatastreamIdOverride("SampleDatastreamId")
  .build();

Edge.sendEvent(experienceEvent, new EdgeCallback() {
  @Override
  public void onComplete(final List<EdgeEventHandle> handles) {
    // Handle the Edge Network response
  }
});

Example with Datastream config override

// ----------------- Datastream config overrides map start -----------------
Map<String, Object> configOverrides = new HashMap<>();

// com_adobe_experience_platform
Map<String, Object> experiencePlatform = new HashMap<>();
Map<String, Object> datasets = new HashMap<>();

Map<String, Object> eventDataset = new HashMap<>();
eventDataset.put("datasetId", "SampleEventDatasetIdOverride");

datasets.put("event", eventDataset);

experiencePlatform.put("datasets", datasets);
configOverrides.put("com_adobe_experience_platform", experiencePlatform);

// com_adobe_analytics
Map<String, Object> analytics = new HashMap<>();
analytics.put("reportSuites", new String[]{"rsid1", "rsid2", "rsid3"});
configOverrides.put("com_adobe_analytics", analytics);

// com_adobe_identity
Map<String, Object> identity = new HashMap<>();
identity.put("idSyncContainerId", "1234567");
configOverrides.put("com_adobe_identity", identity);

// com_adobe_target
Map<String, Object> target = new HashMap<>();
target.put("propertyToken", "SamplePropertyToken");
configOverrides.put("com_adobe_target", target);
// ----------------- Datastream config overrides map end -----------------

// Create experience event from Map
Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "SampleXDMEvent");
xdmData.put("sample", "data");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .setDatastreamConfigOverride(configOverrides)
  .build();

Edge.sendEvent(experienceEvent, new EdgeCallback() {
  @Override
  public void onComplete(final List<EdgeEventHandle> handles) {
    // Handle the Edge Network response
  }
});

data-slots=heading, code

data-repeat=5

Example

// Create Experience Event from map
val xdmData = mutableMapOf<String, Any>()
xdmData["eventType"] = "SampleXDMEvent"
xdmData["sample"] = "data"

val experienceEvent = ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .build()

Example 1

// Example 1 - send the Experience Event without handling the Edge Network response
Edge.sendEvent(experienceEvent, null)

Example 2

// Example 2 - send the Experience Event and handle the Edge Network response onComplete
Edge.sendEvent(experienceEvent) {
  // Handle the Edge Network response
}

Example with Datastream ID override

// Create experience event from Map
val xdmData = mutableMapOf<String, Any>()
xdmData["eventType"] = "SampleXDMEvent"
xdmData["sample"] = "data"

val experienceEvent = ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .setDatastreamIdOverride("SampleDatastreamId")
  .build()

Edge.sendEvent(experienceEvent) {
  // Handle the Edge Network response
}

Example with Datastream config override

// Create experience event from Map
val xdmData = mutableMapOf<String, Any>()
xdmData["eventType"] = "SampleXDMEvent"
xdmData["sample"] = "data"

val configOverrides = mapOf(
                "com_adobe_experience_platform" to mapOf(
                    "datasets" to mapOf(
                        "event" to mapOf("datasetId" to "SampleEventDatasetIdOverride")
                    )
                ),
                "com_adobe_analytics" to mapOf(
                    "reportSuites" to listOf("rsid1", "rsid2", "rsid3")
                ),
                "com_adobe_identity" to mapOf(
                    "idSyncContainerId" to "1234567"
                ),
                "com_adobe_target" to mapOf(
                    "propertyToken" to "SamplePropertyToken"
                )
            )

val experienceEvent = ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .setDatastreamConfigOverride(configOverrides)
  .build()

Edge.sendEvent(experienceEvent) {
  // Handle the Edge Network response
}

data-slots=heading, code

data-repeat=6

Syntax

static func sendEvent(experienceEvent: ExperienceEvent, _ completion: (([EdgeEventHandle]) -> Void)? = nil)

Example

// Create Experience Event from dictionary:
var xdmData : [String: Any] = ["eventType" : "SampleXDMEvent",
                              "sample": "data"]
let experienceEvent = ExperienceEvent(xdm: xdmData)

Example 1

// Example 1 - send the Experience Event without handling the Edge Network response
Edge.sendEvent(experienceEvent: experienceEvent)

Example 2

// Example 2 - send the Experience Event and handle the Edge Network response onComplete
Edge.sendEvent(experienceEvent: experienceEvent) { (handles: [EdgeEventHandle]) in
  // Handle the Edge Network response
}

Example with Datastream ID override

// Create Experience event from dictionary
var xdmData : [String: Any] = ["eventType" : "SampleXDMEvent",
                              "sample": "data"]
let experienceEvent = ExperienceEvent(xdm: xdmData, datastreamIdOverride: "SampleDatastreamId")

Edge.sendEvent(experienceEvent: experienceEvent) { (handles: [EdgeEventHandle]) in
  // Handle the Edge Network response
}

Example with Datastream config override

// Create Experience event from dictionary
var xdmData : [String: Any] = ["eventType" : "SampleXDMEvent",
                              "sample": "data"]

let configOverrides: [String: Any] = [
                                        "com_adobe_experience_platform": [
                                          "datasets": [
                                            "event": [
                                              "datasetId": "SampleEventDatasetIdOverride"
                                            ]
                                          ]
                                        ],
                                        "com_adobe_analytics": [
                                          "reportSuites": [
                                            "rsid1",
                                            "rsid2",
                                            "rsid3"
                                            ]
                                        ],
                                        "com_adobe_identity": [
                                          "idSyncContainerId": "1234567"
                                        ],
                                        "com_adobe_target": [
                                          "propertyToken": "SamplePropertyToken"
                                        ]
                                      ]

let experienceEvent = ExperienceEvent(xdm: xdmData, datastreamConfigOverride: configOverrides)

Edge.sendEvent(experienceEvent: experienceEvent) { (handles: [EdgeEventHandle]) in
  // Handle the Edge Network response
}

data-slots=heading, code

data-repeat=6

Syntax

+ (void) sendExperienceEvent:(AEPExperienceEvent * _Nonnull) completion:^(NSArray<AEPEdgeEventHandle *> * _Nonnull)completion

Example

// Create Experience Event from dictionary:
NSDictionary *xdmData = @{ @"eventType" : @"SampleXDMEvent"};
NSDictionary *data = @{ @"sample" : @"data"};

Example 1

// Example 1 - send the Experience Event without handling the Edge Network response
[AEPMobileEdge sendExperienceEvent:event completion:nil];

Example 2

// Example 2 - send the Experience Event and handle the Edge Network response onComplete
[AEPMobileEdge sendExperienceEvent:event completion:^(NSArray<AEPEdgeEventHandle *> * _Nonnull handles) {
  // handle the Edge Network response
}];

Example with Datastream ID override

// Create Experience event from dictionary:
NSDictionary *xdmData = @{ @"eventType" : @"SampleXDMEvent"};
NSDictionary *data = @{ @"sample" : @"data"};
AEPExperienceEvent* event = [[AEPExperienceEvent alloc]initWithXdm:xdmData data:data datastreamIdOverride: @"SampleDatastreamIdOverride"];

[AEPMobileEdge sendExperienceEvent:event completion:^(NSArray<AEPEdgeEventHandle *> * _Nonnull handles) {
  // Handle the Edge Network response
}];

Example with Datastream config override

// Create Experience event from dictionary:
NSDictionary *xdmData = @{ @"eventType" : @"SampleXDMEvent"};
NSDictionary *data = @{ @"sample" : @"data"};
NSDictionary *configOverrides = @{ @"com_adobe_experience_platform" : @{
                                    @"datasets" : @{
                                        @"event" : @{
                                          @"datasetId": @"SampleEventDatasetIdOverride"
                                        }
                                      }
                                    },
                                    @"com_adobe_analytics" : @{
                                      @"reportSuites" : @[
                                        @"rsid1",
                                        @"rsid2",
                                        @"rsid3",
                                      ]
                                    },
                                    @"com_adobe_identity" : @{
                                      @"idSyncContainerId": @"1234567"
                                    },
                                    @"com_adobe_target" : @{
                                      @"propertyToken": @"SamplePropertyToken"
                                    }
                                  }

AEPExperienceEvent* event = [[AEPExperienceEvent alloc]initWithXdm:xdmData data:data datastreamConfigOverride: configOverrides];

[AEPMobileEdge sendExperienceEvent:event completion:^(NSArray<AEPEdgeEventHandle *> * _Nonnull handles) {
  // Handle the Edge Network response
}];

data-slots=heading, code

data-repeat=2

Syntax

public static void setLocationHint(final String hint)

Example

Edge.setLocationHint(hint);

data-slots=heading, code

data-repeat=1

Example

Edge.setLocationHint(hint)

data-slots=heading, code

data-repeat=2

Syntax

@objc(setLocationHint:)
public static func setLocationHint(_ hint: String?)

Example

Edge.setLocationHint(hint)

data-slots=heading, code

data-repeat=2

Syntax

+ (void) setLocationHint: (NSString * _Nullable hint);

Example

[AEPMobileEdge setLocationHint:hint];

data-slots=heading, code

data-repeat=4

Syntax

public final class ExperienceEvent {

  public static class Builder {
    ...

    public Builder() {
      ...
    }

    /**
    * Sets free form data associated with this event to be passed to Adobe Experience Edge.
    *
    * @param data free form data, JSON like types are accepted
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    */
    public Builder setData(final Map<String, Object> data) {...}

    /**
    * Solution specific XDM event data for this event.
    *
    * @param xdm {@link Schema} information
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    */
    public Builder setXdmSchema(final Schema xdm) {...}

    /**
    * Solution specific XDM event data and dataset identifier for this event.
    *
    * @param xdm {@code Map<String, Object>} of raw XDM schema data
    * @param datasetIdentifier The Experience Platform dataset identifier where this event is sent.
    *                          If not provided, the default dataset defined in the configuration ID is used
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    */
    public Builder setXdmSchema(final Map<String, Object> xdm, final String datasetIdentifier) {...}

    /**
    * Solution specific XDM event data for this event, passed as raw mapping of keys and
    * Object values.
    *
    * @param xdm {@code Map<String, Object>} of raw XDM schema data
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    */
    public Builder setXdmSchema(final Map<String, Object> xdm) {...}

    /**
    * Override the default datastream identifier to send this event's data to a different datastream.
    *
    * When using {@link Edge#sendEvent}, this event is sent to the Experience Platform using the
    * datastream identifier {@code datastreamIdOverride} instead of the default Experience Edge
    * configuration ID set in the SDK Configuration key {@code edge.configId}.
    *
    * @param datastreamIdOverride Datastream identifier to override the default datastream identifier set in the Edge configuration
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    *
    */
    public Builder setDatastreamIdOverride(final String datastreamIdOverride) {...}

    /**
    * Override the default datastream configuration settings for individual services for this event.
    *
    * When using {@link Edge#sendEvent}, this event is sent to the Experience Platform along with the
    * datastream overrides defined in {@code datastreamConfigOverride}.
    *
    * @param datastreamConfigOverride Map defining datastream configuration overrides for this Experience Event
    * @return instance of current builder
    * @throws UnsupportedOperationException if this instance was already built
    */
    public Builder setDatastreamConfigOverride(final Map<String, Object> datastreamConfigOverride) {...}

    /**
    * Builds and returns a new instance of {@code ExperienceEvent}.
    *
    * @return a new instance of {@code ExperienceEvent} or null if one of the required parameters is missing
    * @throws UnsupportedOperationException if this instance was already built
    */
    public ExperienceEvent build() {...}
  }

  public Map<String, Object> getData() {...}

  public Map<String, Object> getXdmSchema() {...}

  public String getDatastreamIdOverride() {...}

  public Map<String, Object> getDatastreamConfigOverride() {...}
}

Examples 1

// Example 1
// Create Experience Event with both XDM and freeform data using maps
Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "SampleXDMEvent");
xdmData.put("sample", "data");

Map<String, Object> data = new HashMap<>();
data.put("free", "form");
data.put("data", "example");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .setData(data)
  .build();

Examples 2

// Example 2
// Create Experience Event from XDM Schema implementation
public class XDMSchemaExample implements com.adobe.marketing.mobile.xdm.Schema {
  private String eventType;
  private String otherField;
      ...

      public String getEventType() {
        return this.eventType;
      }

      public void setEventType(final String newValue) {
        this.eventType = newValue;
      }

      public String getOtherField() {
        return this.otherField;
      }

      public void setOtherField(final String newValue) {
        this.otherField = newValue;
      }
      }

// Create Experience Event from Schema
XDMSchemaExample xdmData = new XDMSchemaExample();
xdmData.setEventType("SampleXDMEvent");
xdmData.setOtherField("OtherFieldValue");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData)
  .build();

Examples 3

// Example 3
// Set the destination Dataset identifier to the current Experience Event
Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "SampleXDMEvent");
xdmData.put("sample", "data");

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
  .setXdmSchema(xdmData, "datasetIdExample")
  .build();

data-slots=heading, code

data-repeat=4

Syntax

@objc(AEPExperienceEvent)
public class ExperienceEvent: NSObject {

    /// XDM formatted data, use an `XDMSchema` implementation for a better XDM data injection and format control
    @objc public let xdm: [String: Any]?

    /// Optional free-form data associated with this event
    @objc public let data: [String: Any]?

    /// Datastream identifier used to override the default datastream identifier set in the Edge configuration for this event
    @objc public private(set) var datastreamIdOverride: String?

    /// Datastream configuration used to override individual settings from the default datastream configuration for this event
    @objc public private(set) var datastreamConfigOverride: [String: Any]?

    /// Adobe Experience Platform dataset identifier, if not set the default dataset identifier set in the Edge Configuration is used
    @objc public let datasetIdentifier: String?

    /// Initialize an Experience Event with the provided event data
    /// - Parameters:
    ///   - xdm:  XDM formatted data for this event, passed as a raw XDM Schema data dictionary.
    ///   - data: Any free form data in a [String : Any] dictionary structure.
    @objc public init(xdm: [String: Any], data: [String: Any]? = nil) {...}

    /// Initialize an Experience Event with the provided event data
    /// - Parameters:
    ///   - xdm:  XDM formatted data for this event, passed as a raw XDM Schema data dictionary.
    ///   - data: Any free form data in a [String : Any] dictionary structure.
    ///   - datasetIdentifier: The Experience Platform dataset identifier where this event should be sent to; if not provided, the default dataset identifier set in the Edge configuration is used
    @objc public convenience init(xdm: [String: Any], data: [String: Any]? = nil, datasetIdentifier: String? = nil) {...}

    /// Initialize an Experience Event with the provided event data
    /// - Parameters:
    ///   - xdm:  XDM formatted data for this event, passed as a raw XDM Schema data dictionary.
    ///   - data: Any free form data in a [String : Any] dictionary structure.
    ///   - datastreamIdOverride: Datastream identifier used to override the default datastream identifier set in the Edge configuration for this event.
    ///   - datastreamConfigOverride: Datastream configuration used to override individual settings from the default datastream configuration for this event.
    @objc public convenience init(xdm: [String: Any], data: [String: Any]? = nil, datastreamIdOverride: String? = nil, datastreamConfigOverride: [String: Any]? = nil) {...}

    /// Initialize an Experience Event with the provided event data
    /// - Parameters:
    ///   - xdm: XDM formatted event data passed as an XDMSchema
    ///   - data: Any free form data in a [String : Any] dictionary structure.
    public init(xdm: XDMSchema, data: [String: Any]? = nil) {...}

    /// Initialize an Experience Event with the provided event data
    /// - Parameters:
    ///   - xdm: XDM formatted event data passed as an XDMSchema
    ///   - data: Any free form data in a [String : Any] dictionary structure.
    ///   - datastreamIdOverride: Datastream identifier used to override the default datastream identifier set in the Edge configuration for this event.
    ///   - datastreamConfigOverride: Datastream configuration used to override individual settings from the default datastream configuration for this event.
    public convenience init(xdm: XDMSchema, data: [String: Any]? = nil, datastreamIdOverride: String? = nil, datastreamConfigOverride: [String: Any]? = nil) {...}
}

Examples 1

// Example 1
// Create Experience Event with both XDM and freeform data using dictionaries
var xdmData : [String: Any] = ["eventType" : "SampleXDMEvent",
                              "sample": "data"]

let experienceEvent = ExperienceEvent(xdm: xdmData, data: ["free": "form", "data": "example"])

Examples 2

// Example 2
// Create Experience Event from XDM Schema implementation
import AEPEdge

public struct XDMSchemaExample : XDMSchema {
    public let schemaVersion = "1.0" // Returns the version of this schema as defined in the Adobe Experience Platform.
    public let schemaIdentifier = "" // The URI identifier for this schema
    public let datasetIdentifier = "" // The identifier for the Dataset this event belongs to.

    public init() {}

    public var eventType: String?
    public var otherField: String?

    enum CodingKeys: String, CodingKey {
    case eventType = "eventType"
    case otherField = "otherField"
    }
}

extension XDMSchemaExample {
    public func encode(to encoder: Encoder) throws {
      var container = encoder.container(keyedBy: CodingKeys.self)
      if let unwrapped = eventType { try container.encode(unwrapped, forKey: .eventType) }
      if let unwrapped = otherField { try container.encode(unwrapped, forKey: .otherField) }
    }
}
...

// Create Experience Event from XDMSchema
var xdmData = XDMSchemaExample()
xdmData.eventType = "SampleXDMEvent"
xdm.otherField = "OtherFieldValue"
let event = ExperienceEvent(xdm: xdmData)

Examples 3

// Example 3
// Set the destination Dataset identifier to the current Experience Event
var xdmData : [String: Any] = ["eventType" : "SampleXDMEvent",
                              "sample": "data"]

let experienceEvent = ExperienceEvent(xdm: xdmData, datasetIdentifier: "datasetIdExample")

data-slots=heading, code

data-repeat=2

Example 1

// Example 1
// Create Experience Event with both XDM and freeform data using dictionaries
NSDictionary *xdmData = @{ @"eventType" : @"SampleXDMEvent"};
NSDictionary *data = @{ @"sample" : @"data"};

AEPExperienceEvent* event = [[AEPExperienceEvent alloc]initWithXdm:xdmData data:data];

Example 2

// Example 2
// Set the destination Dataset identifier to the current Experience Event
NSDictionary *xdmData = @{ @"eventType" : @"SampleXDMEvent"};

AEPExperienceEvent *event = [[AEPExperienceEvent alloc] initWithXdm:xdmData data:nil datasetIdentifier:@"datasetIdExample"];