Users

The Storyteller SDK requires users to have an externalId set. The externalId should be an identifier which is unique per user and does not change. Therefore, using something like the user's email address is not a good choice for an externalId as the user may change it at some point in the future. However, using a unique UUID/GUID would be a good choice as it is guaranteed to be unique and not change over time.

In order to supply the externalId to the Storyteller SDK call the following method:

    Storyteller.initialize(
      apiKey = "[APIKEY]",
      useInput = UserInput("unique-externalId"),
      onSuccess = {
    // onSuccess action
    },
      onFailure = { error ->
    // onFailure action
    }
  )

This should be called as soon as the value for the externalId is known in your app. For example, this could be on app start or when a user logs in.

Current User Information

You can access the following information about the current user via the following properties:

Storyteller.currentUser       // Returns the current user info
Storyteller.currentApiKey       // Returns the current api key

Changing Users

If you use login in your app and wish to allow users to logout and log back in as a new user (or proceed as an anonymous user) then when a user logs out you should call initialize again specifying a new externalId. Note that this will reset the local store of which pages the user has viewed.

PREVIOUS
Forward Arrow