identify

open fun identify(@NotNull email: @NotNull String)

Identifies a user for the Beacon, primarily when Beacon is configured for normal mode.

This method allows associating an email address with the current Beacon session.

Parameters

email

A valid email address to identify the user.


open fun identify(@NotNull email: @NotNull String, @Nullable name: String)

Identifies a user with an email and name, primarily when Beacon is configured for normal mode.

This method allows associating an email address and a name with the current Beacon session.

Parameters

email

A valid email address to identify the user.

name

The user's name.


open fun identify(@NotNull email: @NotNull String, @Nullable name: String, @Nullable company: String, @Nullable jobTitle: String, @Nullable avatar: String)

Used to identify users plus adds support for special attributes. For secure mode, use openInSecureMode to pass the signature.

Parameters

email

Required. Valid email address.

name

Optional. Set the customer's name. 80 characters max.

company

[special attribute] Optional. Set the customer's company name. 60 characters max.

jobTitle

[special attribute] Optional. Set the customer's job title. 60 characters max.

avatar

[special attribute] Optional. Set the customer's avatar. It must be a valid URL. 200 characters max.