Class ExperienceEvent.Builder

    • Constructor Detail

      • ExperienceEvent.Builder

        ExperienceEvent.Builder()
    • Method Detail

      • setDatastreamIdOverride

         ExperienceEvent.Builder setDatastreamIdOverride(String datastreamIdOverride)

        Override the default datastream identifier to send this event's data to a different datastream. When using sendEvent, this event is sent to the Experience Platform using the datastream identifier datastreamIdOverride instead of the default Experience Edge configuration ID set in the SDK Configuration key edge.configId.

        Parameters:
        datastreamIdOverride - Datastream identifier to override the default datastream identifier set in the Edge configuration
        Returns:

        instance of current builder

      • setDatastreamConfigOverride

         ExperienceEvent.Builder setDatastreamConfigOverride(Map<String, Object> datastreamConfigOverride)

        Override the default datastream configuration settings for individual services for this event. When using sendEvent, this event is sent to the Experience Platform along with the datastream overrides defined in datastreamConfigOverride.

        Parameters:
        datastreamConfigOverride - Map defining datastream configuration overrides for this Experience Event
        Returns:

        instance of current builder

      • setData

         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

      • setXdmSchema

         ExperienceEvent.Builder setXdmSchema(Schema xdm)

        Solution specific XDM event data for this event. If XDM schema is set multiple times using either this API or setXdmSchema, the value will be overwritten and only the last changes are applied. Setting xdm to null clears the value. This event is sent to the Experience Platform dataset defined by getDatasetIdentifier.

        Parameters:
        xdm - Schema information
        Returns:

        instance of current builder

      • setXdmSchema

         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 or setXdmSchema, the value will be overwritten and only the last changes are applied. Setting xdm to null clears the value. When using sendEvent this event is sent to the Experience Platform datasetIdentifier if provided, or to the default Experience Platform dataset defined when generating the Experience Edge configuration ID if datasetIdentifier is null.

        Parameters:
        xdm - Map<String, Object> of raw XDM schema data
        datasetIdentifier - The Experience Platform dataset identifier where this event is sent.
        Returns:

        instance of current builder

      • setXdmSchema

         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 or setXdmSchema, the value will be overwritten and only the last changes are applied. Setting xdm to null clears the value. When using sendEvent 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

      • build

         ExperienceEvent build()

        Builds and returns a new instance of ExperienceEvent.

        Returns:

        a new instance of ExperienceEvent or null if one of the required parameters is missing