Class Edge

  • All Implemented Interfaces:

    
    public class Edge
    
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final static Class<out Extension> EXTENSION
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      static String extensionVersion() Returns the version of the Edge extension
      static void sendEvent(@NonNull() ExperienceEvent experienceEvent, @Nullable() EdgeCallback callback) Sends an event to Adobe Experience Edge and registers a callback for responses coming from the Edge Network.
      static void getLocationHint(@NonNull() AdobeCallback<String> callback) Gets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network.
      static void setLocationHint(@Nullable() String hint) Sets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • sendEvent

         static void sendEvent(@NonNull() ExperienceEvent experienceEvent, @Nullable() EdgeCallback callback)

        Sends an event to Adobe Experience Edge and registers a callback for responses coming from the Edge Network.

        Parameters:
        experienceEvent - event to be sent to Adobe Experience Edge; should not be null
        callback - optional callback to be invoked when the request is complete, returning the associated response handlesreceived from the Adobe Experience Edge.
      • getLocationHint

         static void getLocationHint(@NonNull() AdobeCallback<String> callback)

        Gets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. The Edge Network location hint may be used when building the URL for Adobe Experience Platform Edge Network requests to hint at the server cluster to use. Returns the Edge Network location hint, or null if the location hint expired or is not set.

        Parameters:
        callback - AdobeCallback of String invoked with a value containing the Edge Network location hint.The returned location hint may be null if the hint expired or none is set.
      • setLocationHint

         static void setLocationHint(@Nullable() String hint)

        Sets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. Sets the Edge Network location hint used in requests to the AEP Edge Network causing requests to "stick" to a specific server cluster. Passing null or an empty string clears the existing location hint. Edge Network responses may overwrite the location hint to a new value when necessary to manage network traffic.

        Use caution when setting the location hint. Only use location hints for the "EdgeNetwork" scope. An incorrect location hint value will cause all Edge Network requests to fail.

        Parameters:
        hint - the Edge Network location hint to use when connecting to the Adobe Experience Platform Edge Network