generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #632 from sbenedicadb/content-cards
adding docs for content cards release
- Loading branch information
Showing
12 changed files
with
741 additions
and
43 deletions.
There are no files selected for viewing
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
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
186 changes: 186 additions & 0 deletions
186
src/pages/edge/adobe-journey-optimizer/public-classes/content-card-schema-data.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| --- | ||
| title: ContentCardSchemaData | ||
| description: The `ContentCardSchemaData` class represents a "content-card" proposition received from the remote, upon a personalization query request to the Experience Edge network. | ||
| keywords: | ||
| - Adobe Journey Optimizer | ||
| - Messaging | ||
| - Proposition | ||
| - Interface | ||
| - Android | ||
| - iOS | ||
| - Code-based Experiences | ||
| - Content Cards | ||
| --- | ||
|
|
||
| # ContentCardSchemaData | ||
|
|
||
| Represents the proposition response object containing a `content-card` schema. | ||
|
|
||
| ## iOS Interface | ||
|
|
||
| ```swift | ||
| @objc(AEPContentCardSchemaData) | ||
| @objcMembers | ||
| public class ContentCardSchemaData: NSObject, Codable { | ||
| /// Represents the content of the ContentCardSchemaData object. Its value's type is determined by `contentType`. | ||
| public let content: Any | ||
|
|
||
| /// Determines the value type of `content`. | ||
| public let contentType: ContentType | ||
|
|
||
| /// Date and time this content card was published represented as epoch seconds | ||
| public let publishedDate: Int? | ||
|
|
||
| /// Date and time this content card will expire represented as epoch seconds | ||
| public let expiryDate: Int? | ||
|
|
||
| /// Dictionary containing any additional meta data for this content card | ||
| public let meta: [String: Any]? | ||
|
|
||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ### Public functions | ||
|
|
||
| --- | ||
|
|
||
| ### getContentCard | ||
|
|
||
| Tries to convert the `content` of this `ContentCardSchemaData` into a [`ContentCard`](./content-card.md) object. | ||
|
|
||
| Returns `nil` if the `contentType` is not equal to `.applicationJson` or the data in `content` is not decodable into a `ContentCard`. | ||
|
|
||
| #### Syntax | ||
|
|
||
| ```swift | ||
| func getContentCard() -> ContentCard? | ||
| ``` | ||
|
|
||
| #### Example | ||
|
|
||
| ```swift | ||
| var propositionItem: PropositionItem | ||
| if let contentCardSchemaData = propositionItem.contentCardSchemaData, | ||
| let contentCard = contentCardSchemaData.getContentCard() { | ||
| // do something with the ContentCard object | ||
| } | ||
| ``` | ||
|
|
||
| ### track(_:withEdgeEventType:) | ||
|
|
||
| Tracks an interaction with the given `ContentCardSchemaData`. | ||
|
|
||
| #### Syntax | ||
|
|
||
| ```swift | ||
| public func track(_ interaction: String? = nil, withEdgeEventType eventType: MessagingEdgeEventType) | ||
| ``` | ||
|
|
||
| #### Parameters | ||
|
|
||
| * _interaction_ - a custom `String` value to be recorded in the interaction | ||
| * _eventType_ - the [`MessagingEdgeEventType`](./messaging-edge-event-type.md) to be used for the ensuing Edge Event | ||
|
|
||
| #### Example | ||
|
|
||
| ```swift | ||
| var contentCardSchemaData: ContentCardSchemaData | ||
|
|
||
| // tracking a display | ||
| contentCardSchemaData.track(withEdgeEventType: .display) | ||
|
|
||
| // tracking a user interaction | ||
| contentCardSchemaData.track("itemSelected", withEdgeEventType: .interact) | ||
| ``` | ||
|
|
||
| ## Android Interface | ||
|
|
||
| ```java | ||
| public class ContentCardSchemaData implements SchemaData { | ||
| private Object content; | ||
| private ContentType contentType; | ||
| private int publishedDate; | ||
| private int expiryDate; | ||
| private Map<String, Object> meta; | ||
|
|
||
| @Override | ||
| public Object getContent() { | ||
| return content; | ||
| } | ||
|
|
||
| public ContentType getContentType() { | ||
| return contentType; | ||
| } | ||
|
|
||
| public int getPublishedDate() { | ||
| return publishedDate; | ||
| } | ||
|
|
||
| public int getExpiryDate() { | ||
| return expiryDate; | ||
| } | ||
|
|
||
| @Nullable public Map<String, Object> getMeta() { | ||
| return meta; | ||
| } | ||
|
|
||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ### Public functions | ||
|
|
||
| --- | ||
|
|
||
| ### getContentCard | ||
|
|
||
| Tries to convert the `content` of this `ContentCardSchemaData` into a [`ContentCard`](./content-card.md) object. | ||
|
|
||
| Returns `nil` if the `contentType` is not equal to `.applicationJson` or the data in `content` is not decodable into a `ContentCard`. | ||
|
|
||
| #### Syntax | ||
|
|
||
| ```java | ||
| @Nullable public ContentCard getContentCard(); | ||
| ``` | ||
|
|
||
| #### Example | ||
|
|
||
| ```java | ||
| PropositionItem propositionItem; | ||
| ContentCardSchemaData contentCardSchemaData = propositionItem.getContentCardSchemaData(); | ||
| if (contentCardSchemaData != null) { | ||
| ContentCard contentCard = contentCardSchemaData.getContentCard(); | ||
| if (contentCard != null) { | ||
| // do something with the ContentCard object | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### track | ||
|
|
||
| Tracks an interaction with the given `ContentCardSchemaData`. | ||
|
|
||
| #### Syntax | ||
|
|
||
| ```java | ||
| public void track(final String interaction, final MessagingEdgeEventType eventType); | ||
| ``` | ||
|
|
||
| #### Parameters | ||
|
|
||
| * _interaction_ - a custom `String` value to be recorded in the interaction | ||
| * _eventType_ - the [`MessagingEdgeEventType`](./messaging-edge-event-type.md) to be used for the ensuing Edge Event | ||
|
|
||
| #### Example | ||
|
|
||
| ```java | ||
| ContentCardSchemaData contentCardSchemaData; | ||
|
|
||
| // tracking a display | ||
| contentCardSchemaData.track(null, MessagingEdgeEventType.display); | ||
|
|
||
| // tracking a user interaction | ||
| contentCardSchemaData.track("itemSelected", MessagingEdgeEventType.interact); | ||
| ``` |
Oops, something went wrong.