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.

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

Content card UI for iOS #715

Merged
merged 8 commits into from
Nov 18, 2024
Merged

Content card UI for iOS #715

merged 8 commits into from
Nov 18, 2024

Conversation

PravinPK
Copy link
Contributor

Description

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 PravinPK changed the base branch from ContentCardUI to main November 1, 2024 18:11
Copy link
Contributor

@calebk1 calebk1 left a comment

Choose a reason for hiding this comment

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

Left some comments!


## Overview

The Messaging extension provides a way to listen to events from content cards displayed in your application. The following functions can be implemented in conformance with the [ContentCardUIEventListening](../public-classes/contentcarduieventlistening.md) protocol:
Copy link
Contributor

Choose a reason for hiding this comment

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

I would just simplify and make this "... can be implemented with the..."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When defining protocol methods the word "conformance" makes sense.

Comment on lines 88 to 90
- Return `true` if your application has successfully handled the URL. This indicates to the SDK that no further action is needed.

- Return `false` to allow the SDK to process the URL.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Returns true/false...."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same comment as above, instructions are directed at the developer implementing the method.
Hence Return makes sense

Copy link
Collaborator

Choose a reason for hiding this comment

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

"Returns" would still be the correct usage here, even with its developer-focused and imperative tone since we're explaining that it will be returned and not directly providing a return statement. Here's a link to other documentation in the SDK where we use "returns" for the same usage case:

https://developer.adobe.com/client-sdks/edge/adobe-journey-optimizer/public-classes/content-card-schema-data/#getcontentcard---deprecated-1

Comment on lines +38 to +50
# AEPHStack

The AEPHStack class extends AEPStack and arranges its child views horizontally. It provides additional customization for aligning child views vertically.

## Public Properties

| Property | Type | Description | Default Value |
| --- | --- | --- | --- |
| alignment | [VerticalAlignment](https://developer.apple.com/documentation/swiftui/verticalalignment) | The vertical alignment of child views in the stack. | [center](https://developer.apple.com/documentation/swiftui/verticalalignment/center) |

# AEPVStack

The AEPVStack class extends AEPStack and arranges its child views vertically. It provides additional customization for aligning child views horizontally.
Copy link
Contributor

Choose a reason for hiding this comment

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

Wait... HStack provides customization for aligning child views vertically and VStack for arranging child views horizontally?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haha yeah seems confusing but this is correct. Here is Apple documentation https://developer.apple.com/documentation/swiftui/hstack/init(alignment:spacing:content:)

@rymorale rymorale mentioned this pull request Nov 12, 2024
10 tasks
Copy link
Collaborator

@amyeoulton amyeoulton left a comment

Choose a reason for hiding this comment

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

A few small comments but otherwise looks good.


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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again, these would be better as "Returns", as mentioned in other comments.

@PravinPK PravinPK merged commit feddeb2 into AdobeDocs:main Nov 18, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants