Class Edge
-
- All Implemented Interfaces:
public class Edge
-
-
Method Summary
Modifier and Type Method Description static StringextensionVersion()Returns the version of the Edgeextensionstatic voidsendEvent(@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 voidgetLocationHint(@NonNull() AdobeCallback<String> callback)Gets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. static voidsetLocationHint(@Nullable() String hint)Sets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. -
-
Method Detail
-
extensionVersion
@NonNull() static String extensionVersion()
Returns the version of the
Edgeextension- Returns:
The version as
String
-
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 nullcallback- 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 ofStringinvoked 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
-
-
-
-