Email Verification

Email Verification

Retrieve an instance

Retrieves the email verification component instance available on the page.

Fliplet.Verification.Email.get()

// Gets the email verification component instance
Fliplet.Verification.Email.get()
  .then(function(verification) {
    // Use verification instance to perform various actions
  });

The method returns a promise that resolves when the email verification component is rendered.

Instance properties

The verification instance variable above makes available the following instance properties.

  • verification.instance Vue.js instance

Instance methods

The verification instance variable above makes available the following instance methods.

Set the email

Use the setEmail() method to manually set the email value as if the user entered it via the UI:

Fliplet.Verification.Email.get().then(function (verification) {
  // Sets the email to a new value
  verification.setEmail('john@example.org');
});

Request for a code

Use the requestCode() method to manually trigger the component to request for a code. If the user’s email is incorrect or not found in the target data source, the promise will be rejected with an error message:

Fliplet.Verification.Email.get().then(function (verification) {
  // Sets the email
  verification.setEmail('john@example.org');

  // Requests for a code
  verification.requestCode().then(function () {
    // Code has been requested
  }).catch(function (error) {
    // Display error to the user if necessary
  });
});

Hooks

Run code after email/SMS verification

The onUserVerified hook is fired after a user successfully validates their verification code (email or SMS). Use this to run custom logic such as redirecting users, fetching additional data, or setting encryption keys.

Fliplet.Hooks.on('onUserVerified', function (data) {
  // data.entry - the verified user's data source entry
  // data.entry.id - the entry ID
  // data.entry.dataSourceId - the data source ID
  // data.entry.data - all columns (e.g. Email, Name, etc.)

  // Return a Promise to delay post-verification navigation
});

Properties

Property Type Description
data.entry Object The data source entry for the verified user
data.entry.id Number The entry ID
data.entry.dataSourceId Number The ID of the data source
data.entry.data Object All columns/fields from the user’s row

Example: Redirect after verification

Fliplet.Hooks.on('onUserVerified', function (data) {
  return Fliplet.Navigate.screen(123);
});

Example: Set an encryption key after verification

Fliplet.Hooks.on('onUserVerified', function (data) {
  return Fliplet.DataSources.connect(123).then(function (connection) {
    return connection.find({
      where: { ID: data.entry.data.OrganizationID }
    });
  }).then(function (organizations) {
    var key = _.first(organizations).data.key;
    return Fliplet.DataSources.Encryption().setKey(key);
  });
});

Note: This hook is only fired by the Email Verification component (including SMS verification mode) and by the Data Source Login component during its password reset flow. For hooks that fire after a full username + password login, see the Login component hooks.

Back to API documentation