Merge pull request #116 from PSPDFKit/rad/update-getAnnotations-api-doc

Update API documentation for getAnnotations

Author: radazzouz

android/src/main/java/com/pspdfkit/react/events/PdfViewDataReturnedEvent.java

@@ -24,17 +24,20 @@ public class PdfViewDataReturnedEvent extends Event<PdfViewDataReturnedEvent> {
 
     private final WritableMap payload;
 
-    public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull List<Annotation> annotations) {
+    public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull List<Annotation> annotationsToSerialize) {
         super(viewId);
         Map<String, Object> map = new HashMap<>();
         map.put("requestId", requestId);
         try {
             List<Map<String, Object>> annotationsSerialized = new ArrayList<>();
-            for (Annotation annotation : annotations) {
+            for (Annotation annotation : annotationsToSerialize) {
                 JSONObject instantJson = new JSONObject(annotation.toInstantJson());
                 annotationsSerialized.add(JsonUtilities.jsonObjectToMap(instantJson));
             }
-            map.put("result", annotationsSerialized);
+
+            Map<String, Object> annotations = new HashMap<>();
+            annotations.put("annotations", annotationsSerialized);
+            map.put("result", annotations);
         } catch (JSONException e) {
             map.put("error", e.getMessage());
         }

index.js

@@ -139,7 +139,7 @@ class PSPDFKitView extends React.Component {
      * @param type The type of annotations to get (See here for types https://pspdfkit.com/guides/server/current/api/json-format/) or null to get all annotations.
      * 
      * Returns a promise resolving an array with the following structure:
-     * [instantJson]
+     * {'annotations' : [instantJson]}
      */
     getAnnotations = function (pageIndex, type) {
         if (Platform.OS === "android") {