Updated logic and documentation related to the structure of the type …

…returned from getPlacement() function
qubitdigital · Nov 10, 2020 · 10b9cb6 · 10b9cb6
1 parent dc107c9
commit 10b9cb6
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 12 deletions.
diff --git a/BridgeAPI.md b/BridgeAPI.md
@@ -327,16 +327,14 @@ Returns Placement for given parameters.
     - Description: Experience identifier
 
 ### Result
-Promise with a map describing Placement object. Example:
+Promise with a map describing Placement object:
 
      {
-        "image": "https://image.store.com/images/example.jpeg",
-        "message": "Hello World",
-        "url": "https://www.qubit.com"
+        "content": { ... }
         "impressionUrl": "https://api.qubit.com/placements/callback?data=ggW4eyJtZXRhIjp7ImlkIjo",
         "clickthroughUrl": "https://api.qubit.com/placements/callback?data=mQW4eyJtZXRhIjp7Imlkx"
      }
-
+The structure of response content depends on the type of placement that is being called.
 
 ### Exceptions
 - Exception is thrown, when SDK is not initialized.

diff --git a/README.md b/README.md
@@ -247,9 +247,7 @@ async () => {
 }
 
 {
-  "image": "https://image.store.com/images/example.jpeg",
-  "message": "Hello World",
-  "url": "https://www.qubit.com"
+  "content": { ... }
   "impressionUrl": "https://api.qubit.com/placements/callback?data=ggW4eyJtZXRhIjp7ImlkIjo",
   "clickthroughUrl": "https://api.qubit.com/placements/callback?data=mQW4eyJtZXRhIjp7Imlkx"
 }

diff --git a/android/src/main/java/com/qubit/reactnative/sdk/QubitSDKModule.java b/android/src/main/java/com/qubit/reactnative/sdk/QubitSDKModule.java
@@ -164,7 +164,8 @@ public void getPlacement(
         getAttributesJson(attributes),
         new PlacementPreviewOptions(campaignId, experienceId),
         placement -> {
-          JsonObject placementJson = placement.getContent();
+          JsonObject placementJson = new JsonObject();
+          placementJson.add("content", placement.getContent());
           placementJson.addProperty("impressionUrl", placement.getImpressionUrl());
           placementJson.addProperty("clickthroughUrl", placement.getClickthroughUrl());
           placementPromise.resolve(WritableMapConverter.convertJsonToMap(placementJson));

diff --git a/src/index.ts b/src/index.ts
@@ -220,9 +220,7 @@ class QubitSDK {
      * }
      *
      * {
-     *   "image": "https://image.store.com/images/example.jpeg",
-     *   "message": "Hello World",
-     *   "url": "https://www.qubit.com"
+     *   "content": { ... }
      *   "impressionUrl": "https://api.qubit.com/placements/callback?data=ggW4eyJtZXRhIjp7ImlkIjo",
      *   "clickthroughUrl": "https://api.qubit.com/placements/callback?data=mQW4eyJtZXRhIjp7Imlkx"
      * }