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.
      • 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.

        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.

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