Package com.adobe.marketing.mobile
Class ExperienceEvent.Builder
- java.lang.Object
-
- com.adobe.marketing.mobile.ExperienceEvent.Builder
-
- Enclosing class:
- ExperienceEvent
public static class ExperienceEvent.Builder extends Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperienceEventbuild()Builds and returns a new instance ofExperienceEvent.ExperienceEvent.BuildersetData(Map<String,Object> data)Sets free form data associated with this event to be passed to Adobe Experience Edge.ExperienceEvent.BuildersetXdmSchema(Schema xdm)Solution specific XDM event data for this event.ExperienceEvent.BuildersetXdmSchema(Map<String,Object> xdm)Solution specific XDM event data for this event, passed as raw mapping of keys and Object values.ExperienceEvent.BuildersetXdmSchema(Map<String,Object> xdm, String datasetIdentifier)Solution specific XDM event data for this event, passed as raw mapping of keys and Object values.
-
-
-
Method Detail
-
setData
public ExperienceEvent.Builder setData(Map<String,Object> data)
Sets free form data associated with this event to be passed to Adobe Experience Edge.- Parameters:
data- free form data, JSON like types are accepted- Returns:
- instance of current builder
- Throws:
UnsupportedOperationException- if this instance was already built
-
setXdmSchema
public ExperienceEvent.Builder setXdmSchema(Schema xdm)
Solution specific XDM event data for this event. If XDM schema is set multiple times using either this API orsetXdmSchema(Map), the value will be overwritten and only the last changes are applied. Settingxdmto null clears the value. This event is sent to the Experience Platform dataset defined bySchema.getDatasetIdentifier().- Parameters:
xdm-Schemainformation- Returns:
- instance of current builder
- Throws:
UnsupportedOperationException- if this instance was already built
-
setXdmSchema
public ExperienceEvent.Builder setXdmSchema(Map<String,Object> xdm, String datasetIdentifier)
Solution specific XDM event data for this event, passed as raw mapping of keys and Object values. If XDM schema is set multiple times using either this API orsetXdmSchema(Schema), the value will be overwritten and only the last changes are applied. Settingxdmto null clears the value. When usingEdge.sendEvent(com.adobe.marketing.mobile.ExperienceEvent, com.adobe.marketing.mobile.EdgeCallback)this event is sent to the Experience PlatformdatasetIdentifierif provided, or to the default Experience Platform dataset defined when generating the Experience Edge configuration ID ifdatasetIdentifieris null.- Parameters:
xdm-Map<String, Object>of raw XDM schema datadatasetIdentifier- The Experience Platform dataset identifier where this event is sent. If not provided, the default dataset defined in the configuration ID is used- Returns:
- instance of current builder
- Throws:
UnsupportedOperationException- if this instance was already built
-
setXdmSchema
public ExperienceEvent.Builder setXdmSchema(Map<String,Object> xdm)
Solution specific XDM event data for this event, passed as raw mapping of keys and Object values. If XDM schema is set multiple times using either this API orsetXdmSchema(Schema), the value will be overwritten and only the last changes are applied. Settingxdmto null clears the value. When usingEdge.sendEvent(com.adobe.marketing.mobile.ExperienceEvent, com.adobe.marketing.mobile.EdgeCallback)this event is sent to the default Experience Platform dataset defined when generating the Experience Edge configuration ID.- Parameters:
xdm-Map<String, Object>of raw XDM schema data- Returns:
- instance of current builder
- Throws:
UnsupportedOperationException- if this instance was already built
-
build
public ExperienceEvent build()
Builds and returns a new instance ofExperienceEvent.- Returns:
- a new instance of
ExperienceEventor null if one of the required parameters is missing - Throws:
UnsupportedOperationException- if this instance was already built
-
-