generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 40
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
Restructure AJO #437
Merged
Merged
Restructure AJO #437
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
d5322c2
Refactor AJO
720b496
add newlines to end of file for lint purpose
b65f9d4
Comments fixes
8912d28
Merge branch 'main' into main
PravinPK 673cab5
Merge branch 'main' into main
PravinPK 9099085
Merge branch 'main' into main
PravinPK eb68ade
More fixes for betterment
ba72004
rename and revert public-classes-and-enum to public-classes
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,20 +25,6 @@ iOS | |
|
||
<Tabs query="platform=ios&api=extension-version"/> | ||
|
||
## handleNotificationResponse | ||
|
||
The handleNotificationResponse function transmits the push notification interaction feedback. | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/> | ||
|
||
Android | ||
|
||
<Tabs query="platform=android&api=handle-notification-response"/> | ||
|
||
iOS | ||
|
||
<Tabs query="platform=ios&api=handle-notification-response"/> | ||
|
||
## registerExtension | ||
|
||
<InlineAlert variant="warning" slots="text"/> | ||
|
@@ -51,41 +37,19 @@ Android | |
|
||
<Tabs query="platform=android&api=register-extension"/> | ||
|
||
## refreshInAppMessages | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. altered to use instead of tab for refreshInAppMessages API |
||
|
||
<InlineAlert variant="info" slots="text"/> | ||
|
||
By default, the SDK will automatically fetch in-app message definitions from the remote at the time the Messaging extension is registered. This generally happens once per app lifecycle. | ||
|
||
Some use cases may require the client to request an update from the remote more frequently. Calling the following API will force the Messaging extension to get an updated definition of messages from the remote: | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/> | ||
|
||
Android | ||
|
||
<Tabs query="platform=android&api=refresh"/> | ||
|
||
iOS | ||
|
||
<Tabs query="platform=ios&api=refresh"/> | ||
|
||
## setPushIdentifier | ||
|
||
<InlineAlert variant="info" slots="text"/> | ||
|
||
Although this API is provided in Mobile Core, the use of this API is required and leveraged by the Adobe Journey Optimizer extension to sync provided push tokens with Adobe Experience Platform services. | ||
## handleNotificationResponse | ||
|
||
The setPushIdentifier API sets the push token, allowing you to sync it with Profile in Adobe Experience Platform. | ||
The handleNotificationResponse function transmits the push notification interaction feedback. | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/> | ||
|
||
Android | ||
|
||
<Tabs query="platform=android&api=set-push-identifier"/> | ||
<Tabs query="platform=android&api=handle-notification-response"/> | ||
|
||
iOS | ||
|
||
<Tabs query="platform=ios&api=set-push-identifier"/> | ||
<Tabs query="platform=ios&api=handle-notification-response"/> | ||
|
||
## addPushTrackingDetails | ||
|
||
|
@@ -95,42 +59,42 @@ The addPushTrackingDetails API is used to update a pending intent with important | |
|
||
Calling this API is mandatory, so the pending intent can be used while tracking push notification interactions. | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="1"/> | ||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/> | ||
|
||
Android | ||
|
||
<Tabs query="platform=android&api=add-push-tracking-details"/> | ||
|
||
## Public classes | ||
calebk1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### MessagingPushPayload | ||
|
||
`MessagePushPayload` is a helper class for extracting the data payload attributes from `RemoteMessage`, which are used while creating the push notification. | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="1"/> | ||
|
||
Android | ||
iOS | ||
|
||
<Tabs query="platform=android&api=messaging-push-payload"/> | ||
<Tabs query="platform=iOS&api=add-push-tracking-details"/> | ||
|
||
### Public APIs | ||
## refreshInAppMessages | ||
|
||
Public APIs are used to get attributes from the push payload, which are used while creating the push notification. | ||
Calling refreshInAppMessages API will force the Messaging extension to get an updated definition of messages from the remote. | ||
PravinPK marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="1"/> | ||
<CodeBlock slots="heading, code" repeat="4" languages="Kotlin, Java, Swift, ObjC" /> | ||
|
||
Android | ||
#### Android | ||
|
||
<Tabs query="platform=android&api=public-apis"/> | ||
```kotlin | ||
Messaging.refreshInAppMessages() | ||
``` | ||
|
||
### Payload keys | ||
#### Android | ||
|
||
<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/> | ||
```java | ||
Messaging.refreshInAppMessages(); | ||
``` | ||
|
||
Android | ||
#### iOS | ||
|
||
<Tabs query="platform=android&api=payload-keys"/> | ||
```swift | ||
Messaging.refreshInAppMessages() | ||
``` | ||
|
||
iOS | ||
#### iOS | ||
|
||
<Tabs query="platform=ios&api=payload-keys"/> | ||
```objc | ||
[AEPMobileMessaging refreshInAppMessages]; | ||
``` |
47 changes: 47 additions & 0 deletions
47
src/pages/edge/adobe-journey-optimizer/in-app-message/api-reference.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,47 @@ | ||
--- | ||
title: In-App Message - API Reference | ||
description: This document lists the public APIs available in the Messaging extension for implementing in-app messaging. | ||
keywords: | ||
- Adobe Journey Optimizer | ||
- API reference | ||
- Messaging | ||
- In-App Message | ||
--- | ||
|
||
# In-App Messaging - API reference | ||
|
||
This document lists the public APIs available in the Messaging extension for implementing in-app messaging. | ||
|
||
## refreshInAppMessages | ||
|
||
<InlineAlert variant="info" slots="text"/> | ||
|
||
By default, the SDK will automatically fetch in-app message definitions from the remote at the time the Messaging extension is registered. This generally happens once per app lifecycle. | ||
|
||
Some use cases may require the client to request an update from the remote more frequently. Calling the following API will force the Messaging extension to get an updated definition of messages from the remote: | ||
|
||
<CodeBlock slots="heading, code" repeat="4" languages="Kotlin, Java, Swift, ObjC" /> | ||
|
||
#### Android | ||
|
||
```kotlin | ||
Messaging.refreshInAppMessages() | ||
``` | ||
|
||
#### Android | ||
|
||
```java | ||
Messaging.refreshInAppMessages(); | ||
``` | ||
|
||
#### iOS | ||
|
||
```swift | ||
Messaging.refreshInAppMessages() | ||
``` | ||
|
||
#### iOS | ||
|
||
```objc | ||
[AEPMobileMessaging refreshInAppMessages]; | ||
``` |
Binary file added
BIN
+645 KB
...be-journey-optimizer/in-app-message/assets/validate-messages/iam-simulation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+277 KB
...ourney-optimizer/in-app-message/assets/validate-messages/install-iam-plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+550 KB
...ney-optimizer/in-app-message/assets/validate-messages/message-configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+882 KB
...e-journey-optimizer/in-app-message/assets/validate-messages/message-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+919 KB
...-optimizer/in-app-message/assets/validate-messages/message-response-payload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+883 KB
...-journey-optimizer/in-app-message/assets/validate-messages/message-response.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions
33
src/pages/edge/adobe-journey-optimizer/in-app-message/index.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,33 @@ | ||
--- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Newly created page. should review |
||
title: In-app messaging | ||
description: This document guides you to integrating in-app messaging in your application. | ||
keywords: | ||
- Adobe Journey Optimizer | ||
- Guide | ||
- Messaging | ||
- Tutorial | ||
--- | ||
|
||
# In-App Messaging | ||
|
||
This document guides you to integrating in-app messaging in your application. | ||
|
||
## API reference | ||
|
||
* [In-App Messaging APIs](./api-reference.md) | ||
|
||
## Tutorials | ||
|
||
* [Programmatically control the display of in-app messages](./messaging-delegate.md) | ||
* [Call native code from the JavaScript of an in-app message](./native-from-javascript.md) | ||
* [Execute JavaScript code in an in-app message from native code](./javascript-from-native.md) | ||
* [Handle URL clicks from an in-app message](./handle-clicks.md) | ||
|
||
## Public Classes and Enums | ||
|
||
* [Class - Message](../public-classes-and-enum/message.md) | ||
* [Enum - MessagingEdgeEventType](../public-classes-and-enum/messaging-edge-event-type.md) | ||
|
||
## Validation | ||
|
||
* [Validate in-app messaging using Assurance](./validate-messages.md) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor - can we keep this as just "/public-classes" for the sake of not breaking links?
Not a huge deal if we do want to change the URLs, but it just means a few more redirects need to be created.