accountLink.signIn()

Prev Next

accountLink.signIn()

The user has completed the action of signing in. This should be sent when the action actually occurs, not when an automatic sign-in happens.

Signature:

$badger.accountLink().signIn(subscriptionEntitlements);

Parameters:

Parameter Description Type Required?
subscriptionEntitlements An array of objects capturing subscription entitlements to packages of content which the user has subscribed to. The object contains the following fields:
id - identifier string for the entitlement (string, required)
startDate - epoch timestamp (in milliseconds) of when the entitlement goes into effect (date, optional)
endDate - epoch timestamp (in milliseconds) of when the entitlement is no longer valid (date, optional)
array no

Return Values:

None.

Mandatory integration:

If your app offers a signed-in experience, your X1 App must communicate signed-in status via the accountLink.signIn() method.