From 0e0c4169e971718e8d12c5084add18f55c18c56a Mon Sep 17 00:00:00 2001 From: Pravin Prakash Kumar Date: Fri, 1 Nov 2024 15:23:24 -0700 Subject: [PATCH] Fix lint problems --- .../content-card-ui/iOS/api-usage.md | 18 +++++----- .../content-card-ui/iOS/index.md | 36 +++++++++---------- .../public-classes/contentcardcustomizing.md | 8 +++-- .../public-classes/contentcardtemplatetype.md | 2 +- .../iOS/public-classes/contentcardui.md | 1 - .../contentcarduieventlistening.md | 10 +++--- .../iOS/templates/smallimage-template.md | 14 ++++---- .../customizing-content-card-templates.md | 2 +- .../tutorial/listening-content-card-events.md | 12 +++---- .../iOS/ui-elements/aepbutton.md | 4 +-- .../iOS/ui-elements/aepdismissbutton.md | 2 +- .../iOS/ui-elements/aepimage.md | 12 +++---- .../iOS/ui-elements/aepstack.md | 2 +- .../iOS/ui-elements/aeptext.md | 3 +- .../content-card-ui/iOS/ui-elements/index.md | 10 +++--- 15 files changed, 68 insertions(+), 68 deletions(-) diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/api-usage.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/api-usage.md index e9e6003ded..6546f169e6 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/api-usage.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/api-usage.md @@ -22,16 +22,16 @@ The `getContentCardsUI` method retrieves an array of [ContentCardUI](./public-cl #### Parameters: -- _surface_ - The [Surface](../../public-classes/surface.md) for which the content cards should be retrieved. -- _customizer_ - An optional [ContentCardCustomizing](./public-classes/contentcardcustomizing.md) object to customize the appearance of the content card template. If you do not need to customize the appearance of the content card template, this parameter can be omitted. -- _listener_ - An optional [ContentCardUIEventListening](./public-classes/contentcarduieventlistening.md) object to listen to UI events from the content card. If you do not need to listen to UI events from the content card, this parameter can be omitted. -- _completion_ - A completion handler that is called with a `Result` containing either: - - _success_ - An array of [ContentCardUI](./public-classes/contentcardui.md) objects representing the content cards to be displayed. - - _failure_ - An `Error` object indicating the reason for the failure, if any. +* _surface_ - The [Surface](../../public-classes/surface.md) for which the content cards should be retrieved. +* _customizer_ - An optional [ContentCardCustomizing](./public-classes/contentcardcustomizing.md) object to customize the appearance of the content card template. If you do not need to customize the appearance of the content card template, this parameter can be omitted. +* _listener_ - An optional [ContentCardUIEventListening](./public-classes/contentcarduieventlistening.md) object to listen to UI events from the content card. If you do not need to listen to UI events from the content card, this parameter can be omitted. +* _completion_ - A completion handler that is called with a `Result` containing either: + * _success_ - An array of [ContentCardUI](./public-classes/contentcardui.md) objects representing the content cards to be displayed. + * _failure_ - An `Error` object indicating the reason for the failure, if any. -Calling this API will not download content cards from Adobe Journey Optimizer; it will only retrieve the content cards that are already downloaded and cached by the Messaging extension. You **must** call [`updatePropositionsForSurfaces`](../../code-based/api-reference.md#updatepropositionsforsurfaces) API with the desired surfaces prior to calling this API. +Calling this API will not download content cards from Adobe Journey Optimizer; it will only retrieve the content cards that are already downloaded and cached by the Messaging extension. You **must** call [`updatePropositionsForSurfaces`](../../code-based/api-reference.md#updatepropositionsforsurfaces) API with the desired surfaces prior to calling this API. #### Syntax @@ -58,7 +58,7 @@ let homePageSurface = Surface(path: "homepage") Messaging.updatePropositionsForSurfaces([homePageSurface]) // Get the content card UI for the homepage surface -Messaging.getContentCardsUI(for: acrobatCardsSurface) { result in +Messaging.getContentCardsUI(for: homePageSurface) { result in switch result { case .success(let contentCards): // Use the contentCards array to display UI for templated content cards in your application @@ -66,4 +66,4 @@ Messaging.getContentCardsUI(for: acrobatCardsSurface) { result in // Handle the error } } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/index.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/index.md index 32995d4969..59c7e54e52 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/index.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/index.md @@ -14,35 +14,35 @@ keywords: ## Requirements -- iOS 15 (or newer) -- Xcode 15 (or newer) -- Swift 5.1 (or newer) +* iOS 15 (or newer) +* Xcode 15 (or newer) +* Swift 5.1 (or newer) ## API Reference -- [Content Card API's](./api-usage.md) +* [Content Card API's](./api-usage.md) ## Public Classes, Enums, and Protocols -- [Class - ContentCardUI](./public-classes/contentcardui.md) -- [Protocol - ContentCardCustomizing](./public-classes/contentcardcustomizing.md) -- [Protocol - ContentCardUIEventListening](./public-classes/contentcarduieventlistening.md) -- [Enum - ContentCardTemplateType](./public-classes/contentcardtemplatetype.md) +* [Class - ContentCardUI](./public-classes/contentcardui.md) +* [Protocol - ContentCardCustomizing](./public-classes/contentcardcustomizing.md) +* [Protocol - ContentCardUIEventListening](./public-classes/contentcarduieventlistening.md) +* [Enum - ContentCardTemplateType](./public-classes/contentcardtemplatetype.md) ## Templates -- [SmallImageTemplate](./templates/smallimage-template.md) +* [SmallImageTemplate](./templates/smallimage-template.md) ## UI Elements -- [AEPText](./ui-elements/aeptext.md) -- [AEPButton](./ui-elements/aepbutton.md) -- [AEPImage](./ui-elements/aepimage.md) -- [AEPStack](./ui-elements/aepstack.md) -- [AEPDismissButton](./ui-elements/aepdismissbutton.md) - +* [AEPText](./ui-elements/aeptext.md) +* [AEPButton](./ui-elements/aepbutton.md) +* [AEPImage](./ui-elements/aepimage.md) +* [AEPStack](./ui-elements/aepstack.md) +* [AEPDismissButton](./ui-elements/aepdismissbutton.md) + ## Tutorials -- [Fetch and Display Content Cards](./tutorial/displaying-content-cards.md) -- [Customizing Content Card Templates](./tutorial/customizing-content-card-templates.md) -- [Listening to Content Card Events](./tutorial/listening-content-card-events.md) \ No newline at end of file +* [Fetch and Display Content Cards](./tutorial/displaying-content-cards.md) +* [Customizing Content Card Templates](./tutorial/customizing-content-card-templates.md) +* [Listening to Content Card Events](./tutorial/listening-content-card-events.md) diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardcustomizing.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardcustomizing.md index 39bab2cb4a..e91eff5264 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardcustomizing.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardcustomizing.md @@ -30,13 +30,15 @@ protocol ContentCardCustomizing { ## Methods -### customize +### customize Customize content cards with [SmallImageTemplate](../PublicClasses/Template/smallimage-template.md). #### Parameters -- _template_ - The `SmallImageTemplate` instance to be customized. +* _template_ - The `SmallImageTemplate` instance to be customized. + +#### Syntax @@ -44,4 +46,4 @@ Customize content cards with [SmallImageTemplate](../PublicClasses/Template/smal ``` swift func customize(template: SmallImageTemplate) -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardtemplatetype.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardtemplatetype.md index 7751d9cbb2..ee8ccf8f8d 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardtemplatetype.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardtemplatetype.md @@ -13,7 +13,7 @@ keywords: # ContentCardTemplateType -An enumeration of the different types of content card templates supported by the AEPSwiftUI framework. +An enumeration of the different types of content card templates supported by the AEPSwiftUI framework. Each case corresponds to a specific template type, identified by its JSON string value. diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardui.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardui.md index f51ca3b319..80f8e9f064 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardui.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcardui.md @@ -21,4 +21,3 @@ The ContentCardUI class is responsible for holding data for a content card and p | --- | --- | --- | | view | [View](https://developer.apple.com/documentation/swiftui/view) | The SwiftUI view representing the content card. | | meta | [String: Any] | The metadata associated with the content card. | - diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcarduieventlistening.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcarduieventlistening.md index ce552d153f..33bcd10885 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcarduieventlistening.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/public-classes/contentcarduieventlistening.md @@ -37,7 +37,7 @@ Called when the content card appears on the screen. Implementation of this metho #### Parameters -- _card_ - The [ContentCardUI](./contentcardui.md) that is displayed. +* _card_ - The [ContentCardUI](./contentcardui.md) that is displayed. #### Syntax @@ -55,7 +55,7 @@ Called when the content card is dismissed. Implementation of this method is opti #### Parameters -- _card_ - The [ContentCardUI](./contentcardui.md) that is dismissed. +* _card_ - The [ContentCardUI](./contentcardui.md) that is dismissed. #### Syntax @@ -73,9 +73,9 @@ Called when the user interacts with the content card. Implementation of this met #### Parameters -- _card_ - The [ContentCardUI](./contentcardui.md) that is interacted with. -- _interactionId_ - A string identifier for the interaction event. -- _actionURL_ - The optional URL associated with the interaction. +* _card_ - The [ContentCardUI](./contentcardui.md) that is interacted with. +* _interactionId_ - A string identifier for the interaction event. +* _actionURL_ - The optional URL associated with the interaction. #### Returns diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/templates/smallimage-template.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/templates/smallimage-template.md index 4e9ccb38e5..40ba2c144f 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/templates/smallimage-template.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/templates/smallimage-template.md @@ -21,13 +21,13 @@ keywords: --- # SmallImageTemplate + + This class represents a SmallImage templated content card authored in Adobe Journey Optimizer. - This class represents a SmallImage templated content card authored in Adobe Journey Optimizer. - - A small image template content card includes a title, body, image, and a maximum of three buttons. The image is displayed in line with the text content. An optional dismiss button can be added to dismiss the content card. - - Use the SmallImageTemplate class to customize the appearance of the small image templated content cards. - + A small image template content card includes a title, body, image, and a maximum of three buttons. The image is displayed in line with the text content. An optional dismiss button can be added to dismiss the content card. + + Use the SmallImageTemplate class to customize the appearance of the small image templated content cards. + SmallImageTemplate conforms to `ObservableObject`, allowing it to be used reactively in SwiftUI views. ## Layout @@ -45,4 +45,4 @@ keywords: | buttonHStack | [AEPHStack](../ui-elements/aepstack.md#aephstack) | A horizontal stack for arranging buttons. | | textVStack | [AEPVStack](../ui-elements/aepstack.md#aepvstack) | A vertical stack for arranging the title, body, and buttons. | | rootHStack | [AEPHStack](../ui-elements/aepstack.md#aephstack) | A horizontal stack for arranging the image and text stack. | -| dismissButton | [AEPDismissButton](../ui-elements/aepdismissbutton.md) | *Optional*
The dismiss button for the content card. | \ No newline at end of file +| dismissButton | [AEPDismissButton](../ui-elements/aepdismissbutton.md) | *Optional*
The dismiss button for the content card. | diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/customizing-content-card-templates.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/customizing-content-card-templates.md index 29d79caeab..1025e830b4 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/customizing-content-card-templates.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/customizing-content-card-templates.md @@ -116,4 +116,4 @@ Messaging.getContentCardsUI(for: detailPageSurface, customizer: detailPageCustomizer) { result in // handle result } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/listening-content-card-events.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/listening-content-card-events.md index c5ecf5f488..0c3c8a499f 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/listening-content-card-events.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/tutorial/listening-content-card-events.md @@ -23,9 +23,9 @@ This tutorial explains how to listen to content card events in your application. 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: -- `onDisplay` -- `onDismiss` -- `onInteract` +* `onDisplay` +* `onDismiss` +* `onInteract` ## Implement ContentCardEventListening @@ -85,9 +85,9 @@ struct HomePage: View, ContentCardUIEventListening { 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. +* 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. +* Return `false` to allow the SDK to process the URL. @@ -98,7 +98,7 @@ func onInteract(_ card: ContentCardUI, _ interactionId: String, actionURL: URL?) guard let url = actionURL else { return false } // Your application handles the actionable URL here - + // Return true to indicate that the SDK need not process the URL return true } diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepbutton.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepbutton.md index 88a6630b19..8f9861e985 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepbutton.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepbutton.md @@ -17,7 +17,7 @@ keywords: The AEPButton class is a fundamental UI component used to create interactive buttons for content cards. -Customization of the button's properties can be achieved with a custom view modifier. +Customization of the button's properties can be achieved with a custom view modifier. AEPButton conforms to `ObservableObject`, allowing it to be used reactively in SwiftUI views. @@ -58,4 +58,4 @@ class MyCustomizer: ContentCardCustomizing { } } } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepdismissbutton.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepdismissbutton.md index 8d4ff8086e..43b539b4a1 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepdismissbutton.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepdismissbutton.md @@ -60,4 +60,4 @@ class MyCustomizer: ContentCardCustomizing { } } } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepimage.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepimage.md index 32302b53f8..3a6e7e4b6e 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepimage.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepimage.md @@ -17,19 +17,19 @@ keywords: The AEPImage class is a fundamental UI component used to display images for content cards. -Images can be displayed from various sources (URL, bundle, or SF Symbols) and their appearance can be customized. +Images can be displayed from various sources (URL, bundle, or SF Symbols) and their appearance can be customized. AEPImage conforms to `ObservableObject`, allowing it to be used reactively in SwiftUI views. ## Image Sources -The AEPImage class supports multiple sources for displaying images, with built-in support for both light and dark mode variants. +The AEPImage class supports multiple sources for displaying images, with built-in support for both light and dark mode variants. Image sources are prioritized in the following order: -- URL images -- Bundled resource images -- SF Symbol icons +* URL images +* Bundled resource images +* SF Symbol icons ## Public properties @@ -75,4 +75,4 @@ class MyCustomizer: ContentCardCustomizing { } } } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepstack.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepstack.md index 732b0cdd59..5b1da431e7 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepstack.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aepstack.md @@ -83,4 +83,4 @@ class MyCustomizer : ContentCardCustomizing { } } } -``` \ No newline at end of file +``` diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aeptext.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aeptext.md index d25cc0ed22..49330ddd90 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aeptext.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/aeptext.md @@ -18,11 +18,10 @@ keywords: The AEPText class is a fundamental UI component used to display text for content cards. -This class allows you to customize the text element with properties like font, color, and modifier. +This class allows you to customize the text element with properties like font, color, and modifier. AEPText class conforms to `ObservableObject`, allowing it to be used reactively in SwiftUI views. - ## Properties | Property | Type | Description | Default Value | diff --git a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/index.md b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/index.md index 8981c9edff..ad423882a7 100644 --- a/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/index.md +++ b/src/pages/edge/adobe-journey-optimizer/content-card-ui/iOS/ui-elements/index.md @@ -21,8 +21,8 @@ keywords: Messaging extension provides the following UI elements that act as building blocks for creating templated content cards: -- [AEPText](./aeptext.md) -- [AEPButton](./aepbutton.md) -- [AEPImage](./aepimage.md) -- [AEPStack](./aepstack.md) -- [AEPDismissButton](./aepdismissbutton.md) +* [AEPText](./aeptext.md) +* [AEPButton](./aepbutton.md) +* [AEPImage](./aepimage.md) +* [AEPStack](./aepstack.md) +* [AEPDismissButton](./aepdismissbutton.md)