Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update index.md #671

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update index.md #671

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b2cbf0d
Update index.md
Alicesnk Aug 28, 2024
4186ea1
Update index.md
Alicesnk Aug 28, 2024
858fe10
Update index.md
Alicesnk Aug 28, 2024
d0f9b8f
Update index.md
Alicesnk Aug 29, 2024
c635577
Merge branch 'main' into patch-2
rymorale Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/pages/resources/reference/push-notifications/templates/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ This document outlines the push templates that are supported by default.

<InlineAlert variant="info" slots="text"/>

Default push template functionality is available for use with the **Adobe Campaign Classic** extension.
Default push template functionality is available for use with the **Adobe Campaign Classic** extension. In additon, the rich push template functionality is supported starting Campaign v8.
Copy link
Contributor

@rymorale rymorale Aug 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "... is supported starting with Campaign v8." is easier to read. In addition, should we say Campaign Classic v8 instead of Campaign v8? IMO, our docs here cover the Campaign Standard extension as well and this may lead to some confusion. This applies to the naming changes below as well.

Copy link
Contributor

@calebk1 calebk1 Aug 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with saying "... starting with Campaign v8."

Also, there's an extra space after the period.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you @rymorale and @calebk1 for your feedback. I updated as you suggested. Campaign Classic is only for v7. Starting v8, we should only refer to Adobe Campaign.


This is supported by **Android SDK version 3.1.0+** and **iOS SDK version 5.0.0+**.

| Template Name | Compatibility | Description | Sample |
| :------------ | :------------ | :---------- | :----- |
| [Basic](./basic) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /><br />**iOS**<br /> **> Product**<br />*Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | A basic push notification template. <br />Allows setting a title, message body, and optional image, action buttons, and click-through URL. <br /><br />For **Android only**, it also supports a "remind me later" functionality which will schedule the notification to be re-delivered at a later time. | ![gif of sample android basic notification](./../templates/assets/android_basic.gif)<br />![gif of sample basic notification](./../templates/assets/basic.gif) |
| [Carousel](./carousel) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /><br />**iOS**<br /> **> Product**<br />*Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | Shows a series of three to five (3-5) images that scroll on and off the side of the notification. <br /><br />Available in `manual` mode (user must click a button to scroll carousel items) and `auto` mode (carousel items scroll every five seconds). | ![gif of sample android manual carousel notification](./../templates/assets/android_manual_carousel.gif)<br />![gif of sample carousel notification](./../templates/assets/carousel.gif) |
| [Timer](./timer) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br />**iOS**<br /> **> Product**<br />*Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | Notification containing title, body, and image. Configure a countdown timer which upon expiry can cause a new title, body, and image to be shown. | ![gif of sample android timer notification](./../templates/assets/android_timer.gif)<br />![gif of sample timer notification](./../templates/assets/timer.gif) |
| [Input Box](./input-box) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and image. The notification contains a user input field which can receive a user text input that is sent back to the app via `Intent`. After the input is received, the notification can be updated with a feedback image and/or feedback message. | ![gif of sample input box notification](./../templates/assets/input_box.gif) |
| [Zero Bezel](./zero-bezel) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and an edge-to-edge background image which fills the notification area. | ![gif of sample zero bezel notification](./../templates/assets/zero_bezel.gif) |
| [Product Catalog](./catalog) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing a main product image which can be changed by pressing one of the three product thumbnails present on the notification. The notification also contains a call-to-action (CTA) button to redirect the app user to a specified uri. <br />Product catalog notifications have recommended image aspect ratios depending on the layout style used. See this [table](./../index#Image specifications) for detailed information. | ![gif of sample product catalog notification](./../templates/assets/vertical_catalog.gif) |
| [Rating](./rating) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and image. The notification contains three to five (3-5) customizable rating icons to be used for rating confirmation, each containing a click-through URI and type. The call-to-action for each rating can be unique for each rating icon. | ![gif of sample rating notification](./../templates/assets/rating.gif) |
| [Multi icon](./multi-icon) | **Android**<br />**> Product**<br /> *Adobe Campaign Classic*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing three to five (3-5) customizable icons. Each icon can be pressed to be redirected to a specified URI. The notification is persistent and will remain in the notification tray when it is interacted with. | ![gif of sample multi-icon notification](./../templates/assets/multi_icon.gif) |
| [Basic](./basic) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /><br />**iOS**<br /> **> Product**<br />*Adobe Campaign v8*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | A basic push notification template. <br />Allows setting a title, message body, and optional image, action buttons, and click-through URL. <br /><br />For **Android only**, it also supports a "remind me later" functionality which will schedule the notification to be re-delivered at a later time. | ![gif of sample android basic notification](./../templates/assets/android_basic.gif)<br />![gif of sample basic notification](./../templates/assets/basic.gif) |
| [Carousel](./carousel) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /><br />**iOS**<br /> **> Product**<br />*Adobe Campaign v8*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | Shows a series of three to five (3-5) images that scroll on and off the side of the notification. <br /><br />Available in `manual` mode (user must click a button to scroll carousel items) and `auto` mode (carousel items scroll every five seconds). | ![gif of sample android manual carousel notification](./../templates/assets/android_manual_carousel.gif)<br />![gif of sample carousel notification](./../templates/assets/carousel.gif) |
| [Timer](./timer) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br />**iOS**<br /> **> Product**<br />*Adobe Campaign v8*<br /> **> SDK Extension**<br /> *AEPNotificationContent 5.0.0+* | Notification containing title, body, and image. Configure a countdown timer which upon expiry can cause a new title, body, and image to be shown. | ![gif of sample android timer notification](./../templates/assets/android_timer.gif)<br />![gif of sample timer notification](./../templates/assets/timer.gif) |
| [Input Box](./input-box) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and image. The notification contains a user input field which can receive a user text input that is sent back to the app via `Intent`. After the input is received, the notification can be updated with a feedback image and/or feedback message. | ![gif of sample input box notification](./../templates/assets/input_box.gif) |
| [Zero Bezel](./zero-bezel) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and an edge-to-edge background image which fills the notification area. | ![gif of sample zero bezel notification](./../templates/assets/zero_bezel.gif) |
| [Product Catalog](./catalog) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing a main product image which can be changed by pressing one of the three product thumbnails present on the notification. The notification also contains a call-to-action (CTA) button to redirect the app user to a specified uri. <br />Product catalog notifications have recommended image aspect ratios depending on the layout style used. See this [table](./../index#Image specifications) for detailed information. | ![gif of sample product catalog notification](./../templates/assets/vertical_catalog.gif) |
| [Rating](./rating) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing title, body, and image. The notification contains three to five (3-5) customizable rating icons to be used for rating confirmation, each containing a click-through URI and type. The call-to-action for each rating can be unique for each rating icon. | ![gif of sample rating notification](./../templates/assets/rating.gif) |
| [Multi icon](./multi-icon) | **Android**<br />**> Product**<br /> *Adobe Campaign v8*<br /> **> SDK Extension**<br /> *CampaignClassic 3.1.0+* <br /> | Notification containing three to five (3-5) customizable icons. Each icon can be pressed to be redirected to a specified URI. The notification is persistent and will remain in the notification tray when it is interacted with. | ![gif of sample multi-icon notification](./../templates/assets/multi_icon.gif) |
Loading