@esri/telemetry-amazon 0.3.2 → 0.4.0

package/README.md

@@ -16,8 +16,8 @@ npm install @esri/telemetry-amazon
 Below is an example of how to use the telemetry-amazon plugin.
 
 ```js
-import Telemetry from '@esri/telemetry'
-import Amazon from '@esri/telemetry-amazon'
+import Telemetry from '@esri/telemetry';
+import Amazon from '@esri/telemetry-amazon';
 
 const amazonTracker = new Amazon({
   userPoolID: USER_POOL_ID,
@@ -27,7 +27,7 @@ const amazonTracker = new Amazon({
     id: APP_ID,
     version: APP_VERSION,
   },
-})
+});
 
 const telemetryOptions = {
   plugins: [amazonTracker],
@@ -35,12 +35,12 @@ const telemetryOptions = {
     subscriptionInfo: {},
     user: {},
   },
-}
+};
 
-const telemetry = new Telemetry(telemetryOptions)
+const telemetry = new Telemetry(telemetryOptions);
 
-telemetry.logPageView()
-telemetry.logEvent()
+telemetry.logPageView();
+telemetry.logEvent();
 ```
 
 After initializing `Telemetry.js`with the `telemetry-amazon`plugin, telemetry data will be sent to the AWS Pinpoint instance of the provided App.
@@ -68,12 +68,12 @@ Additionally, you can disable individual trackers when initializing the `Telemet
 Post initialization, it is possible to disable & enable specific trackers using `disableTracker` and `enableTracker` methods.
 
 ```js
-telemetry.disableTracker('amazon')
-telemetry.logPageView() // no amazon page view logged
-telemetry.logEvent() // no amazon event logged
-telemetry.enableTracker('amazon')
-telemetry.logPageView() // amazon page view logged
-telemetry.logEvent() // amazon event logged
+telemetry.disableTracker('amazon');
+telemetry.logPageView(); // no amazon page view logged
+telemetry.logEvent(); // no amazon event logged
+telemetry.enableTracker('amazon');
+telemetry.logPageView(); // amazon page view logged
+telemetry.logEvent(); // amazon event logged
 ```
 
 ## Example
@@ -94,7 +94,42 @@ const event = {
   datasetID: '1ef',
   attribute: 'crime_type',
   user: 'amazing_map_woman',
+};
+
+telemetry.logEvent(event);
+```
+
+## Telemetry Sharing Permissions
+
+### Portal Items
+
+`telemetry-amazon` contains static methods for setting and getting telemetry access for portal items.
+
+### Usage
+
+```js
+import Amazon from '@esri/telemetry-amazon'
+
+...
+
+const getAccessParams = {
+  id: '1ef',
+  authentication: PortalUserSession,
+}
+
+const access = await Amazon.getAccessPermissions(getAccessParams: IGetAccessPermissionsParams)
+
+const setAccessParams = {
+  id: '1ef',
+  authentication: PortalUserSession,
+  username: 'dev_pre_a_hub_admin',
+  accessChangeset: [
+    {
+      action: 'add',
+      targetProperty: 'public',
+    }
+  ]
 }
 
-telemetry.logEvent(event)
+const result = await Amazon.setAccessPermissions(setAccessParams: ISetAccessPermissionsParams)
 ```