signal-api-reference.md

Signal API reference

extensionVersion

The extensionVersion() API returns the version of the Signal extension that is registered with the Mobile Core extension.

To get the version of the Signal extension, use the following code sample:

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

Java

Syntax

public static String extensionVersion();

Example

String signalExtensionVersion = Signal.extensionVersion();

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} Syntax

public static let extensionVersion

Examples

Swift

let version = Signal.extensionVersion

Objective-C

NSString *version = [AEPMobileSignal extensionVersion];

{% endtab %}

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

(nonnull NSString*) extensionVersion;

Examples

Swift

var signalExtensionVersion  = ACPSignal.extensionVersion()

Objective-C

NSString *signalExtensionVersion = [ACPSignal extensionVersion];

{% endtab %}

{% tab title="React Native" %}

JavaScript

ACPSignal.extensionVersion().then(signalExtensionVersion => console.log("AdobeExperienceSDK: ACPSignal version: " + signalExtensionVersion));

{% endtab %}

{% tab title="Flutter" %}

Dart

String signalExtensionVersion = await FlutterACPSignal.extensionVersion;

{% endtab %}

{% tab title="Cordova" %}

Cordova

ACPSignal.extensionVersion(function(version) {  
    console.log("ACPSignal version: " + version);
}, function(error) {  
    console.log(error);  
});

{% endtab %}

{% tab title="Unity" %}

C#

string signalVersion = ACPSignal.ExtensionVersion();

{% endtab %}

{% tab title="Xamarin" %}

C#

string signalVersion = ACPSignal.ExtensionVersion();

{% endtab %} {% endtabs %}

registerExtension

Registers the Signal extension with the Mobile Core.

{% tabs %} {% tab title="Android" %} Syntax

public static void registerExtension()

Example

Signal.registerExtension();

{% endtab %}

{% tab title="iOS (AEP 3.x)" %} This API no longer exists in Signal. Instead, the extension should be registered by calling the registerExtensions API in the MobileCore. Please see the updated SDK initialization steps at the migrate to Swift tutorial. {% endtab %}

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

+ (void) registerExtension;

Example

Swift

ACPSignal.registerExtension()

Objective-C

[ACPSignal registerExtension];

{% endtab %}

{% tab title="React Native" %} When using React Native, register the Signal extension with Mobile Core in native code as shown on the Android and iOS tabs. {% endtab %} {% endtabs %}

CollectPII API

The Signal extension can be used to handle collectPII rules. For more information, see the collectPII API.