Integration on Capping

iOS integration

Mon, 01 Jan 0001 00:00:00 +0000

Latest Version

1.3

Requirements

iOS 14.0+

Installation

To add LMDCapping in a SwiftPM project, add it to your Package.swift:

dependencies: [
 .package(url: "https://github.com/lemonde/capping-spm.git", from: "1.3.0")
]

And then add the following product to any target that needs access to the library:

targets: [
 .target(name: "MyTarget", dependencies: ["LMDCapping"])
]

Usage

Getting started

import LMDCapping

Create a CappingService object with the two required parameters:

baseURL: the base URL that will be used for the capping operations requests.
apiKey: the api key that will be used for the capping operations requests.

You can pass an optional configuration parameter to tweak some settings of the CappingService.

Javascript integration

Mon, 01 Jan 0001 00:00:00 +0000

Add following lines into your html, just before the closing body tag. This JavaScript SDK integration launch tracking of simultaneous readings, without any blocking.

<script>
 var siriusCapping = window.siriusCapping || {};
 siriusCapping.config = {
 brand: "<BRAND_UUID>", //mandatory
 userId: "<THE_USER_ID>", //mandatory
 };
</script>
<script async src="https://capping.sirius.press/sdk.v1.1.0.js"></script>

Param	Type	Description
`siriusCapping.config.brand`	`string`	A brand uuid that we’ll give you
`siriusCapping.config.userId`	`string`	The ID of the user, that you can write encrypted or hashed

Note

Declaring siriusCapping.config.brand and siriusCapping.config.userId will automatically launch simultaneous readings tracking. If you don’t want to launch Capping, do not define these variables and/or do not insert the JavaScript SDK.

Kotlin integration

Mon, 01 Jan 0001 00:00:00 +0000

Latest Version

1.2

Versions listed in https://central.sonatype.com/artifact/fr.lemonde/capping/versions

Requirements

minSdkVersion 26

Setup

Add to your build.gradle file

implementation "fr.lemonde:capping:1.2"

Initiate SDK

Capping.getInstance(applicationContext).initialize([BASE_URL], [YOUR_API_KEY])

If you want to configure the sdk you can also add a CappingSDKConfiguration object

Capping.getInstance(applicationContext).initialize([BASE_URL], [YOUR_API_KEY], configuration)

User

To identify an user you will need to set an unique identifier with setUserId(id: String).

Use the SDK

You can access the CappingSDK with Capping.getInstance(context).

The component responsible for displaying the capping UI should use