Add Android Content card UI Docs #722

rymorale · 2024-11-12T16:32:23Z

Description

Add Android Content Card UI docs. These docs are based off the Android Messaging repo docs added in adobe/aepsdk-messaging-android#305.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

PravinPK · 2024-11-18T19:33:26Z

Merged #715 to main branch. @rymorale you can now pull from main branch.

…roid

amyeoulton

There's a general structure we're supposed to follow in documentation where we cannot drop down more than one heading level at a time. For example, and h1 should be followed by and h2. Through this document, headings jump around a lot - often from an h2 to an h4 but sometimes in even greater jumps.

I know the intention here is to be consistent in what is being displayed throughout the documentation (ie. Kotlin sections always being h4s) but this does go against documentation guidelines and should be corrected.

"id" is also used regularly throughout the documentation and should be corrected to "ID". I didn't want to leave notes on every individual instance.
Is AEP a user-facing term for mobile SDKs?

I've left a series of other comments that need attention.

amyeoulton · 2024-11-21T18:40:16Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/index.md

@@ -0,0 +1,77 @@
+---
+title: Content Card UI 
+description: These documents guide you to integrating a content card ui message with an Android app.


UI should be capitalized here.

amyeoulton · 2024-11-21T18:41:59Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md

@@ -0,0 +1,165 @@
+---
+title: AepUI
+description: This document contains information regarding the AepUI interface and it's implementations.


should be "its" without the apostrophe.

amyeoulton · 2024-11-21T18:43:09Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md

+
+# AepUI
+
+The `AepUI` interface represents a UI component that can be rendered using the AEP compose UI library. The AEP compose UI currently supports rendering the following UI templates:


Is the second line discussing the library again, or the UI directly? If it's discussing the library, this would make more sense as either "The AEP compose UI library..." or "AEP compose UI...".

Otherwise, disregard.

There is also only a single template listed under here, so templates should be singular.

amyeoulton · 2024-11-21T18:45:30Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md

+
+The `AepUI` interface represents a UI component that can be rendered using the AEP compose UI library. The AEP compose UI currently supports rendering the following UI templates:
+
+1. `SmallImageUI` which renders `Small Image template`


Since this is the only template, we should remove the numbering.

amyeoulton · 2024-11-21T18:49:47Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md

+fun updateState(newState: S)
+```
+
+# Implementing Classes


There should only be one h1 heading per document.

amyeoulton · 2024-11-21T20:25:37Z

...es/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md

+}    
+```
+
+Refer to this [TestApp](https://github.com/adobe/aepsdk-messaging-android/tree/feature/content-cards/code/testapp) for a complete example of how to display, customize and listen to UI events from content cards in a Compose UI application.


Need a comma after customize here.

amyeoulton · 2024-11-21T20:26:20Z

...es/edge/adobe-journey-optimizer/content-card-ui/Android/tutorial/displaying-content-cards.md

+
+#### Retrieve ContentCardSchemaData from the Messaging extension
+
+You may retrieve the `ContentCardSchemaData` for a Content Card using the template id using the [ContentCardMapper](../public-classes/contentcardmapper.md):


having "using" twice in a row here is a little confusing. Perhaps "with the template id using..."

amyeoulton · 2024-11-21T20:27:14Z

...ge/adobe-journey-optimizer/content-card-ui/Android/tutorial/listening-content-card-events.md

+
+The `onInteract` method provides an optional `actionURL` parameter associated with the interaction event. The return value of this method determines how the URL is handled.
+
+* Return `true` if your application has successfully handled the URL. This indicates to the SDK that no further action is needed.


These should both be "returns".

amyeoulton · 2024-11-21T20:28:36Z

src/pages/edge/adobe-journey-optimizer/content-card-ui/Android/public-classes/aepui.md

+
+#### Returns
+
+A template of type `T` which is an implementation of the  `AepUITemplate` interface


Missing a period at the end of this sentence.

amyeoulton · 2024-11-21T20:31:17Z

...e/adobe-journey-optimizer/content-card-ui/Android/public-classes/styles/smallimageuistyle.md

+
+Class representing the style for a small image AEP UI.
+
+![Small Image Card Composeable Layout](../../../assets/Android/SmallImageCard composable layout.png)


This image link has spaces in it and will be broken.

rymorale · 2024-11-21T20:56:14Z

There's a general structure we're supposed to follow in documentation where we cannot drop down more than one heading level at a time. For example, and h1 should be followed by and h2. Through this document, headings jump around a lot - often from an h2 to an h4 but sometimes in even greater jumps.

I know the intention here is to be consistent in what is being displayed throughout the documentation (ie. Kotlin sections always being h4s) but this does go against documentation guidelines and should be corrected.

"id" is also used regularly throughout the documentation and should be corrected to "ID". I didn't want to leave notes on every individual instance.

Is AEP a user-facing term for mobile SDKs?

I've left a series of other comments that need attention.

I'll get the heading sizing fixed up and id correctly changed to ID. Thanks for the heads up regarding these two inconsistencies. I think AEP is less widely used so I can replace it with Adobe Experience Platform where it is used.

rymorale added 2 commits November 8, 2024 13:12

initial batch of updates for android content card ui documentation

9fdc134

second batch of updates for android content card ui documentation

56a75b6

rymorale requested review from spoorthipujariadobe and calebk1 November 12, 2024 16:32

rymorale added 2 commits November 14, 2024 12:40

fix lint errors

aac561b

Update smallimage-template.md

5442ee6

Merge remote-tracking branch 'upstream/main' into content-card-ui-and…

e32624f

…roid

rymorale changed the base branch from main to android-content-cards November 21, 2024 18:04

rymorale requested a review from amyeoulton November 21, 2024 18:15

amyeoulton reviewed Nov 21, 2024

View reviewed changes

review updates based on @amyeoulton's review

f7e4285

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Android Content card UI Docs #722

Add Android Content card UI Docs #722

rymorale commented Nov 12, 2024 •

edited

Loading

PravinPK commented Nov 18, 2024

amyeoulton left a comment •

edited

Loading

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

amyeoulton Nov 21, 2024

rymorale commented Nov 21, 2024


		# AepUI

		The `AepUI` interface represents a UI component that can be rendered using the AEP compose UI library. The AEP compose UI currently supports rendering the following UI templates:


		The `AepUI` interface represents a UI component that can be rendered using the AEP compose UI library. The AEP compose UI currently supports rendering the following UI templates:

		1. `SmallImageUI` which renders `Small Image template`


		#### Retrieve ContentCardSchemaData from the Messaging extension

		You may retrieve the `ContentCardSchemaData` for a Content Card using the template id using the [ContentCardMapper](../public-classes/contentcardmapper.md):


		The `onInteract` method provides an optional `actionURL` parameter associated with the interaction event. The return value of this method determines how the URL is handled.

		* Return `true` if your application has successfully handled the URL. This indicates to the SDK that no further action is needed.


		#### Returns

		A template of type `T` which is an implementation of the `AepUITemplate` interface


		Class representing the style for a small image AEP UI.

		![Small Image Card Composeable Layout](../../../assets/Android/SmallImageCard composable layout.png)

Add Android Content card UI Docs #722

Are you sure you want to change the base?

Add Android Content card UI Docs #722

Conversation

rymorale commented Nov 12, 2024 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

PravinPK commented Nov 18, 2024

amyeoulton left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rymorale commented Nov 21, 2024

rymorale commented Nov 12, 2024 •

edited

Loading

amyeoulton left a comment •

edited

Loading