Add phase 2 push template documentation, add push template image recommendations #621
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rymorale
requested review from
sbenedicadb,
PravinPK,
spoorthipujariadobe and
calebk1
calebk1
requested changes
Jun 7, 2024
gatsby-config.js
Outdated
Comment on lines
967
to
987
| path: "/resources/reference/push-notifications/templates/input_box" | ||
| }, | ||
| { | ||
| title: "Multi Icon", | ||
| path: "/resources/reference/push-notifications/templates/multi_icon" | ||
| }, | ||
| { | ||
| title: "Product Catalog", | ||
| path: "/resources/reference/push-notifications/templates/catalog" | ||
| }, | ||
| { | ||
| title: "Rating", | ||
| path: "/resources/reference/push-notifications/templates/rating" | ||
| }, | ||
| { | ||
| title: "Timer", | ||
| path: "/resources/reference/push-notifications/templates/timer" | ||
| }, | ||
| { | ||
| title: "Zero Bezel", | ||
| path: "/resources/reference/push-notifications/templates/zero_bezel" |
There was a problem hiding this comment.
Minor nit - can we use dashes instead of _ when using "spaces" for file names? It's just easier for typing/replacing content.
Additionally, all the rest of our docs use - rather than _, so it'd be consistent with them as well.
| @@ -14,7 +14,7 @@ This document outlines the steps required to configure your app to use default p | |||
|
|
|||
| <InlineAlert variant="info" slots="text"/> | |||
|
|
|||
| Default push template functionality is available for use with the **Adobe Campaign Classic** extension. <br /><br />Supported versions are **Android SDK version >= 2.1.0 && < 3.0.0** and **iOS SDK version 5.0.0+**. | |||
| Default push template functionality is available for use with the **Adobe Campaign Classic** extension. <br /><br />Supported version is **Android SDK version 3.1.0+**. | |||
There was a problem hiding this comment.
I'm not sure how I caught this earlier, but this sounds a little odd phrased like this. I'd go with "This is supported by Android SDK version 3.1.0+.".
| @@ -12,7 +12,7 @@ keywords: | |||
|
|
|||
| <InlineAlert variant="info" slots="text"/> | |||
|
|
|||
| Default push template functionality is available for use with the **Adobe Campaign Classic** extension. <br /><br />Supported versions are **Android SDK version >= 2.1.0 && < 3.0.0** and **iOS SDK version 5.0.0+**. | |||
| Default push template functionality is available for use with the **Adobe Campaign Classic** extension. <br /><br />Supported versions are **Android SDK version 3.1.0+** and **iOS SDK version 5.0.0+**. | |||
There was a problem hiding this comment.
Same comment as above - I'd rephrase it to "This is supported by Android SDK version 3.1.0+ and iOS SDK version 5.0.0+."
|
|
||
| **Android** | ||
|
|
||
| | **Android Image type in notification payload** | **ASPECT RATIOS** | **IMAGE SIZE RANGE** | **SUPPORTED FILE TYPES** | FILE SOURCE | |
There was a problem hiding this comment.
Any reason for these header names to be in all caps? I'd just make them "Aspect ratios", "Image size range", "Supported file types", and "File source" respectively.
Additionally, it should be matching for formatting - if they're all bold, make them all bold - don't make it so it's like some are bolded and others aren't.
|
|
||
| ## Image specifications | ||
|
|
||
| The tables below contain guidelines for your push notification content. **These recommendations help your images display reliably across multiple devices.** These values are guidelines only - it is still recommended to test a notification prior to sending it. |
There was a problem hiding this comment.
I don't like the phrasing of "It is recommended that...".
I'd go with: "... guidelines only - you should still test a notification..."
|
|
||
| ## Usage recommendations | ||
|
|
||
| The tables below contain guidelines for your push notification content. **These recommendations help your text and images display reliably across multiple devices.** These values are guidelines only - it is still recommended to test a notification prior to sending it. |
There was a problem hiding this comment.
Similar comment for the it is recommended as above: "... guidelines only - you should still test a notification..."
| @@ -77,7 +171,7 @@ Below is a sample of what a payload might look like for a notification using the | |||
|
|
|||
| ## Usage recommendations | |||
|
|
|||
| The tables below contain guidelines for your push notification content. **These recommendations help your text display reliably across multiple devices.** These values are guidelines only - it is still recommended to test a notification prior to sending it. | |||
| The tables below contain guidelines for your push notification content. **These recommendations help your text and images display reliably across multiple devices.** These values are guidelines only - it is still recommended to test a notification prior to sending it. | |||
There was a problem hiding this comment.
Similar comment for the it is recommended as above: "... guidelines only - you should still test a notification..."
|
|
||
| ## Usage recommendations | ||
|
|
||
| The tables below contain guidelines for your push notification content. **These recommendations help your text and images display reliably across multiple devices.** These values are guidelines only - it is still recommended to test a notification prior to sending it. |
There was a problem hiding this comment.
Similar comment for the it is recommended as above: "... guidelines only - you should still test a notification..."
There was a problem hiding this comment.
cleaned this is all the docs within the tabs directory
|
|
||
| ### Audio specifications | ||
|
|
||
| Custom sound files must be placed within the app's bundle in the `res/raw` directory. Supported formats are `mp3`, `wav`, or `ogg`. |
There was a problem hiding this comment.
cleaned this is all the docs within the tabs directory
Comment on lines
15
to
19
| A notification including a title, subtitle, message body, and an edge to edge background image which fills the notification area.<br /> | ||
|
|
||
| The table below shows all available properties in the respective payload for FCM (Android). | ||
| <br /> | ||
| <TabsBlock orientation="horizontal" slots="heading, content" repeat="1"/> |
There was a problem hiding this comment.
We don't need the <br/> tags here.
sbenedicadb
reviewed
Jun 11, 2024
| | [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. | <br /> | | ||
| | [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. |  | | ||
| | [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. |  | | ||
| | [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 two layout styles: vertical and horizontal. The vertical layout should be used with fullscreen (4:3) aspect ratio images and the horizontal layout should be used with widescreen (16:9) aspect ratio images. |  | |
There was a problem hiding this comment.
maybe rather than specifying image size recommendations again here, you can point them to the other table which has the complete listing of recommendations (the less content we duplicate the better)
There was a problem hiding this comment.
makes sense, i'll link directly to the main table
sbenedicadb
reviewed
Jun 11, 2024
| | [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. |  | | ||
| | [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. |  | | ||
| | [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 two layout styles: vertical and horizontal. The vertical layout should be used with fullscreen (4:3) aspect ratio images and the horizontal layout should be used with widescreen (16:9) aspect ratio images. |  | | ||
| | [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 customizable rating icons which can be pressed to provide a rating to the app via an intent. |  | |
There was a problem hiding this comment.
for this template it might be good to also specify the cta for each rating can be different
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
2
to
3
| title: Adobe Experience Platform SDK basic push template | ||
| description: Basic push template supported by Adobe Campaign Classic mobile extension. |
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
2
to
3
| title: Adobe Experience Platform SDK timer push template | ||
| description: Timer push template supported by Adobe Campaign Classic mobile extension. |
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
2
to
3
| title: Adobe Experience Platform SDK timer push template | ||
| description: Timer push template supported by Adobe Campaign Classic mobile extension. |
sbenedicadb
reviewed
Jun 11, 2024
|
|
||
| # Push template - rating | ||
|
|
||
| A notification that allows displaying a title, text, and image, along with 3-5 image buttons that allow the user to provide "rating" feedback. |
There was a problem hiding this comment.
in the multi-icon page, we did this:
with three to five (3-5) image buttons...
i suppose i don't care much which way we do it, but would ask that our docs be consistent
sbenedicadb
reviewed
Jun 11, 2024
|
|
||
| A notification that allows displaying a title, text, and image, along with 3-5 image buttons that allow the user to provide "rating" feedback. | ||
|
|
||
| After a rating is selected in the notification, an intent containing the rating is dispatched to the app. |
There was a problem hiding this comment.
should we capitalize and monospace Intent, given it's a class name?
if yes, make sure we update other references as well.
There was a problem hiding this comment.
yes i think this is a good idea. i'll update here and throughout.
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
60
to
92
| "message": { | ||
| "token": "FCM_TOKEN", | ||
| "android": { | ||
| "collapse_key": "new message" | ||
| }, | ||
| "data": { | ||
| "adb_version": "1", | ||
| "adb_template_type": "basic", | ||
| "adb_title": "game request", | ||
| "adb_body": "shall we play a game?", | ||
| "adb_sound": "bingBong", | ||
| "adb_small_icon": "ic_knight", | ||
| "adb_large_icon": "https://pictureofchess.com/logo.png", | ||
| "adb_n_count": "1", | ||
| "adb_n_priority": "PRIORITY_LOW", | ||
| "adb_channel_id": "a3b80ef", | ||
| "adb_image": "https://pictureofchess.com/board.png", | ||
| "adb_uri": "https://chess.com/games", | ||
| "adb_a_type": "WEBURL", | ||
| "adb_act": "[{\"label\":\"accept\",\"uri\":\"https://chess.com/games/552\",\"type\":\"DEEPLINK\"{\"label\":\"decline\",\"uri\":\"\",\"type\":\"OPENAPP\"}]", | ||
| "adb_tag": "24", | ||
| "adb_sticky": "true", | ||
| "adb_ticker": "Play a game?", | ||
| "adb_body_ex": "Bob wants to play a game of chess with you. Click 'accept' to start!", | ||
| "adb_clr_body": "00EE00", | ||
| "adb_clr_title": "AABBCC", | ||
| "adb_clr_icon": "123456", | ||
| "adb_clr_bg": "000000", | ||
| "adb_rem_txt": "Remind me", | ||
| "adb_rem_ts": "1703462400" | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
can we clean up the formatting for this?
There was a problem hiding this comment.
this is strange, the formatting looked fine in visual mode and when testing locally but had the massive whitespace issues in source code mode.
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :-------- | :----------- | :------ | :------- | :-------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
There was a problem hiding this comment.
please update for catalog - value is cat
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/catalog.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | Priority | ⛔️ | `adb_n_priority` | string | Designates the notification priority for Android - [importance](https://developer.android.com/reference/android/app/NotificationChannel#setImportance(int)) for API >= 26 (Android 8.0) or [priority](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder#setPriority(int)) for API < 26 | | ||
| | Tag | ⛔️ | `adb_tag` | string | Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer. | | ||
| | Sticky | ⛔️ | `adb_sticky` | string | Boolean value represented as a string "true" or "false".<br />When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. | | ||
| | Ticker | ⛔️ | `adb_ticker` | string | Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives. | |
There was a problem hiding this comment.
API 21 is our new min - is the comment about APIs less than 21, or less than and including 21? if the former, i think the comment can be removed
sbenedicadb
reviewed
Jun 11, 2024
| | Tag | ⛔️ | `adb_tag` | string | Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer. | | ||
| | Sticky | ⛔️ | `adb_sticky` | string | Boolean value represented as a string "true" or "false".<br />When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it. | | ||
| | Ticker | ⛔️ | `adb_ticker` | string | Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives. | | ||
| | Color - Small Icon | ⛔️ | `adb_clr_icon` | string | Color for the notification's small icon.<br />Represented as six character hex, e.g. `00FF00` | |
There was a problem hiding this comment.
wonder if we should move this one up under the small icon row, just to be consistent with how we represented title and body above
There was a problem hiding this comment.
yup, i will move it for better consistency.
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
35
to
36
| | Call to action button text | ✅ | `adb_cta_txt` | string | Text to be shown on the CTA button | | ||
| | Call to action button link | ✅ | `adb_cta_uri` | string | URI to be handled when the user clicks the CTA button | |
There was a problem hiding this comment.
looks like we are adding a period for punctuation for most of the rows in the table - let's continue to do that for all rows.
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
37
to
38
| | Call to action button color | ✅ | `adb_cta_clr` | string | Color for the CTA button. Represented as six character hex, e.g. `00FF00` | | ||
| | Call to action button text color | ✅ | `adb_cta_txt_clr` | string | Color for the CTA button text. Represented as six character hex, e.g. `00FF00` | |
There was a problem hiding this comment.
are these actually required? we don't have default values?
There was a problem hiding this comment.
there are default values (black text for light mode and white text for dark mode) but we decided to make the CTA text color customizable as the CTA button color is customizable. This will allow the developer to make the text have better contrast (for example when using a lighter button color in dark mode and the white text may become unreadable).
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/input-box.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :-------- | :----------- | :------ | :------- | :-------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
sbenedicadb
reviewed
Jun 11, 2024
| | Ticker | ⛔️ | `adb_ticker` | string | Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives. | | ||
| | Color - Small Icon | ⛔️ | `adb_clr_icon` | string | Color for the notification's small icon.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Color - Background | ⛔️ | `adb_clr_bg` | string | Color for notification's background.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Input receiver name | ✅ | `adb_input_receiver` | string | Required, name of the intent action to use when broadcasting the user input. | |
sbenedicadb
reviewed
Jun 11, 2024
Comment on lines
37
to
39
| | Input text | ⛔️ | `adb_input_txt` | string | Placeholder text for the text input field | | ||
| | Feedback text | ⛔️ | `adb_feedback_txt` | string | Once feedback has been submitted, use this text as the notification's body | | ||
| | Feedback image | ⛔️ | `adb_feedback_img` | string | Once feedback has been submitted, use this as the notification's image | |
There was a problem hiding this comment.
please add a period at the end of these sentences
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :-------- | :----------- | :------ | :------- | :-------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/multi-icon.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | Ticker | ⛔️ | `adb_ticker` | string | Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives. | | ||
| | Color - Small Icon | ⛔️ | `adb_clr_icon` | string | Color for the notification's small icon.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Color - Background | ⛔️ | `adb_clr_bg` | string | Color for notification's background.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Image buttons | ✅ | `adb_items` | string | Three to five icon buttons for the notification.<br />**The value is an encoded JSON string.**<br /> When decoded, the string contains an array of the following objects:<br /><ul><li>`img` (required) - URI or bundled image representing this rating</li><li>`uri`(required) - URI to be handled when the user clicks this rating</li><li>`type` (required) - Type of link represented in the value of `uri`.<br />One of "WEBURL", "DEEPLINK", or "OPENAPP". </li></ul> | |
There was a problem hiding this comment.
please add a space between uri and (required)
please remove the extra space before uri in the type list item.
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/rating.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :-------- | :----------- | :------ | :------- | :-------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
sbenedicadb
reviewed
Jun 11, 2024
| | Color - Background | ⛔️ | `adb_clr_bg` | string | Color for notification's background.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Rating icon in unselected state | ✅ | `adb_rate_unselected_icon` | string | URI or name for a rating icon to use when unselected in the notification. If the URI is valid, the remote image is downloaded and cached on the device to be used as the rating icon. If a name is provided, the app's drawable resources are checked for an image file with the same name. If no valid URI or name is provided then no notification is constructed. | | ||
| | Rating icon in selected state | ✅ | `adb_rate_selected_icon` | string | URI or name for a rating icon to use when selected in the notification. If the URI is valid, the remote image is downloaded and cached on the device to be used as the rating icon. If a name is provided, the app's drawable resources are checked for an image file with the same name. If no valid URI or name is provided then no notification is constructed. | | ||
| | Rating icon action | ✅ | `adb_rate_act` | string | **The value is an encoded JSON string.**<br />Three to five values to be used for rating confirmation, each containing a a click-through URI and type.<br />When decoded, the string contains an array of the following objects:<br /><ul><li>`uri` (required) - URI to be handled when the user selects this rating and clicks confirm</li><li>`type` (required) Type of link represented in `uri` - one of "WEBURL", "DEEPLINK", or "OPENAPP".</li></ul> | |
There was a problem hiding this comment.
please add a hyphen after 'type' (required):
`type` (required) - Type of link...
sbenedicadb
reviewed
Jun 11, 2024
| "adb_clr_bg": "000000", | ||
| "adb_rate_unselected_icon":"https://cdn-icons-png.freepik.com/256/1077/1077035.png?semt=ais_hybrid", | ||
| "adb_rate_selected_icon":"https://cdn-icons-png.freepik.com/256/833/833472.png?semt=ais_hybrid", | ||
| "adb_rate_act": "[{\"uri\":\"https://www.adobe.com\", \"type\":\"WEBURL\"},{\"type\":\"OPENAPP\"},{\"type\":\"DISMISS\"},{\"uri\": \"https://www.adobe.com\", \"type\":\"WEBURL\"},{\"uri\":\"instabiz://opensecond\", \"type\":\"DEEPLINK\"}]" |
There was a problem hiding this comment.
this example property looks incomplete. don't all objects need to have both uri and type?
also, are the number of icons displayed dependent on the number of objects in this array? if so, we should make sure that gets clarified somewhere in the docs.
There was a problem hiding this comment.
Taking a look at the code, the URI is optional in the case of OPENAPP or DISMISS actions. These actions will just be executed without the need of a URI. I'll update the wiki and docs with this info.
You are correct about the number of items shown matching the number of objects in the array. I'll add clarification regarding this.
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :---------------------- | :----------- | :------------------ | :------- | :----------------------------------------------------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
There was a problem hiding this comment.
please update to timer
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/timer.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | Alternate body | ⛔️ | `adb_body_alt` | String | Alternate text for body of the notification after the timer has expired. | | ||
| | Expanded Body | ⛔️ | `adb_body_ex` | string | Body of the message when the message is expanded. | | ||
| | Alternate expanded body | ⛔️ | `adb_body_ex_alt` | string | Alternate text for body of the notification when the message is expanded after the timer has expired. | | ||
| | Alternate image | ⛔️ | `adb_image_alt` | string | Alternate URI of an image to be shown when notification is expanded after the timer has expired. | |
There was a problem hiding this comment.
can we move this line to under adb_image for consistency?
sbenedicadb
reviewed
Jun 11, 2024
src/pages/resources/reference/push-notifications/templates/tabs/zero-bezel.md
Show resolved
Hide resolved
sbenedicadb
reviewed
Jun 11, 2024
| | **Field** | **Required** | **Key** | **Type** | **Description** | | ||
| | :-------- | :----------- | :------ | :------- | :-------------- | | ||
| | Payload Version | ✅ | `adb_version` | string | Version of the payload assigned by the ACC authoring UI. | | ||
| | Template Type | ✅ | `adb_template_type` | string | Informs the reader which properties may exist in the template object.<br />Basic template uses a value of "basic". | |
sbenedicadb
reviewed
Jun 11, 2024
| | Ticker | ⛔️ | `adb_ticker` | string | Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives. | | ||
| | Color - Small Icon | ⛔️ | `adb_clr_icon` | string | Color for the notification's small icon.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Color - Background | ⛔️ | `adb_clr_bg` | string | Color for notification's background.<br />Represented as six character hex, e.g. `00FF00` | | ||
| | Collapsed notification style | ⛔️ | `adb_col_style` | string | Determines whether the collapsed message should show a zero-bezel image, or text only. | |
There was a problem hiding this comment.
let's make sure we provide the valid values here, as well as the default value if none is provided.
sbenedicadb
requested changes
Jun 11, 2024
There was a problem hiding this comment.
a ton of content here :)
several little updates to make. thanks for this @rymorale!
10 tasks
10 tasks
calebk1
approved these changes
Jun 21, 2024
src/pages/resources/reference/push-notifications/templates/basic.md
Outdated
Show resolved
Hide resolved
src/pages/resources/reference/push-notifications/templates/carousel.md
Outdated
Show resolved
Hide resolved
sbenedicadb
approved these changes
Jun 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: