From f48ca74914d54584ce0516826771b681e9920217 Mon Sep 17 00:00:00 2001 From: Pravin Prakash Kumar Date: Mon, 9 Oct 2023 17:11:07 -0700 Subject: [PATCH] Lint fixed part 1 --- .../public-classes-and-enum/message.md | 3 --- .../messaging-edge-event-type.md | 2 +- .../public-classes-and-enum/push-tracking-status.md | 2 +- .../android/automatic-display-and-tracking.md | 5 +++-- .../android/manual-display-and-tracking.md | 13 ++++++++----- .../push-notification/index.md | 2 +- .../push-notification/push-payload.md | 2 +- .../push-notification/tabs/push-payload.md | 2 +- .../adobe-journey-optimizer/tabs/api-reference.md | 3 ++- 9 files changed, 18 insertions(+), 16 deletions(-) diff --git a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/message.md b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/message.md index c0b01151ef..c354ef154d 100644 --- a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/message.md +++ b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/message.md @@ -27,7 +27,6 @@ Identifier of the `Message`. This value matches the Message Execution ID assigne public var id: String ``` - ### autoTrack If set to `true` (default), Experience Edge events will automatically be generated when this `Message` is triggered, displayed, and dismissed. @@ -70,7 +69,6 @@ iOS - ### track(_:withEdgeEventType:) Generates and dispatches an Edge Event for the provided `interaction` and `eventType`. @@ -190,4 +188,3 @@ Returns a reference to the message's `WebView` instance, if it exists. ```java WebView getWebView() ``` - diff --git a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/messaging-edge-event-type.md b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/messaging-edge-event-type.md index 8f4542d056..c9028bc8ac 100644 --- a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/messaging-edge-event-type.md +++ b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/messaging-edge-event-type.md @@ -34,4 +34,4 @@ Android iOS - \ No newline at end of file + diff --git a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/push-tracking-status.md b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/push-tracking-status.md index b6ffbc6688..7d1e90e20f 100644 --- a/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/push-tracking-status.md +++ b/src/pages/documentation/adobe-journey-optimizer/public-classes-and-enum/push-tracking-status.md @@ -38,4 +38,4 @@ Android iOS - \ No newline at end of file + diff --git a/src/pages/documentation/adobe-journey-optimizer/push-notification/android/automatic-display-and-tracking.md b/src/pages/documentation/adobe-journey-optimizer/push-notification/android/automatic-display-and-tracking.md index 852fc02be0..69125f23af 100644 --- a/src/pages/documentation/adobe-journey-optimizer/push-notification/android/automatic-display-and-tracking.md +++ b/src/pages/documentation/adobe-journey-optimizer/push-notification/android/automatic-display-and-tracking.md @@ -24,7 +24,6 @@ This document describes how to automatically display and track push notification To retrieve the push token from Firebase Messaging Service, please follow the tutorial within the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/android/client#retrieve-the-current-registration-token). Then use `setPushIdentifier` API to sync the device's push token with profile in Adobe Experience Platform. - Although this API is provided in Mobile Core, the use of this API is required and leveraged by the Adobe Journey Optimizer extension to sync provided push tokens with Adobe Experience Platform services. @@ -92,6 +91,7 @@ Notification channel was introduced in Android Oreo (API level 26). It allows yo You must create at least one notification channel to display push notifications on devices running Android Oreo or higher. Follow the [android documentation](https://developer.android.com/develop/ui/views/notifications/channels) to create and manage notification channels. Once a notification channel is created, you can use the channel id while [designing the push notification](https://experienceleague.adobe.com/docs/journey-optimizer/using/push/design-push.html) in Adobe Journey Optimizer. + **Default Channel**: If you do not create a notification channel, or if the notification channel specified while designing the push notification does not match with any of the created channels, the Messaging extension will present the push notification through its predefined fallback notification channel, which is named "General Notifications." ## Configuring Small Icon @@ -101,7 +101,8 @@ Use MobileCore's API to set the small icon resource id. This icon will be used a ```java MobileCore.setSmallIconResourceId(R.drawable.ic_notification); ``` + When no custom small icon is specified, the Messaging extension will automatically utilize the application's launcher icon as the default small icon. ## Notification Actions -Messaging extension will automatically handle any click behaviour that is configured while [designing the push notification in Adobe Journey Optimizer](https://experienceleague.adobe.com/docs/journey-optimizer/using/push/design-push.html) or Assurance. \ No newline at end of file +Messaging extension will automatically handle any click behaviour that is configured while [designing the push notification in Adobe Journey Optimizer](https://experienceleague.adobe.com/docs/journey-optimizer/using/push/design-push.html) or Assurance. diff --git a/src/pages/documentation/adobe-journey-optimizer/push-notification/android/manual-display-and-tracking.md b/src/pages/documentation/adobe-journey-optimizer/push-notification/android/manual-display-and-tracking.md index 0514b39000..aed8baefb2 100644 --- a/src/pages/documentation/adobe-journey-optimizer/push-notification/android/manual-display-and-tracking.md +++ b/src/pages/documentation/adobe-journey-optimizer/push-notification/android/manual-display-and-tracking.md @@ -21,7 +21,6 @@ This document describes how to manually build, display and track push notificati To retrieve the push token from Firebase Messaging Service, please follow the tutorial within the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/android/client#retrieve-the-current-registration-token). Then use `setPushIdentifier` API to sync the device's push token with profile in Adobe Experience Platform. - Although this API is provided in Mobile Core, the use of this API is required and leveraged by the Adobe Journey Optimizer extension to sync provided push tokens with Adobe Experience Platform services. @@ -79,6 +78,7 @@ public class YourApp extends Application { 4. Use NotificationManager to create and display the built notification. Here is a sample code for creating a notification channel and building the notification. + ```java public class YourAppFirebaseMessagingService extends FirebaseMessagingService { @@ -124,21 +124,24 @@ After the application is opened by the user by clicking on the push notification final String actionId) // actionId of the element which performed the custom action. ``` -##### Sending push notification interaction feedback when application is opened without any custom action. +##### Sending push notification interaction feedback when application is opened without any custom action + Add the following code where you have access to `intent` after the user has interacted with the push notification: ```java Messaging.handleNotificationResponse(intent, true, null); ``` -##### Sending feedback when application is opened with a custom action. +##### Sending feedback when application is opened with a custom action + Similar to the example above, call the `handleNotificationResponse` API but this time with a custom action: ```java Messaging.handleNotificationResponse(intent, true, ); ``` -##### Sending feedback when application is not opened but a custom action is performed by the user. +##### Sending feedback when application is not opened but a custom action is performed by the user + Add the following code where you have access to `intent` after the user has interacted with the push notification: ```java @@ -165,4 +168,4 @@ public class MainActivity extends AppCompatActivity { } } } -``` \ No newline at end of file +``` diff --git a/src/pages/documentation/adobe-journey-optimizer/push-notification/index.md b/src/pages/documentation/adobe-journey-optimizer/push-notification/index.md index 9b658c48b3..159ca74514 100644 --- a/src/pages/documentation/adobe-journey-optimizer/push-notification/index.md +++ b/src/pages/documentation/adobe-journey-optimizer/push-notification/index.md @@ -22,4 +22,4 @@ keywords: * [Enum - PushTrackingStatus](../public-classes-and-enum/push-tracking-status.md) ## More Information -* [Push Notification Payload Keys](./push-payload.md) \ No newline at end of file +* [Push Notification Payload Keys](./push-payload.md) diff --git a/src/pages/documentation/adobe-journey-optimizer/push-notification/push-payload.md b/src/pages/documentation/adobe-journey-optimizer/push-notification/push-payload.md index 2063275ae5..6551afa5a0 100644 --- a/src/pages/documentation/adobe-journey-optimizer/push-notification/push-payload.md +++ b/src/pages/documentation/adobe-journey-optimizer/push-notification/push-payload.md @@ -21,4 +21,4 @@ Android iOS - \ No newline at end of file + diff --git a/src/pages/documentation/adobe-journey-optimizer/push-notification/tabs/push-payload.md b/src/pages/documentation/adobe-journey-optimizer/push-notification/tabs/push-payload.md index 3609b44ba4..82762e376f 100644 --- a/src/pages/documentation/adobe-journey-optimizer/push-notification/tabs/push-payload.md +++ b/src/pages/documentation/adobe-journey-optimizer/push-notification/tabs/push-payload.md @@ -91,4 +91,4 @@ noIndex: true | `adb_act` | Array | An array that contains the action object(s). | | `adb_act.aid` | String | The ID for the action object. | | `adb_act.label` | String | The name for the action object | -| `adb_act.type` | String | The type for the action object. It can be one of the following string values: `DEEPLINK`, `WEBURL`, `DISMISS` | \ No newline at end of file +| `adb_act.type` | String | The type for the action object. It can be one of the following string values: `DEEPLINK`, `WEBURL`, `DISMISS` | diff --git a/src/pages/documentation/adobe-journey-optimizer/tabs/api-reference.md b/src/pages/documentation/adobe-journey-optimizer/tabs/api-reference.md index e7731175bb..53b5f16776 100644 --- a/src/pages/documentation/adobe-journey-optimizer/tabs/api-reference.md +++ b/src/pages/documentation/adobe-journey-optimizer/tabs/api-reference.md @@ -62,4 +62,5 @@ public static void registerExtension(); ```java Messaging.registerExtension(); -``` \ No newline at end of file +``` + \ No newline at end of file