Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
calebk1 committed Dec 1, 2021
1 parent 4f30aa2 commit 4cdc34e
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 12 deletions.
4 changes: 2 additions & 2 deletions using-mobile-extensions/adobe-campaignclassic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
![Configuring the Campaign Classic extension](../../.gitbook/assets/acc-configure-extension.png)

{% hint style="info" %}
You can retrieve your Campaign Classic registration or tracking endpoint URLS in the Campaign Classic interface under the **Tools > Advanced > Deployment wizard** menu. The endpoint for push notifications is usually the same as the URL that is used for web forms and surveys.
You can retrieve your Campaign Classic registration or tracking endpoint URLs in the Campaign Classic interface under the **Tools > Advanced > Deployment wizard** menu. The endpoint for push notifications is usually the same as the URL that is used for web forms and surveys.
{% endhint %}

#### Registration endpoints
Expand Down Expand Up @@ -44,7 +44,7 @@ You can specify up to three unique Android integration keys for your development

#### Request timeout

The response timeout is the amount of time, in seconds, to wait for a response from the registration or tracking endpoint before timing out. The SDK default timeout value is 30 seconds.
The request timeout is the amount of time, in seconds, to wait for a response from the registration or tracking endpoint before timing out. The SDK default timeout value is 30 seconds.

## Add Campaign Classic to your app

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@ String campaignClassicExtensionVersion = CampaignClassic.extensionVersion();
```
{% endtab %}

{% tab title="iOS" %}
{% tab title="iOS (ACP 2.x)" %}
### Swift

**Syntax**

```swift
func extensionVersion()
```

**Example**

```swift
Expand All @@ -40,11 +46,13 @@ The `registerDevice` API lets you register a user device with Campaign Classic.

{% tabs %}
{% tab title="Android" %}
### Java

{% hint style="info" %}
To prepare your app to handle push notifications, see the tutorial on [setting up a Firebase Cloud Messaging client app on Android](https://firebase.google.com/docs/cloud-messaging/android/client). After you receive the Firebase Cloud Messaging (FCM) SDK registration token, send this token and the device information to Campaign Classic by using the `registerDevice` API.

The `registerDevice` API registers a device with your Campaign Classic registration server. It takes the FCM registration token as a parameter with a user key that identifies a user, such as an email address or a login name. You can also provide a map of the custom key-value pairs that you want to associate with the registration. A boolean value is returned in the callback, which signals whether the registration was successful.
{% endhint %}

### Java

**Syntax**

Expand Down Expand Up @@ -81,15 +89,21 @@ public void onNewToken(String token) {
```
{% endtab %}

{% tab title="iOS" %}
{% hint style="info"}
{% tab title="iOS (ACP 2.x)" %}
{% hint style="info" %}
To get your app ready to handle push notifications, see the tutorial on [configuring remote notification support](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/HandlingRemoteNotifications.html#//apple_ref/doc/uid/TP40008194-CH6-SW1). After you receive the Apple Push Notification service (APNs) token, send this token and the device information to Campaign Classic using the `registerDevice` API.

The `registerDevice` API registers a device with your Campaign Classic registration server. It takes the APNS token as a parameter with a user key that identifies a user, such as an email address or a login name. You can also provide a map of the custom key-value pairs that you want to associate with the registration. A boolean value is returned in the callback, which signals whether the registration was successful.
{% endhint %}

### Swift

**Syntax**

```swift
func registerDevice(deviceToken: Token, userKey: String, additionalParams: @escaping (Bool) -> Void)
```

**Example**

```swift
Expand Down Expand Up @@ -130,7 +144,7 @@ The `trackNotificationReceive` API sends the received push notification's tracki
{% tab title="Android" %}
### Java

If `trackInfo` is null or does not contain the necessary tracking identifiers, `messageId` (`_mId`) and `deliveryId` (`_dId`), no track request is sent.
If `trackInfo` is null or does not contain the necessary tracking identifiers, `messageId` (`_mId`) and `deliveryId` (`_dId`), a track request is **not** sent.

**Syntax**

Expand Down Expand Up @@ -161,14 +175,20 @@ public class MyFirebaseMessagingService extends FirebaseMessagingService {
```
{% endtab %}

{% tab title="iOS" %}
{% tab title="iOS (ACP 2.x)" %}

{% hint style="info" %}
Please note that you can pass the `launchOptions` that were received before opening the application or `userInfo` , which contains the received push payload in `trackInfo`. If `trackInfo` is null or does not contain the necessary tracking identifiers, `broadlogId` (`_mId`) and `deliveryId` (`_dId`), no track request is sent.
You can pass the `launchOptions` that were received upon opening the application or `userInfo` , which contains the received push payload in `trackInfo`. If `trackInfo` is null or does not contain the necessary tracking identifiers, `broadlogId` (`_mId`) and `deliveryId` (`_dId`), a track request is **not** sent.
{% endhint %}

### Swift

**Syntax**

```swift
func trackNotificationReceive(trackInfo: [String: String])
```

**Example**

```swift
Expand Down Expand Up @@ -248,13 +268,19 @@ public void onResume() {
```
{% endtab %}

{% tab title="iOS" %}
{% tab title="iOS (ACP 2.x)" %}
{% hint style="info"}
You can pass the `launchOptions` that was received before opening the application or `userInfo`, which contains the received push payload in `trackInfo`. If `trackInfo` is null or does not contain the necessary tracking identifiers, `broadlogId` (`_mId`) and `deliveryId` (`_dId`), a track request is **not** sent.
You can pass the `launchOptions` that was received upon opening the application or `userInfo`, which contains the received push payload in `trackInfo`. If `trackInfo` is null or does not contain the necessary tracking identifiers, `broadlogId` (`_mId`) and `deliveryId` (`_dId`), a track request is **not** sent.
{% endhint %}

### Swift

**Syntax**

```swift
func trackNotificationClick(trackInfo: [String: String])
```

**Example**

```swift
Expand Down

0 comments on commit 4cdc34e

Please sign in to comment.