Merge pull request #299 from andygup/doc_update_features

v2.5.0.2 minor doc update
Esri · Apr 2, 2015 · 75a9a55 · 75a9a55
2 parents a541a9d + 73ce82f
commit 75a9a55
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # offline-editor-js - Changelog
 
+## Version 2.5.0.2 - April 2, 2015
+
+Minor doc update. Clarification in OfflineFeaturesManager on requiring `mode` be set to `FeatureLayer.MODE_SNAPSHOT`.
+
 ## Version 2.5.0.1 - April 1, 2015
 
 Minor doc update. Added references to attachments documentation. Misc. clarifications.

diff --git a/doc/howtouseeditlibrary.md b/doc/howtouseeditlibrary.md
@@ -56,7 +56,9 @@ NOTE: You can also monitor standard ArcGIS API for JavaScript layer events using
 
 ```
 
-**Step 3** Set a listener for the `layers-add-result` event. Then, add the feature layer to the map just like you normally would:
+**Step 3** Set a listener for the `layers-add-result` event. Then, add the feature layer to the map just like you normally would.
+
+**IMPORTANT:** The library currently only works offline when the `mode` is set to `FeatureLayer.MODE_SNAPSHOT`:
 
 ```js
 	

diff --git a/doc/offlinefeaturesmanager.md b/doc/offlinefeaturesmanager.md
@@ -32,6 +32,8 @@ Property | Value | Description
 
 OfflineFeaturesManager provides the following functionality.
 
+**IMPORTANT:** The library currently only works offline when the feature layer's `mode` is set to `FeatureLayer.MODE_SNAPSHOT`.
+
 Methods | Returns | Description
 --- | --- | ---
 `extend(layer,callback,dataStore)`|`callback( boolean, errors )`| **Updated @ v2.5** Overrides a feature layer, by replacing the `applyEdits()` method of the layer. You can use the FeatureLayer as always, but it's behaviour will be enhanced according to the online status of the manager and the capabilities included in this library. `Callback` is related to initialization the library. `dataStore` is an optional Object that contains any information you need when reconsistuting the layer after an offline browser restart. Refer to the [How to use the edit library doc](howtouseeditlibrary.md) for addition information.