fix(Gen2)[Swift]: Addressing some Analytics issues (#7553)

aws-amplify · May 10, 2024 · fc6b89b · fc6b89b
1 parent bc893ba
commit fc6b89b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 44 deletions.
diff --git a/...s/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx b/...s/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx
@@ -405,23 +405,13 @@ However, it can take upwards of 30 minutes for the event to display in the Filte
 
 By default, events are automatically flushed out to the network every 60 seconds.
 
-If you would like to change this, update `amplify_outputs.json` and set the value you would prefer under `autoFlushEventsInterval`, expressed in seconds:
+You can change this through the `options` parameter when initializing the plugin, by creating a `AWSPinpointAnalyticsPlugin.Options` instance and setting its `autoFlushEventsInterval` property to the desired value, expressed in seconds:
 
-```json
-{
-  "Version": "1.0",
-  "analytics": {
-    "plugins": {
-      "awsPinpointAnalyticsPlugin": {
-        "pinpointAnalytics": {
-          "appId": "<your-app-id>",
-          "region": "<your-app-region>"
-        },
-        "autoFlushEventsInterval": 60
-      }
-    }
-  }
-}
+```swift
+let options = AWSPinpointAnalyticsPlugin.Options(
+    autoFlushEventsInterval: 60
+)
+try Amplify.add(plugin: AWSPinpointAnalyticsPlugin(options: options))
 ```
 
 > **Note**
@@ -448,34 +438,13 @@ To learn how frequently users authenticate with your app, update your applicatio
  - `_userauth.sign_up`
  - `_userauth.auth_fail`
 
-You can report authentication events by doing either of the following:
-
- - Managing user sign-up and sign-in with Amazon Cognito user pools.
-
-  Cognito user pools are user directories that make it easier to add sign-up and sign-in to your app. As users authenticate with your app, Cognito reports authentication events to Pinpoint. For more information, see [Using Amazon Pinpoint Analytics with Amazon Cognito User Pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) in the _Amazon Cognito Developer Guide_. Also update **amplify_outputs.json** by adding the `PinpointAppId` key under `CognitoUserPool`.
-
-  ```json
-  "CognitoUserPool": {
-      "Default": {
-          "PoolId": "<your-user-pool-id>",
-          "AppClientId": "<your-app-client-id>",
-          "Region": "<your-app-region>",
-          "PinpointAppId": "<your-pinpoint-app-id>"
-     }
-  }
-  ```
-
-- Manually recording events using the `recordEvent()` API.
-
-  If you don't want to use Cognito user pools, you can use the Pinpoint client to record and submit authentication events, as shown in the following examples. In these examples, the event type is set to `_userauth.sign_in`, but you can substitute any authentication event type.
+You can report these events by doing the following:
 
 ```swift
-func sendUserSignInEvent() {
-    let event = BasicAnalyticsEvent(
-        name: "_userauth.sign_in"
-    )
-    Amplify.Analytics.record(event: event)
-}
+let event = BasicAnalyticsEvent(
+    name: "_userauth.sign_in" // Or any of the accepted values
+)
+Amplify.Analytics.record(event: event)
 ```
 
 ## Global Properties

diff --git a/...platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx b/...platform]/build-a-backend/add-aws-services/analytics/set-up-analytics/index.mdx
@@ -144,7 +144,7 @@ npm add aws-amplify
   **Note:** **Up to Next Major Version** should be selected from the **Dependency Rule** dropdown.
 
   </Callout>
-3. Lastly, choose **AWSPinpointAnalyticsPlugin**, **AWSCognitoAuthPlugin**, and **Amplify**. Then click **Add Package**.
+3. Lastly, add **AWSPinpointAnalyticsPlugin**, **AWSCognitoAuthPlugin**, and **Amplify** to your target. Then click **Add Package**.
 
 </InlineFilter>
 
@@ -222,7 +222,17 @@ Amplify.configure({
 </InlineFilter>
 
 <InlineFilter filters= {["swift"]}>
-To use the Amplify Analytics and Authentication categories in your app, you need to create and configure their corresponding plugins by calling the `Amplify.add(plugin:)` and `Amplify.configure()` methods.
+<Callout warning>
+Make sure to generate the `amplify_outputs.json` file by running the following command: 
+
+```bash title="Terminal" showLineNumbers={false}
+npx ampx sandbox
+```
+
+Next, move the file to your project. You can do this by dragging and dropping the file into your Xcode project.
+</Callout>
+
+To use the Amplify Analytics and Authentication categories in your app, you need to create and configure their corresponding plugins by calling the `Amplify.add(plugin:)` and `Amplify.configure(with:)` methods.
 
 <BlockSwitcher>