Class ZumoKit


  • public class ZumoKit
    extends java.lang.Object
    Entry point to ZumoKit Android SDK.

    See Getting Started guide for usage details.

    • Constructor Detail

      • ZumoKit

        public ZumoKit​(java.lang.String apiKey,
                       java.lang.String apiUrl,
                       java.lang.String transactionServiceUrl,
                       java.lang.String cardServiceUrl,
                       java.lang.String notificationServiceUrl,
                       java.lang.String exchangeServiceUrl,
                       java.lang.String custodyServiceUrl)
        Initializes ZumoKit SDK. Should only be called once.
        Parameters:
        apiKey - ZumoKit API Key
        apiUrl - ZumoKit API URL
        transactionServiceUrl - ZumoKit Transaction Service URL
        cardServiceUrl - ZumoKit Card Service URL
        notificationServiceUrl - ZumoKit Notification Service URL
        exchangeServiceUrl - ZumoKit Exchange Service URL
        custodyServiceUrl - ZumoKit Custody Service URL
    • Method Detail

      • getVersion

        public static java.lang.String getVersion()
        Get ZumoKit SDK version.
        Returns:
        semantic version tag if exists, commit hash otherwise
      • setLogLevel

        public static void setLogLevel​(java.lang.String logLevel)
        Sets log level for current logger.
        Parameters:
        logLevel - log level, 'trace', 'debug', 'info', 'warning', 'error', 'critical' or 'off'
      • onLog

        public static void onLog​(LogListener logListener,
                                 java.lang.String logLevel)
        Sets log handler for all ZumoKit related logs.
        Parameters:
        logListener - interface to listen to changes
        logLevel - log level, 'trace', 'debug', 'info', 'warning', 'error', 'critical' or 'off'
      • signIn

        public void signIn​(java.lang.String userTokenSet,
                           UserCallback callback)
        Signs in user corresponding to user token set. Sets current user to the newly signed in user. Refer to Server guide for details on how to get user token set.
        Parameters:
        userTokenSet - user token set
        callback - an interface to receive the result or error
        See Also:
        User
      • signOut

        public void signOut()
        Signs out current user.
      • getCurrentUser

        public User getCurrentUser()
        Get currently signed-in user or null.
        Returns:
        current user or null
      • getUtils

        public Utils getUtils()
        Get crypto utils.
        Returns:
        crypto utils
      • getExchangeRate

        public ExchangeRate getExchangeRate​(java.lang.String fromCurrency,
                                            java.lang.String toCurrency)
        Get exchange rate for selected currency pair.
        Parameters:
        fromCurrency - currency code
        toCurrency - currency code
        Returns:
        exchange rate or null
      • getExchangeRates

        public java.util.HashMap<java.lang.String,​java.util.HashMap<java.lang.String,​ExchangeRate>> getExchangeRates()
        Get all available exchange rates.
        Returns:
        mapping between currency pairs and exchange rates
      • getTransactionFeeRate

        public TransactionFeeRate getTransactionFeeRate​(java.lang.String currency)
        Get transaction fee rate for selected crypto currency.
        Parameters:
        currency - currency code
        Returns:
        transaction fee rate or null
      • getTransactionFeeRates

        public java.util.HashMap<java.lang.String,​TransactionFeeRate> getTransactionFeeRates()
        Get all available crypto transaction fee rates.
        Returns:
        mapping between cryptocurrencies and transaction fee rate
      • fetchHistoricalExchangeRates

        public void fetchHistoricalExchangeRates​(HistoricalExchangeRatesCallback callback)
        Fetch historical exchange rates for supported time intervals. On success callback returns historical exchange rates are contained in a mapping between time interval on a top level, from currency on second level, to currency on third level and ExchangeRate objects.
        Parameters:
        callback - an interface to receive the result or error
        See Also:
        TimeInterval
      • addChangeListener

        public void addChangeListener​(ChangeListener listener)
        Listen to changes in current user’s sign in state, exchange rates, exchange settings or transaction fee rates.
        Parameters:
        listener - interface to listen to changes
      • removeChangeListener

        public void removeChangeListener​(ChangeListener listener)
        Remove change listener.
        Parameters:
        listener - interface to listen to changes