Package 

Class UpolloClient

  • 
public final class UpolloClient

    Client interface for interacting with Upollo.

    • Method Summary

      Modifier and Type Method Description
      final CompletableFuture<<ERROR CLASS>> ,)>assess(<ERROR CLASS> userinfo, <ERROR CLASS> eventtype) Inform Upollo of an event in your client application, and get back an immediate assessment of the user.
      final CompletableFuture<<ERROR CLASS>> ,)>track(<ERROR CLASS> userinfo, <ERROR CLASS> eventtype) Inform Upollo of an event in your client application, and get back a receipt in the form of an EventToken that can be used with a server API to see the outcome and flags.
      final CompletableFuture<<ERROR CLASS>> checkEmail(String email) A fast check for any known issues with the email.
      final CompletableFuture<<ERROR CLASS>> checkPassword(String password) A fast check for any known issues with the password.
      final CompletableFuture<<ERROR CLASS>> checkPhone(String phone) A fast check for any known issues with the phone number.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UpolloClient

        UpolloClient(Context ctx, String publicApiKey)
        Set up a UpolloClient
        Parameters:
        ctx - within which Upollo should gather information.
        publicApiKey - for your Upollo project.

      • UpolloClient

        UpolloClient(Context ctx, String publicApiKey, Map<String, String> options)
        Set up a UpolloClient with special options.
        Parameters:
        ctx - within which Upollo should gather information.
        publicApiKey - for your Upollo project.
        options - to adjust Upollo's behaviour.

    • Method Detail

      • assess

         final CompletableFuture<<ERROR CLASS>> ,)>assess(<ERROR CLASS> userinfo, <ERROR CLASS> eventtype)

        Inform Upollo of an event in your client application, and get back an immediate assessment of the user.

        If your account is on the 'fee' plan the action will always be OUTCOME_PERMIT and the flags array will be empty. Without upgrading you can use the Upollo dashboard to see the flagging and understand rates of account sharing and multi accounting. Upgrade to see the outcome and flags.

        Parameters:
        userinfo - containing any details known about the current user, or empty if you have none.
        eventtype - which occurred and instigated this request.

      • track

         final CompletableFuture<<ERROR CLASS>> ,)>track(<ERROR CLASS> userinfo, <ERROR CLASS> eventtype)

        Inform Upollo of an event in your client application, and get back a receipt in the form of an EventToken that can be used with a server API to see the outcome and flags.

        If your account is on the 'fee' plan the resolved action will always be OUTCOME_PERMIT and the flags array will be empty. Without upgrading you can use the Upollo dashboard to see the flagging and understand rates of account sharing and multi accounting. Upgrade to see the outcome and flags.

        Parameters:
        userinfo - containing any details known about the current user, or empty if you have none.
        eventtype - which occurred and instigated this request.

      • checkEmail

         final CompletableFuture<<ERROR CLASS>> checkEmail(String email)

        A fast check for any known issues with the email.

        Returns a CheckEmailResponse containing whether the email is valid, the type of issue found (if the email is invalid), the type of email, the email address provider, as well as data on the company the email belongs to (if it is a company email).

        Parameters:
        email - the user's email address.

      • checkPassword

         final CompletableFuture<<ERROR CLASS>> checkPassword(String password)

        A fast check for any known issues with the password.

        The raw password is never shared beyond the Upollo client library; its hash is used instead.

        Parameters:
        password - the user's password.

      • checkPhone

         final CompletableFuture<<ERROR CLASS>> checkPhone(String phone)

        A fast check for any known issues with the phone number.

        Returns any issues found as well as details about the type and carrier.

        Parameters:
        phone - the user's phone number.